Call Connection - Transfer To Participant

Référence

Service:: Communication

Version d'API:: 2024-09-15

Transférez l’appel à un participant.

POST {endpoint}/calling/callConnections/{callConnectionId}:transferToParticipant?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
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Utilisé par le client pour envoyer un contexte d’appel personnalisé aux cibles
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
transferee		CommunicationIdentifierModel

Réponses

Nom	Type	Description
202 Accepted	TransferCallResponse	Le service a accepté la demande de transfert et commence à le traiter. Vous recevrez l’événement CallTransferAccepted ou CallTransferFailed à l’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_TransferToParticipant

Exemple de requête

HTTP

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

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "transferee": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback",
  "operationContext": "trasferring call"
}

Exemple de réponse

Code d’état:: 202

{
  "operationContext": "trasferring call"
}

Définitions

Nom	Description
CustomCallingContext	Contexte d’appel personnalisé qui sera envoyé à la cible
TransferCallResponse	Charge utile de réponse pour le transfert de l’appel.
TransferToParticipantRequest	Charge utile de la demande pour le transfert de l’appel à un participant.

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é

TransferCallResponse

Charge utile de réponse pour le transfert de l’appel.

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

TransferToParticipantRequest

Charge utile de la demande pour le transfert de l’appel à un participant.

Nom	Type	Description
customCallingContext	CustomCallingContext	Utilisé par le client pour envoyer un contexte d’appel personnalisé aux cibles
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
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Partager via