Rooms - Remove Participants

Servicio:

Communication

Versión de la API:

2022-02-01

Quitar participantes de una sala.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Punto de conexión del recurso de Comunicación de Azure.
roomId	path	True	string	Id. de la sala del que se van a quitar los participantes.
api-version	query	True	string	Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Un token de acceso de usuario de ACS (Azure Communication Services).

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
participants	True	RoomParticipant[]	Participantes que se van a quitar de una sala.

Respuestas

Nombre	Tipo	Description
200 OK	ParticipantsCollection	Los participantes se eliminaron correctamente. La acción devuelve una lista actualizada de participantes.
Other Status Codes	CommunicationErrorResponse	Respuesta de error Encabezados x-ms-error-code: string

Seguridad

Authorization

Un token de acceso de usuario de ACS (Azure Communication Services).

Tipo: apiKey
En: header

Ejemplos

Remove participant

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
CommunicationIdentifierModel	Identifica a un participante en Azure Communication Services. Un participante es, por ejemplo, un usuario de comunicación de Azure. Este modelo debe interpretarse como una unión: aparte de rawId, se puede establecer como máximo una propiedad adicional.
ParticipantsCollection	Colección de participantes en una sala.
RemoveParticipantsRequest	Participantes que se van a quitar de una sala.
RoleType	Rol de un participante de la sala.
RoomParticipant	Participante de la sala.

CommunicationIdentifierModel

Object

Identifica a un participante en Azure Communication Services. Un participante es, por ejemplo, un usuario de comunicación de Azure. Este modelo debe interpretarse como una unión: aparte de rawId, se puede establecer como máximo una propiedad adicional.

Nombre	Tipo	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	Identificador sin formato del identificador. Opcional en las solicitudes, necesarias en las respuestas.

ParticipantsCollection

Object

Colección de participantes en una sala.

Nombre	Tipo	Description
participants	RoomParticipant[]	Participantes de la sala.

RemoveParticipantsRequest

Object

Participantes que se van a quitar de una sala.

Nombre	Tipo	Description
participants	RoomParticipant[]	Participantes que se van a quitar de una sala.

RoleType

Enumeración

Rol de un participante de la sala.

Valor	Description
Presenter
Attendee
Consumer

RoomParticipant

Object

Participante de la sala.

Nombre	Tipo	Description
communicationIdentifier	CommunicationIdentifierModel	Identifica a un participante en Azure Communication Services. Un participante es, por ejemplo, un usuario de comunicación de Azure. Este modelo debe interpretarse como una unión: aparte de rawId, se puede establecer como máximo una propiedad adicional.
role	RoleType	Rol de un participante de la sala.