Rooms - Remove Participants

Служба:

Communication

Версия API:

2022-02-01

Удалите участников из комнаты.

POST {endpoint}/rooms/{roomId}/participants:remove?api-version=2022-02-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка ресурса связи Azure.
roomId	path	True	string	Идентификатор комнаты для удаления участников.
api-version	query	True	string	Версия API для вызова.

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

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей ACS (Службы коммуникации Azure).

Текст запроса

Имя	Обязательно	Тип	Описание
participants	True	RoomParticipant[]	Участники, которые будут удалены из комнаты.

Ответы

Имя	Тип	Описание
200 OK	ParticipantsCollection	Участники успешно удалены. Действие возвращает обновленный список участников.
Other Status Codes	CommunicationErrorResponse	Ответ на ошибку Заголовки x-ms-error-code: string

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

Authorization

Маркер доступа пользователей ACS (Службы коммуникации Azure).

Тип: apiKey
В: header

Примеры

Remove participant

Образец запроса

HTTP

POST https://contoso.communication.azure.com//rooms/99199690362660524/participants:remove?api-version=2022-02-01

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666"
        }
      },
      "role": "Presenter"
    }
  ]
}

Пример ответа

Код состояния:

200

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777"
        }
      },
      "role": "Attendee"
    }
  ]
}

Определения

Имя	Описание
CommunicationIdentifierModel	Определяет участника в службах коммуникации Azure. Участник, например, пользователь связи Azure. Эта модель должна быть интерпретирована как объединение: помимо необработанного идентификатора, может быть задано не более одного дополнительного свойства.
ParticipantsCollection	Коллекция участников в комнате.
RemoveParticipantsRequest	Участники, которые будут удалены из комнаты.
RoleType	Роль участника комнаты.
RoomParticipant	Участник комнаты.

CommunicationIdentifierModel

Object

Определяет участника в службах коммуникации Azure. Участник, например, пользователь связи Azure. Эта модель должна быть интерпретирована как объединение: помимо необработанного идентификатора, может быть задано не более одного дополнительного свойства.

Имя	Тип	Описание
communicationUser	CommunicationUserIdentifierModel
rawId	string	Необработанный идентификатор идентификатора. Необязательно в запросах, необходимых в ответах.

ParticipantsCollection

Object

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

Имя	Тип	Описание
participants	RoomParticipant[]	Участники комнаты.

RemoveParticipantsRequest

Object

Участники, которые будут удалены из комнаты.

Имя	Тип	Описание
participants	RoomParticipant[]	Участники, которые будут удалены из комнаты.

RoleType

Перечисление

Роль участника комнаты.

Значение	Описание
Presenter
Attendee
Consumer

RoomParticipant

Object

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

Имя	Тип	Описание
communicationIdentifier	CommunicationIdentifierModel	Определяет участника в службах коммуникации Azure. Участник, например, пользователь связи Azure. Эта модель должна быть интерпретирована как объединение: помимо необработанного идентификатора, может быть задано не более одного дополнительного свойства.
role	RoleType	Роль участника комнаты.