命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取在群组聊天和频道中发送给特定用户的所有 目标消息 。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派(工作或学校帐户) | 不支持。 | 不支持。 |
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
| 应用程序 | TeamworkTargetedMessage.Read.All | 不可用。 |
HTTP 请求
GET /users/{user-id | userPrincipalName}/teamwork/getAllTargetedMessages
可选的查询参数
此方法支持以下 OData 查询参数来帮助自定义响应。 若要了解一般信息,请参阅 OData 查询参数。
| 名称 | 说明 |
|---|---|
| $filter | $filter查询参数支持使用日期范围参数对 lastModifiedDateTime 属性进行日期和时间范围查询。 |
| $top | 使用 $top 查询参数控制每个响应的项目数。 |
支持的$filter运算符
支持以下筛选器表达式:
-
lastModifiedDateTime gt {datetime}- 返回在指定日期和时间之后修改的消息。 -
lastModifiedDateTime lt {datetime}- 返回在指定日期和时间之前修改的消息。 -
from/application/id eq '{id}'- 返回由特定应用程序 ID 发送的消息。
可以使用 运算符组合多个筛选器表达式 and 。 例如:
GET /users/{user-id | userPrincipalName}/teamwork/getAllTargetedMessages?$filter=lastModifiedDateTime gt 2024-01-01T00:00:00Z and lastModifiedDateTime lt 2024-12-31T23:59:59Z
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此函数在响应正文中返回响应 200 OK 代码和 targetedChatMessage 对象的集合。
响应包括用于分页的 @odata.nextLink 属性和用于增量跟踪的 @odata.deltaLink 属性(如果适用)。
示例
示例 1:获取用户的所有目标消息
以下示例演示如何检索用户的所有目标消息。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages
响应
以下示例演示包含聊天和频道上下文目标消息的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(targetedChatMessage)",
"@odata.count": 2,
"@odata.nextLink": "https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages?$top=2&$skiptoken=U2tpcFZhbHVlPTIjTWFpbGJveEZvbGRlcj1NYWlsRm9sZGVycy9UZWFtc01lc3NhZ2VzRGF0YQ",
"value": [
{
"id": "1580849738240",
"@odata.type": "#microsoft.graph.targetedChatMessage",
"replyToId": null,
"etag": "1580849738240",
"chatId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
"channelIdentity": null,
"messageType": "message",
"createdDateTime": "2020-02-04T20:55:38.24Z",
"lastModifiedDateTime": null,
"deletedDateTime": null,
"subject": null,
"summary": null,
"importance": "normal",
"locale": "en-us",
"webUrl": null,
"policyViolation": null,
"from": {
"device": null,
"user": null,
"application": {
"@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
"id": "6d23e712-527b-406f-8d59-d02927885918",
"displayName": "Breakthru",
"applicationIdentityType": "bot"
}
},
"body": {
"contentType": "text",
"content": "hello"
},
"attachments": [],
"mentions": [],
"reactions": [],
"recipient": {
"@odata.type": "#microsoft.graph.identity",
"id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
"displayName": "Adele Vance"
}
},
{
"id": "1580849738241",
"@odata.type": "#microsoft.graph.targetedChatMessage",
"replyToId": null,
"etag": "1580849738241",
"chatId": null,
"channelIdentity": {
"channelId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
"teamId": "3Aeeaa4e946d674c4f8d4dded613780f45@thread.v2"
},
"messageType": "message",
"createdDateTime": "2020-02-04T20:55:38.24Z",
"lastModifiedDateTime": null,
"deletedDateTime": null,
"subject": null,
"summary": null,
"importance": "normal",
"locale": "en-us",
"webUrl": null,
"policyViolation": null,
"from": {
"device": null,
"user": null,
"application": {
"@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
"id": "6d23e712-527b-406f-8d59-d02927885918",
"displayName": "Breakthru",
"applicationIdentityType": "bot"
}
},
"body": {
"contentType": "text",
"content": "hello"
},
"attachments": [],
"mentions": [],
"reactions": [],
"recipient": {
"@odata.type": "#microsoft.graph.identity",
"id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
"displayName": "Adele Vance"
}
}
]
}
示例 2:按日期范围筛选目标邮件
以下示例演示如何检索特定日期范围内的目标消息。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages?$filter=lastModifiedDateTime gt 2024-01-01T00:00:00Z and lastModifiedDateTime lt 2024-12-31T23:59:59Z
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(targetedChatMessage)",
"@odata.count": 1,
"value": [
{
"id": "1704067200000",
"@odata.type": "#microsoft.graph.targetedChatMessage",
"replyToId": null,
"etag": "1704067200000",
"chatId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
"channelIdentity": null,
"messageType": "message",
"createdDateTime": "2024-01-01T00:00:00Z",
"lastModifiedDateTime": "2024-01-01T00:00:00Z",
"deletedDateTime": null,
"subject": null,
"summary": null,
"importance": "normal",
"locale": "en-us",
"webUrl": null,
"policyViolation": null,
"from": {
"device": null,
"user": null,
"application": {
"@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
"id": "6d23e712-527b-406f-8d59-d02927885918",
"displayName": "Breakthru",
"applicationIdentityType": "bot"
}
},
"body": {
"contentType": "text",
"content": "Filtered message content"
},
"attachments": [],
"mentions": [],
"reactions": [],
"recipient": {
"@odata.type": "#microsoft.graph.identity",
"id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
"displayName": "Adele Vance"
}
}
]
}