Call Connection - Get Participants

Service:

Communication

API Version:

2023-10-15

從通話取得參與者。

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2023-10-15

URI 參數

名稱	位於	必要	類型	Description
callConnectionId	path	True	string	呼叫連線標識碼
endpoint	path	True	string url	Azure 通訊資源的端點。
api-version	query	True	string	要叫用的 API 版本。

要求標頭

名稱	必要	類型	Description
Authorization	True	string	Azure 通訊服務 用戶存取令牌。

回應

名稱	類型	Description
200 OK	GetParticipantsResponse	傳回取得參與者回應。
Other Status Codes	CommunicationErrorResponse	錯誤

安全性

Authorization

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

Type: apiKey
In: header

範例

CallConnection_GetParticipants

Sample Request

HTTP

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

Sample Response

Status code:

200

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

定義

名稱	Description
CallParticipant	通話參與者。
GetParticipantsResponse	取得通話參與者的響應承載。

CallParticipant

通話參與者。

名稱	類型	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	參與者已靜音

GetParticipantsResponse

取得通話參與者的響應承載。

名稱	類型	Description
nextLink	string	繼續參與者清單
value	CallParticipant[]	通話中目前參與者的清單。