反馈 编辑

participant： mute

  • 项目

命名空间：microsoft.graph

重要

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

将呼叫中的特定参与者静音。

这是服务器静音，这意味着服务器将删除此参与者的所有音频数据包，即使参与者继续流式传输音频。

若要详细了解如何处理静音操作，请参阅 muteParticipantOperation。

注意： 此方法仅支持组调用。

权限

权限类型 权限（从最低特权到最高特权）
委派（工作或学校帐户） 不支持
委派（个人 Microsoft 帐户） 不支持
Application Calls.JoinGroupCallsasGuest.All 或 Calls.JoinGroupCalls.All

HTTP 请求

POST /app/calls/{id}/participants/{id}/mute
POST /communications/calls/{id}/participants/{id}/mute

注意：/app 路径已弃用。 今后将使用 /communications 路径。

请求标头

名称 说明
Authorization Bearer {token}。必需。
Content-type application/json. Required.

请求正文

在请求正文中，提供具有以下参数的 JSON 对象。

参数 类型 说明
clientContext String 唯一的客户端上下文字符串。 最大限制为 256 个字符。

响应

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

注意： 当此 API 返回成功响应时，所有参与者都将收到名单更新。

示例 - 将特定参与者设为静音

以下示例演示如何调用此 API。

请求

下面为请求示例。

POST https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/participants/2765eb15-01f8-47c6-b12b-c32111a4a86f/mute
Content-Type: application/json

{
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}
响应

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

HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/17e3b46c-f61d-4f4d-9635-c626ef18e6ad
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.muteParticipantOperation",
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#muteParticipantOperation",
  "id": "17e3b46c-f61d-4f4d-9635-c626ef18e6ad",
  "status": "completed",
  "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}
通知 - 参与者静音更新名单
POST https://bot.contoso.com/api/calls
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.commsNotifications",
  "value": [
    {
      "@odata.type": "#microsoft.graph.commsNotification",
      "changeType": "updated",
      "resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/participants",
      "resourceData": [
        {
          "@odata.type": "#microsoft.graph.participant",
          "id": "2765eb15-01f8-47c6-b12b-c32111a4a86f",
          "info": {
            "identity": {
              "user": {
                "displayName": "Bob",
                "id": "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96"
              }
            },
            "region": "westus",
            "languageId": "en-US"
          },
          "mediaStreams": [
            {
              "mediaType": "audio",
              "label": "main-audio",
              "sourceId": "1",
              "direction": "sendReceive"
            }
          ],
          "isMuted": true, // will be set to true on mute
          "isInLobby": false
        }
      ]
    }
  ]
}