获取频道

命名空间:microsoft.graph

检索频道的属性和关系。

此方法支持联合。 只有属于共享通道的用户才能检索频道信息。

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

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

权限

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

此 API 支持管理员权限。 全局管理员和 Microsoft Teams 服务管理员可以访问他们不是成员的团队。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Channel.ReadBasic.All ChannelSettings.ReadWrite.All、ChannelSettings.Read.All、Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 ChannelSettings.Read.Group ChannelSettings.ReadWrite.Group、Channel.ReadBasic.All、ChannelSettings.Read.All、ChannelSettings.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All

注意

  • ChannelSettings.Read.Group 和 ChannelSettings.ReadWrite.Group 权限使用 特定于资源的许可
  • 仅支持向后兼容性的 Group.Read.All、Group.ReadWrite.All、Directory.Read.All 和 Directory.ReadWrite.All 权限。 建议更新解决方案,以使用上表中列出的替代权限,并避免今后使用这些权限。

HTTP 请求

GET /teams/{team-id}/channels/{channel-id}

可选的查询参数

此方法支持使用 $filter$selectOData 查询参数,以帮助自定义响应。

使用 $select 提高性能

为频道填充 电子邮件摘要 属性是一项成本高昂的操作,会导致性能降低。 使用 $select 排除 电子邮件摘要 属性以提高性能。

注意:只能通过 参数检索 select summary 属性,如本主题中的示例 2 所示。

请求标头

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

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 channel 对象。

示例

示例 1:获取通道

请求

以下示例显示了一个请求。

GET https://graph.microsoft.com/v1.0/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2

响应

以下示例显示了相应的响应。

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

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

{
    "id": "19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2",
    "createdDateTime": "2020-05-27T19:22:25.692Z",
    "displayName": "General",
    "description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9",
    "membershipType": "standard"
}

示例 2:获取 channelSummary 属性

请求

以下示例显示了获取 channelSummary 属性的请求。

GET https://graph.microsoft.com/v1.0/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2?$select=summary

响应

以下示例显示了相应的响应。

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('8bb12236-b929-42e0-94a0-1c417466ebf8')/channels(summary)/$entity",
    "summary":{
        "ownersCount":2,
        "membersCount":3,
        "guestsCount":1,
        "hasMembersFromOtherTenants":false
    }
}

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