命名空间：microsoft.graph
要了解有关如何使用 Microsoft Teams 导出 API 来导出内容的详细信息，请参阅 使用 Microsoft Teams 导出 API 导出内容。
注意
此 API 需要配置 Teams 保留策略 。 有关详细信息，请参阅 了解 Microsoft Teams 的保留。
注意
Teams 已将专用频道邮件存储从单个用户邮箱迁移到存储标准频道邮件的组邮箱。 对于专用频道，此 API 支持在租户的存储迁移完成后编辑或删除的消息的保留消息历史记录，前提是适用的保留策略捕获了版本。 迁移前发生的编辑或删除不会返回，因为在旧版用户邮箱存储期间此 API 无法提供保留历史记录支持。
租户管理员可以运行 Get-TenantPrivateChannelMigrationStatus 来验证并MigrationStatusCompleted识别租户的 MigrationCompletionTimeStamp. 如果不是 Completed，MigrationCompletionTimeStamp则MigrationStatus不可用，不能用作租户范围的截止点。 有关存储更改的详细信息，请参阅 2025 年迁移私有频道消息。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 |
|---|---|---|
| 委派（工作或学校帐户） | 不支持。 | 不支持。 |
| 委派（个人 Microsoft 帐户） | 不支持。 | 不支持。 |
| 应用程序 | ChannelMessage.Read.All | 不可用。 |
HTTP 请求
GET /teams/{teamsId}/channels/getAllRetainedMessages
可选的查询参数
此方法支持以下 OData 查询参数，以帮助自定义响应。 若要了解一般信息，请参阅 OData 查询参数。
| 名称 | 说明 |
|---|---|
| $filter | $filter 查询参数支持对 lastModifiedDateTime 属性进行日期和时间范围查询。 |
| $top | 使用 $top 查询参数控制每个响应的项目数。 |
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功，此函数将在响应正文中返回 200 OK 响应代码和 chatMessage 对象集合。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/v1.0/teams/8b081ef6-4792-4def-b2c9-c363a1bf41d5/channels/getAllRetainedMessages
响应
以下示例显示了相应的响应。
注意：为了提高可读性，可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(chatMessage)",
"@odata.count": 2,
"@odata.nextLink": "https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/getAllRetainedMessages?$skip=2",
"value": [
{
"@odata.type": "#microsoft.graph.chatMessage",
"id": "1616990417393",
"replyToId": null,
"etag": "1616990417393",
"messageType": "message",
"createdDateTime": "2021-03-29T04:00:17.393Z",
"lastModifiedDateTime": "2021-03-29T04:00:17.393Z",
"lastEditedDateTime": null,
"deletedDateTime": null,
"subject": null,
"summary": null,
"chatId": null,
"importance": "normal",
"locale": "en-us",
"webUrl": "https://teams.microsoft.com/l/message/19%3Ad5d2708d408c41d98424c1c354c19db3%40thread.tacv2/1616990417393?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1616990417393&parentMessageId=1616990417393",
"policyViolation": null,
"eventDetail": null,
"from": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2",
"displayName": "Robin Kline",
"userIdentityType": "aadUser"
}
},
"body": {
"contentType": "text",
"content": "Test message"
},
"channelIdentity": {
"teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b",
"channelId": "19:d5d2708d408c41d98424c1c354c19db3@thread.tacv2"
},
"attachments": [],
"mentions": [],
"reactions": []
},
{
"@odata.type": "#microsoft.graph.chatMessage",
"id": "1616990171266",
"replyToId": "1616990032035",
"etag": "1616990171266",
"messageType": "message",
"createdDateTime": "2021-03-29T03:56:11.266Z",
"lastModifiedDateTime": "2021-03-29T03:56:11.266Z",
"lastEditedDateTime": null,
"deletedDateTime": null,
"subject": null,
"summary": null,
"chatId": null,
"importance": "normal",
"locale": "en-us",
"webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1616990171266?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1616990171266&parentMessageId=1616990032035",
"policyViolation": null,
"eventDetail": null,
"from": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2",
"displayName": "Robin Kline",
"userIdentityType": "aadUser"
}
},
"body": {
"contentType": "text",
"content": "Hello World"
},
"channelIdentity": {
"teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b",
"channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"
},
"attachments": [],
"mentions": [],
"reactions": []
}
]
}