Rooms - Remove Participants

Service:

Communication

Version d'API:

2022-02-01

Supprimez les participants d’une salle.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	Point de terminaison de la ressource Azure Communication.
roomId	path	True	string	ID de salle à partir duquel supprimer les participants.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur ACS (Azure Communication Services).

Corps de la demande

Nom	Obligatoire	Type	Description
participants	True	RoomParticipant[]	Participants à retirer d’une salle.

Réponses

Nom	Type	Description
200 OK	ParticipantsCollection	Les participants ont été supprimés avec succès. L’action retourne une liste mise à jour des participants.
Other Status Codes	CommunicationErrorResponse	Réponse d’erreur En-têtes x-ms-error-code: string

Sécurité

Authorization

Jeton d’accès utilisateur ACS (Azure Communication Services).

Type: apiKey
Dans: header

Exemples

Remove participant

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CommunicationIdentifierModel	Identifie un participant dans Azure Communication Services. Un participant est, par exemple, un utilisateur de communication Azure. Ce modèle doit être interprété comme une union : à part rawId, au plus une autre propriété peut être définie.
ParticipantsCollection	Collection de participants dans une salle.
RemoveParticipantsRequest	Participants à retirer d’une salle.
RoleType	Rôle d’un participant de salle.
RoomParticipant	Un participant de la salle.

CommunicationIdentifierModel

Object

Identifie un participant dans Azure Communication Services. Un participant est, par exemple, un utilisateur de communication Azure. Ce modèle doit être interprété comme une union : à part rawId, au plus une autre propriété peut être définie.

Nom	Type	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	ID brut de l’identificateur. Facultatif dans les requêtes, requis dans les réponses.

ParticipantsCollection

Object

Collection de participants dans une salle.

Nom	Type	Description
participants	RoomParticipant[]	Participants de salle.

RemoveParticipantsRequest

Object

Participants à retirer d’une salle.

Nom	Type	Description
participants	RoomParticipant[]	Participants à retirer d’une salle.

RoleType

Énumération

Rôle d’un participant de salle.

Valeur	Description
Presenter
Attendee
Consumer

RoomParticipant

Object

Un participant de la salle.

Nom	Type	Description
communicationIdentifier	CommunicationIdentifierModel	Identifie un participant dans Azure Communication Services. Un participant est, par exemple, un utilisateur de communication Azure. Ce modèle doit être interprété comme une union : à part rawId, au plus une autre propriété peut être définie.
role	RoleType	Rôle d’un participant de salle.