Call Connection - Get Participants

服务:

Communication

API 版本:

2025-05-15

从通话中获取参与者。 从此列表中省略录制和听录机器人。

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2025-05-15

URI 参数

名称	在	必需	类型	说明
callConnectionId	path	True	string	呼叫连接 ID
endpoint	path	True	string (url)	Azure 通信资源的终结点。
api-version	query	True	string	要调用的 API 版本。

请求头

名称	必需	类型	说明
Authorization	True	string	Azure 通信服务用户访问令牌。

响应

名称	类型	说明
200 OK	GetParticipantsResponse	返回获取参与者响应。
Other Status Codes	CommunicationErrorResponse	错误

安全性

Authorization

Azure 通信服务用户访问令牌。

类型: apiKey
在: header

示例

CallConnection_GetParticipants

示例请求

HTTP

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants?api-version=2025-05-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

Object

呼叫参与者。

名称	类型	说明
identifier	CommunicationIdentifierModel
isMuted	boolean	参与者静音
isOnHold	boolean	是被保留的参与者。

GetParticipantsResponse

Object

用于获取呼叫参与者的响应有效负载。

名称	类型	说明
nextLink	string	继续列出参与者
value	CallParticipant[]	通话中当前参与者的列表。