Call Connection - Transfer To Participant

Referens

Tjänst:: Communication

API-version:: 2023-10-15

Överför samtalet till en deltagare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
callConnectionId	path	True	string	Samtalsanslutnings-ID: t.
endpoint	path	True	string url	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En Azure Communication Services användaråtkomsttoken.
Repeatability-Request-ID		string uuid	Om det anges dirigerar klienten att begäran kan upprepas. Det vill säga att klienten kan göra begäran flera gånger med samma Repeatability-Request-ID och få tillbaka ett lämpligt svar utan att servern kör begäran flera gånger. Värdet för Repeatability-Request-Id är en täckande sträng som representerar en klientgenererad unik identifierare för begäran. Det är en version 4 (slumpmässig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Om Repeatability-Request-ID-header anges måste även rubriken Repeatability-First-Sent anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av HTTP-datum i IMF-fixdate-form. Exempel: Sön, 06 nov 1994 08:49:37 GMT.

Begärandetext

Name	Obligatorisk	Typ	Description
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Används av kunden för att skicka anpassad samtalskontext till mål
operationCallbackUri		string	Ange en återanrops-URI som åsidosätter standardanrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte har angetts används standardåteranrops-URI:n som angetts av CreateCall/AnswerCall.
operationContext		string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.
transferee		CommunicationIdentifierModel

Svar

Name	Typ	Description
202 Accepted	TransferCallResponse	Tjänsten har accepterat överföringsbegäran och börjar bearbeta den. Du får antingen CallTransferAccepted- eller CallTransferFailed-händelsen vid din angivna återanrops-URI för att uppdatera dig om status för begäran.
Other Status Codes	CommunicationErrorResponse	Fel

Säkerhet

Authorization

En Azure Communication Services användaråtkomsttoken.

Typ: apiKey
I: header

Exempel

CallConnection_TransferToParticipant

Exempelbegäran

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:transferToParticipant?api-version=2023-10-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"
}

Exempelsvar

Statuskod:: 202

{
  "operationContext": "trasferring call"
}

Definitioner

Name	Description
CustomCallingContext	Den anpassade samtalskontexten som skickas till målet
TransferCallResponse	Svarsnyttolasten för överföring av anropet.
TransferToParticipantRequest	Nyttolasten för begäran för överföring av samtal till en deltagare.

CustomCallingContext

Den anpassade samtalskontexten som skickas till målet

Name	Typ	Description
sipHeaders	object	SIP-huvuden för anpassad samtalskontext
voipHeaders	object	VoiP-huvuden för anpassad samtalskontext

TransferCallResponse

Svarsnyttolasten för överföring av anropet.

Name	Typ	Description
operationContext	string	Åtgärdskontexten som tillhandahålls av klienten.

TransferToParticipantRequest

Nyttolasten för begäran för överföring av samtal till en deltagare.

Name	Typ	Description
customCallingContext	CustomCallingContext	Används av kunden för att skicka anpassad samtalskontext till mål
operationCallbackUri	string	Ange en återanrops-URI som åsidosätter standardanrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte har angetts används standardåteranrops-URI:n som angetts av CreateCall/AnswerCall.
operationContext	string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Dela via