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	Идентификатор подключения вызова
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=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

Object

Участник вызова.

Имя	Тип	Описание
identifier	CommunicationIdentifierModel
isMuted	boolean	Отключен ли участник
isOnHold	boolean	Участник на удержании.

GetParticipantsResponse

Object

Полезные данные ответа для получения участников вызова.

Имя	Тип	Описание
nextLink	string	Продолжение списка участников
value	CallParticipant[]	Список текущих участников вызова.