共用方式為

Call Connection - Mute

  • 參考
服務:
Communication
API 版本:
2024-09-15

使用標識符將參與者從通話中靜音。

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?api-version=2024-09-15

URI 參數

名稱 位於 必要 類型 Description
callConnectionId
 path True

string

呼叫連線標識碼。
endpoint
 path True

string

url

Azure 通訊資源的端點。
api-version
 query True

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

Azure 通訊服務用戶存取令牌。
Repeatability-Request-ID

string

uuid

如果指定，用戶端會指示要求可重複;也就是說，用戶端可以使用相同的可重複性-Request-Id 多次提出要求，並取得適當的回應，而不需要伺服器多次執行要求。 Repeatability-Request-Id 的值是不透明的字元串，代表要求客戶端產生的唯一標識符。 它是第 4 版 （隨機） UUID。
Repeatability-First-Sent

string

date-time-rfc1123

如果指定 Repeatability-Request-ID 標頭，則也必須指定 Repeatability-First-Sent 標頭。 此值應該是第一次建立要求的日期和時間，以IMF修正的 HTTP 日期形式表示。 範例：Sun， 1994 年 11 月 6 日 08：49：37 GMT。

要求本文

名稱 必要 類型 Description
targetParticipants True

CommunicationIdentifierModel[]

要從通話中靜音的參與者。 僅支援 ACS 使用者。
operationContext

string

客戶在呼叫中呼叫動作時使用，以將要求與回應事件相互關聯。

回應

名稱 類型 Description
200 OK

MuteParticipantsResult

傳回靜音參與者回應
Other Status Codes

CommunicationErrorResponse

錯誤

安全性

Authorization

Azure 通訊服務用戶存取令牌。

類型: apiKey
位於: header

範例

CallConnection_Mute

範例要求

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:mute?api-version=2024-09-15

{
  "targetParticipants": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    }
  ],
  "operationContext": "mute participant"
}

範例回覆

狀態碼:
200 
{
  "operationContext": "mute participant"
}

定義

名稱 Description
MuteParticipantsRequest

將參與者從通話中靜音的要求承載。
MuteParticipantsResult

將參與者從通話中靜音的結果承載。

MuteParticipantsRequest

將參與者從通話中靜音的要求承載。

名稱 類型 Description
operationContext

string

客戶在呼叫中呼叫動作時使用，以將要求與回應事件相互關聯。
targetParticipants

CommunicationIdentifierModel[]

要從通話中靜音的參與者。 僅支援 ACS 使用者。

MuteParticipantsResult

將參與者從通話中靜音的結果承載。

名稱 類型 Description
operationContext

string

用戶端所提供的作業內容。