Call Connection - Add Participant

Référence

Service:: Communication

Version d'API:: 2024-09-15

Ajoutez un participant à l’appel.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Utilisé par le client pour envoyer un contexte d’appel personnalisé aux cibles
invitationTimeoutInSeconds		integer	Obtient ou définit le délai d’attente d’attente du participant invité à récupérer. La valeur maximale de cette valeur est de 180 secondes
operationCallbackUri		string	Définissez un URI de rappel qui remplace l’URI de rappel par défaut défini par CreateCall/AnswerCall pour cette opération. Cette configuration est par action. S’il n’est pas défini, l’URI de rappel par défaut défini par CreateCall/AnswerCall sera utilisé.
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.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Facultatif) Nom complet de la source associée à cette opération d’invitation lors de l’ajout d’un participant RTC ou d’un utilisateur teams. Remarque : ne met pas à jour le nom complet dans la liste.

Réponses

Nom	Type	Description
202 Accepted	AddParticipantResponse	Le service a accepté la demande d’ajout de participant et commencera à le traiter. Vous recevrez l’événement AddParticipantSucceeded ou AddParticipantFailed à votre URI de rappel spécifié pour vous mettre à jour sur l’état de la requête.
Other Status Codes	CommunicationErrorResponse	Erreur

Sécurité

Authorization

Jeton d’accès utilisateur Azure Communication Services.

Type: apiKey
Dans: header

Exemples

CallConnection_AddParticipant

Exemple de requête

HTTP

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

{
  "participantToAdd": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "adding participant",
  "sourceCallerIdNumber": {
    "value": "+18440123456"
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Exemple de réponse

Code d’état:: 202

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

Définitions

Nom	Description
AddParticipantRequest	Charge utile de la demande pour l’ajout d’un participant à l’appel.
AddParticipantResponse	Charge utile de réponse pour l’ajout de participants à l’appel.
CallParticipant	Un participant d’appel.
CustomCallingContext	Contexte d’appel personnalisé qui sera envoyé à la cible

AddParticipantRequest

Charge utile de la demande pour l’ajout d’un participant à l’appel.

Nom	Type	Description
customCallingContext	CustomCallingContext	Utilisé par le client pour envoyer un contexte d’appel personnalisé aux cibles
invitationTimeoutInSeconds	integer	Obtient ou définit le délai d’attente d’attente du participant invité à récupérer. La valeur maximale de cette valeur est de 180 secondes
operationCallbackUri	string	Définissez un URI de rappel qui remplace l’URI de rappel par défaut défini par CreateCall/AnswerCall pour cette opération. Cette configuration est par action. S’il n’est pas défini, l’URI de rappel par défaut défini par CreateCall/AnswerCall sera utilisé.
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.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Facultatif) Nom complet de la source associée à cette opération d’invitation lors de l’ajout d’un participant RTC ou d’un utilisateur teams. Remarque : ne met pas à jour le nom complet dans la liste.

AddParticipantResponse

Charge utile de réponse pour l’ajout de participants à l’appel.

Nom	Type	Description
invitationId	string	ID d’invitation utilisé pour ajouter un participant.
operationContext	string	Contexte d’opération fourni par le client.
participant	CallParticipant	Liste des participants actuels dans l’appel.

CallParticipant

Un participant d’appel.

Nom	Type	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	Est-ce que le participant est désactivé
isOnHold	boolean	Est-ce que le participant est en attente.

CustomCallingContext

Contexte d’appel personnalisé qui sera envoyé à la cible

Nom	Type	Description
sipHeaders	object	En-têtes SIP de contexte d’appel personnalisé
voipHeaders	object	En-têtes VoiP de contexte d’appel personnalisé

Partager via