Participants - Update

Service:

Communication

Version d'API:

2025-03-13

Mettez à jour les participants dans une salle.

PATCH {endpoint}/rooms/{roomId}/participants?api-version=2025-03-13

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Point de terminaison de la ressource Azure Communication.
roomId	path	True	string	ID de la salle dans laquelle mettre à jour les participants.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Media Types: "application/merge-patch+json"

Nom	Obligatoire	Type	Description
Authorization	True	string	Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.

Corps de la demande

Media Types: "application/merge-patch+json"

Nom	Type	Description
participants	<string,  ParticipantProperties>	Participants à mettre à jour.

Réponses

Nom	Type	Description
200 OK	object	Les participants ont été mis à jour avec succès.
Other Status Codes	CommunicationErrorResponse	Réponse d’erreur En-têtes x-ms-error-code: string

Sécurité

Authorization

Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.

Type: apiKey
Dans: header

Exemples

Update participants

Exemple de requête

HTTP

PATCH https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2025-03-13

{
  "participants": {
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666": {
      "role": "Attendee"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777": {
      "role": "Presenter"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000888": {
      "role": "Collaborator"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000999": null
  }
}

Exemple de réponse

Code d’état:

200

{}

Définitions

Nom	Description
ParticipantProperties
Role	Rôle d’un participant de salle. La valeur par défaut est Participant.
UpdateParticipantsRequest	Participants à mettre à jour dans la salle.

ParticipantProperties

Object

Nom	Type	Description
role	Role	Rôle d’un participant de salle. La valeur par défaut est Participant.

Role

Enumeration

Rôle d’un participant de salle. La valeur par défaut est Participant.

Valeur	Description
Attendee
Collaborator
Consumer
Presenter

UpdateParticipantsRequest

Object

Participants à mettre à jour dans la salle.

Nom	Type	Description
participants	<string,  ParticipantProperties>	Participants à mettre à jour.