Call Connection - Transfer To Participant

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Durchstellen des Anrufs an einen Teilnehmer.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
callConnectionId	path	True	string	Die Anrufverbindungs-ID.
endpoint	path	True	string url	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services-Benutzerzugriffstoken.
Repeatability-Request-ID		string uuid	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-Id und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-Id ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine Version 4 (zufällig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums. Beispiel: Sun, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Anrufkontext an Ziele zu senden
operationCallbackUri		string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext		string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
sourceCallerIdNumber		PhoneNumberIdentifierModel
transferee		CommunicationIdentifierModel

Antworten

Name	Typ	Beschreibung
202 Accepted	TransferCallResponse	Der Dienst hat die Übertragungsanforderung akzeptiert und beginnt mit der Verarbeitung. Sie erhalten entweder das CallTransferAccepted- oder CallTransferFailed-Ereignis an Ihrem angegebenen Rückruf-URI, um Sie über den Status der Anforderung zu aktualisieren.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallConnection_TransferToParticipant

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 202

{
  "operationContext": "trasferring call"
}

Definitionen

Name	Beschreibung
CustomCallingContext	Der benutzerdefinierte Aufrufkontext, der an das Ziel gesendet wird
TransferCallResponse	Die Antwortnutzlast für die Übertragung des Anrufs.
TransferToParticipantRequest	Die Anforderungsnutzlast für die Anrufweiterleitung an einen Teilnehmer.

CustomCallingContext

Der benutzerdefinierte Aufrufkontext, der an das Ziel gesendet wird

Name	Typ	Beschreibung
sipHeaders	object	Benutzerdefinierte Anrufkontext-SIP-Header
voipHeaders	object	VoiP-Header für benutzerdefinierte Anrufkontexte

TransferCallResponse

Die Antwortnutzlast für die Übertragung des Anrufs.

Name	Typ	Beschreibung
operationContext	string	Der vom Client bereitgestellte Vorgangskontext.

TransferToParticipantRequest

Die Anforderungsnutzlast für die Anrufweiterleitung an einen Teilnehmer.

Name	Typ	Beschreibung
customCallingContext	CustomCallingContext	Wird vom Kunden verwendet, um benutzerdefinierten Anrufkontext an Ziele zu senden
operationCallbackUri	string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext	string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
sourceCallerIdNumber	PhoneNumberIdentifierModel
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Freigeben über