Call Connection - Transfer To Participant

Reference

Service:: Communication

API Version:: 2024-09-15

Transfer the call to a participant.

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

URI Parameters

Name	In	Required	Type	Description
callConnectionId	path	True	string	The call connection id.
endpoint	path	True	string url	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An Azure Communication Services user access token.
Repeatability-Request-ID		string uuid	If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.
Repeatability-First-Sent		string date-time-rfc1123	If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.

Request Body

Name	Required	Type	Description
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Used by customer to send custom calling context to targets
operationCallbackUri		string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext		string	Used by customers when calling mid-call actions to correlate the request to the response event.
sourceCallerIdNumber		PhoneNumberIdentifierModel
transferee		CommunicationIdentifierModel

Responses

Name	Type	Description
202 Accepted	TransferCallResponse	The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_TransferToParticipant

Sample request

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

Sample response

Status code:: 202

{
  "operationContext": "trasferring call"
}

Definitions

Name	Description
CustomCallingContext	The custom calling context which will be sent to the target
TransferCallResponse	The response payload for transferring the call.
TransferToParticipantRequest	The request payload for transferring call to a participant.

CustomCallingContext

The custom calling context which will be sent to the target

Name	Type	Description
sipHeaders	object	Custom calling context SIP headers
voipHeaders	object	Custom calling context VoiP headers

TransferCallResponse

The response payload for transferring the call.

Name	Type	Description
operationContext	string	The operation context provided by client.

TransferToParticipantRequest

The request payload for transferring call to a participant.

Name	Type	Description
customCallingContext	CustomCallingContext	Used by customer to send custom calling context to targets
operationCallbackUri	string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext	string	Used by customers when calling mid-call actions to correlate the request to the response event.
sourceCallerIdNumber	PhoneNumberIdentifierModel
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Sdílet prostřednictvím