Call Connection - Mute

Référence

Service:: Communication

Version d'API:: 2024-09-15

Désactivez les participants à partir de l’appel à l’aide de l’identificateur.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?api-version=2024-09-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
callConnectionId	path	True	string	ID de connexion d’appel.
endpoint	path	True	string url	Point de terminaison de la ressource Azure Communication.
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 Azure Communication Services.
Repeatability-Request-ID		string uuid	S’il est spécifié, le client indique que la requête est reproductible ; autrement dit, que le client peut effectuer la requête plusieurs fois avec la même répétabilité -Request-Id et récupérer une réponse appropriée sans que le serveur exécute la requête plusieurs fois. La valeur de la répétabilité -Request-Id est une chaîne opaque représentant un identificateur unique généré par le client pour la requête. Il s’agit d’un UUID version 4 (aléatoire).
Repeatability-First-Sent		string date-time-rfc1123	Si repeatability-Request-ID en-tête est spécifié, l’en-tête repeatability-First-Sent doit également être spécifié. La valeur doit être la date et l’heure à laquelle la requête a été créée pour la première fois, exprimée à l’aide de la forme IMF-fixdate de la date HTTP. Exemple : Sun, 06 novembre 1994 08:49:37 GMT.

Corps de la demande

Nom	Obligatoire	Type	Description
targetParticipants	True	CommunicationIdentifierModel[]	Les participants doivent être désactivés à partir de l’appel. Seuls les utilisateurs ACS sont pris en charge.
operationContext		string	Utilisé par les clients lors de l’appel d’actions intermédiaires pour mettre en corrélation la demande à l’événement de réponse.

Réponses

Nom	Type	Description
200 OK	MuteParticipantsResult	Retourne la réponse des participants muets
Other Status Codes	CommunicationErrorResponse	Erreur

Sécurité

Authorization

Jeton d’accès utilisateur Azure Communication Services.

Type: apiKey
Dans: header

Exemples

CallConnection_Mute

Exemple de requête

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:mute?api-version=2024-09-15

{
  "targetParticipants": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    }
  ],
  "operationContext": "mute participant"
}

Exemple de réponse

Code d’état:: 200

{
  "operationContext": "mute participant"
}

Définitions

Nom	Description
MuteParticipantsRequest	Charge utile de la requête pour désactiver le son des participants à partir de l’appel.
MuteParticipantsResult	Charge utile de résultat pour désactiver le son des participants à partir de l’appel.

MuteParticipantsRequest

Charge utile de la requête pour désactiver le son des participants à partir de l’appel.

Nom	Type	Description
operationContext	string	Utilisé par les clients lors de l’appel d’actions intermédiaires pour mettre en corrélation la demande à l’événement de réponse.
targetParticipants	CommunicationIdentifierModel[]	Les participants doivent être désactivés à partir de l’appel. Seuls les utilisateurs ACS sont pris en charge.

MuteParticipantsResult

Charge utile de résultat pour désactiver le son des participants à partir de l’appel.

Nom	Type	Description
operationContext	string	Contexte d’opération fourni par le client.

Partager via