聊天： getAllMessages

  • 项目

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

从用户参与的所有 聊天 中获取所有消息，包括一对一聊天、群聊天和会议聊天。

注意：这是支持 和 model=B 付款模型的按流量计费的 model=A API。 有关详细信息，请参阅 付款模型。 如果未在查询中指定付款模型，将使用默认 评估模式 。

根据你选择的支付模式，可能还需要许可证。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） 不支持。 不支持。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 Chat.Read.All Chat.ReadWrite.All

HTTP 请求

GET /users/{id | user-principal-name}/chats/getAllMessages

可选的查询参数

根据首选的 许可和付款模型，可以使用支持值 A 和 B 的 model 查询参数，如以下示例所示。

GET /users/{id | user-principal-name}/chats/getAllMessages?model=A
GET /users/{id | user-principal-name}/chats/getAllMessages?model=B

如果未指定 model 参数，将使用 评估模式。

此方法还支持 日期范围参数 来自定义响应，如以下示例所示。

GET /users/{id}/chats/getAllMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z

此方法还支持 $filter。 下表列出了示例。

应用场景 $filter 参数 可能的值
获取用户标识类型发送的消息 $filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' aadUser， onPremiseAadUser， anonymousGuest， federatedUser， personalMicrosoftAccountUser， skypeUser， phoneUser
获取按应用程序类型发送的消息 $filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' aadApplication， 机器人， tenantBot， office365Connector， outgoingWebhook
获取用户 ID 发送的消息 $filter=from/user/id eq '{oid}'
获取控制 (系统事件) 消息 $filter=messageType eq 'systemEventMessage'
排除控件 (系统事件) 消息 $filter=messageType ne 'systemEventMessage'

注意： 可以使用 运算符联接 or 这些筛选器子句。 筛选器子句可以在查询中多次出现，并且每次在查询中出现时，它都可以根据不同的值进行筛选。

请求标头

标头 值
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。

响应

如果成功，此方法将在正文中返回 200 OK 响应代码和chatMessages 的列表。

示例

请求

GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json

{
   "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)",
   "@odata.count":10,
   "@odata.nextLink":"https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages?$skip=10",
   "value":[
      {
         "@odata.type":"#microsoft.graph.chatMessage",
         "id":"1600457965467",
         "replyToId":null,
         "etag":"1600457965467",
         "messageType":"message",
         "createdDateTime":"2020-09-18T19:39:25.467Z",
         "lastModifiedDateTime":"2020-09-18T19:39:25.467Z",
         "lastEditedDateTime":null,
         "deletedDateTime":null,
         "subject":null,
         "summary":null,
         "chatId":"19:0de69e5e-2da8-4cf2-821f-5e6585b2c65b_5c64e248-3269-4268-a36e-0f80314e9c39@unq.gbl.spaces",
         "importance":"normal",
         "locale":"en-us",
         "webUrl":null,
         "channelIdentity":null,
         "policyViolation":null,
         "eventDetail": null,
         "from":{
            "application":null,
            "device":null,
            "conversation":null,
            "user":{
               "id":"0de69e5e-2da8-4cf2-821f-5e6585b2c65b",
               "displayName":"Richard Wilson",
               "userIdentityType":"aadUser"
            }
         },
         "body":{
            "contentType":"html",
            "content":"<div>\n<blockquote itemscope=\"\" itemtype=\"http://schema.skype.com/Reply\" itemid=\"1600457867820\">\n<strong itemprop=\"mri\" itemid=\"8:orgid:0de69e5e-2da8-4cf2-821f-5e6585b2c65b\">Richard Wilson</strong><span itemprop=\"time\" itemid=\"1600457867820\"></span>\n<p itemprop=\"preview\">1237</p>\n</blockquote>\n<p>this is a reply</p>\n</div>"
         },
         "attachments":[

         ],
         "mentions":[

         ],
         "reactions":[

         ]
      }
   ]
}

相关内容

Microsoft Graph 特定于服务的节流限制