Call Connection - Mute

サービス:

Communication

API バージョン:

2024-09-15

識別子を使用して通話の参加者をミュートします。

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

URI パラメーター

名前	/	必須	型	説明
callConnectionId	path	True	string	呼び出し接続 ID。
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザー アクセス トークン。
Repeatability-Request-ID		string uuid	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability -Request-Id で要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-Id の値は、クライアントによって生成された要求の一意識別子を表す不透明な文字列です。 これはバージョン 4 (ランダム) UUID です。
Repeatability-First-Sent		string date-time-rfc1123	Repeatability-Request-ID ヘッダーを指定する場合は、Repeatability-First-Sent ヘッダーも指定する必要があります。 値は、要求が最初に作成された日時で、HTTP 日付の IMF-fixdate 形式を使用して表されます。 例: Sun, 06 Nov 1994 08:49:37 GMT.

要求本文

名前	必須	型	説明
targetParticipants	True	CommunicationIdentifierModel[]	通話からミュートされる参加者。 ACS ユーザーのみがサポートされています。
operationContext		string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。

応答

名前	型	説明
200 OK	MuteParticipantsResult	参加者のミュート応答を返します
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

Azure Communication Services ユーザー アクセス トークン。

型: apiKey
/: header

例

CallConnection_Mute

要求のサンプル

HTTP

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"
}

定義

名前	説明
MuteParticipantsRequest	呼び出しから参加者をミュートするための要求ペイロード。
MuteParticipantsResult	呼び出しから参加者をミュートするための結果ペイロード。

MuteParticipantsRequest

呼び出しから参加者をミュートするための要求ペイロード。

名前	型	説明
operationContext	string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
targetParticipants	CommunicationIdentifierModel[]	通話からミュートされる参加者。 ACS ユーザーのみがサポートされています。

MuteParticipantsResult

呼び出しから参加者をミュートするための結果ペイロード。

名前	型	説明
operationContext	string	クライアントによって提供される操作コンテキスト。