Rooms - Remove Participants

Serviço:

Communication

Versão da API:

2022-02-01

Remova os participantes de uma sala.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	O ponto de extremidade do recurso de Comunicação do Azure.
roomId	path	True	string	ID da sala para remover os participantes.
api-version	query	True	string	Versão da API a invocar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Corpo do Pedido

Name	Necessário	Tipo	Description
participants	True	RoomParticipant[]	Os participantes devem ser retirados de uma sala.

Respostas

Name	Tipo	Description
200 OK	ParticipantsCollection	Os participantes foram excluídos com sucesso. A ação retorna uma lista atualizada de participantes.
Other Status Codes	CommunicationErrorResponse	Resposta de erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Remove participant

Pedido de amostra

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"
    }
  ]
}

Resposta da amostra

Código de estado:

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"
    }
  ]
}

Definições

Name	Description
CommunicationIdentifierModel	Identifica um participante nos serviços de Comunicação do Azure. Um participante é, por exemplo, um usuário de comunicação do Azure. Este modelo deve ser interpretado como uma união: além do rawId, no máximo mais uma propriedade pode ser definida.
ParticipantsCollection	Recolha de participantes numa sala.
RemoveParticipantsRequest	Os participantes devem ser retirados de uma sala.
RoleType	O papel de um participante da sala.
RoomParticipant	Um participante da sala.

CommunicationIdentifierModel

Object

Identifica um participante nos serviços de Comunicação do Azure. Um participante é, por exemplo, um usuário de comunicação do Azure. Este modelo deve ser interpretado como uma união: além do rawId, no máximo mais uma propriedade pode ser definida.

Name	Tipo	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	ID bruto do identificador. Opcional nas solicitações, obrigatório nas respostas.

ParticipantsCollection

Object

Recolha de participantes numa sala.

Name	Tipo	Description
participants	RoomParticipant[]	Participantes da sala.

RemoveParticipantsRequest

Object

Os participantes devem ser retirados de uma sala.

Name	Tipo	Description
participants	RoomParticipant[]	Os participantes devem ser retirados de uma sala.

RoleType

Enumeração

O papel de um participante da sala.

Valor	Description
Presenter
Attendee
Consumer

RoomParticipant

Object

Um participante da sala.

Name	Tipo	Description
communicationIdentifier	CommunicationIdentifierModel	Identifica um participante nos serviços de Comunicação do Azure. Um participante é, por exemplo, um usuário de comunicação do Azure. Este modelo deve ser interpretado como uma união: além do rawId, no máximo mais uma propriedade pode ser definida.
role	RoleType	O papel de um participante da sala.