通过

列出频道

  • 项目

命名空间：microsoft.graph

重要

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

检索此团队中的频道列表。

注意： 来宾用户在此 API 的响应中看不到他们不是其成员的专用或共享频道。

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

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

权限

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

此 API 支持管理员权限。 具有全局管理员或Microsoft Teams 服务管理员角色的用户可以访问他们不是其成员的团队。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） Channel.ReadBasic.All ChannelSettings.Read.All、ChannelSettings.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All、Group.Read.All、Group.ReadWrite.All
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 ChannelSettings.Read.Group Channel.ReadBasic.All、ChannelSettings.Read.All、ChannelSettings.ReadWrite.All、ChannelSettings.ReadWrite.Group、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

可选的查询参数

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

使用 $select 提高性能

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

注意：默认情况下，此 API 不返回通道的 moderationSettings 属性。 若要获取此属性，请使用 $select 查询参数。

请求标头

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

请求正文

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

响应

如果成功，此方法在响应正文中返回 200 OK 响应代码和 Channel 对象集合。

示例

示例 1：列出所有频道

请求

以下示例显示列出所有频道的请求。

GET https://graph.microsoft.com/beta/teams/893075dd-2487-4122-925f-022c42e20265/channels

响应

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

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

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

{
  "value": [
    {
      "id": "19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2",
      "createdDateTime": "2020-05-27T19:22:25.692Z",
      "displayName": "General",
      "description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9",
      "membershipType": "standard",
      "email": "someperson@microsoft.com",
      "moderationSettings": null,
      "isArchived": false
    }
  ]
}

示例 2：列出所有私人频道

请求

以下示例显示列出所有私人频道的请求。

GET https://graph.microsoft.com/beta/teams/64c323f2-226a-4e64-8ba4-3e6e3f7b9330/channels?$filter=membershipType eq 'private'

响应

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

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

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

{
  "value": [
    {
      "id": "19:982abbfca323a582f0a6d00ae2deca@thread.tacv2",
      "createdDateTime": "2020-05-27T19:22:25.692Z",
      "displayName": "General",
      "description": "test private team",
      "membershipType": "private",
      "isArchived": false,
    }
  ]
}

示例 3: 列出所有共享频道

请求

以下示例显示了列出所有共享频道的请求。

GET https://graph.microsoft.com/beta/teams/6a720ba5-7373-463b-bc9f-4cd04b5c6742/channels?$filter=membershipType eq 'shared'

响应

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

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#teams('6a720ba5-7373-463b-bc9f-4cd04b5c6742')/channels",
    "@odata.count": 1,
    "value": [
        {
            "id": "19:LpxShHZZh9utjNcEmUS5aOEP9ASw85OUn05NcWYAhX81@thread.tacv2",
            "createdDateTime": null,
            "displayName": "shared channel-01",
            "description": "this is the shared channel description",
            "isFavoriteByDefault": null,
            "webUrl": "https://teams.microsoft.com/l/channel/19%3ALpxShHZZh9utjNcEmUS5aOEP9ASw85OUn05NcWYAhX81%40thread.tacv2/shared%20channel-01?groupId=6a720ba5-7373-463b-bc9f-4cd04b5c6742&tenantId=df81db53-c7e2-418a-8803-0e68d4b88607",
            "membershipType": "shared",
            "email": "someperson@microsoft.com",
            "isArchived": false,
            "moderationSettings": null
        }
    ]
}

相关内容

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