Call Connection - Get Participants

サービス:

Communication

API バージョン:

2024-09-15

通話から参加者を取得します。 この一覧では、記録ボットと文字起こしボットは省略されています。

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?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 ユーザー アクセス トークン。

応答

名前	型	説明
200 OK	GetParticipantsResponse	参加者の取得応答を返します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

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

型: apiKey
/: header

例

CallConnection_GetParticipants

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "identifier": {
        "kind": "communicationUser",
        "communicationUser": {
          "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
        }
      },
      "isMuted": true
    }
  ],
  "nextLink": "string"
}

定義

名前	説明
CallParticipant	通話参加者。
GetParticipantsResponse	通話の参加者を取得するための応答ペイロード。

CallParticipant

通話参加者。

名前	型	説明
identifier	CommunicationIdentifierModel
isMuted	boolean	参加者がミュートされている
isOnHold	boolean	参加者が保留になっています。

GetParticipantsResponse

通話の参加者を取得するための応答ペイロード。

名前	型	説明
nextLink	string	参加者の一覧の続行
value	CallParticipant[]	通話中の現在の参加者の一覧。