Поделиться через

Participants - List

  • Ссылка
Service:
Communication
API Version:
2023-10-30-preview

Получение участников в комнате.

GET {endpoint}/rooms/{roomId}/participants?api-version=2023-10-30-preview

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

url

Конечная точка ресурса Связи Azure.
roomId
 path True

string

Идентификатор комнаты для получения участников.
api-version
 query True

string

Версия ВЫЗЫВАемого API.

Заголовок запроса

Имя Обязательно Тип Описание
Authorization True

string

Строка проверки подлинности, содержащая подпись, созданную с помощью схемы HMAC-SHA256.

Ответы

Имя Тип Описание
200 OK

ParticipantsCollection

Запрос выполнен успешно. Действие возвращает участников комнаты.
Other Status Codes

CommunicationErrorResponse

Сообщение об ошибке

Headers

x-ms-error-code: string

Безопасность

Authorization

Строка проверки подлинности, содержащая подпись, созданную с помощью схемы HMAC-SHA256.

Type: apiKey
In: header

Примеры

Get participants

Sample Request

GET https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2023-10-30-preview

Sample Response

Status code:
200 
{
  "value": [
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000333",
      "role": "Presenter"
    },
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000444",
      "role": "Attendee"
    },
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000555",
      "role": "Attendee"
    }
  ]
}

Определения

Имя Описание
ParticipantsCollection

Коллекция участников в комнате.
Role

Роль участника комнаты. Значение по умолчанию — Attendee.
RoomParticipant

Участник комнаты.

ParticipantsCollection

Коллекция участников в комнате.

Имя Тип Описание
nextLink

string

Если можно получить больше участников, будет заполнена следующая ссылка.
value

RoomParticipant[]

Коллекция участников.

Role

Роль участника комнаты. Значение по умолчанию — Attendee.

Имя Тип Описание
Attendee

string

Consumer

string

Presenter

string

RoomParticipant

Участник комнаты.

Имя Тип Описание
rawId

string

Необработанное представление идентификатора связи. Дополнительные сведения о необработанном идентификаторе см. в следующем документе.
https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation
role

Role

Роль участника комнаты. Значение по умолчанию — Attendee.