Attended Transfer Operations

After attended transfer is established, you can confirm the call transfer, cancel the call transfer, swap the call party or initial a three-party call through the interface.

Request URL

{base_url}/{api_path}/call/attended_transfer_operate?token={token}

Request parameters

Parameter Required Type Description
channelid Yes String The call channel ID of each member during the call.
operate Yes String The attended transfer operation.
Valid value:
  • abort: Cancel the call transfer.
  • complete: Confirm the call transfer.
  • threeway: Invite the third-party to join the call.
  • swap: Swap the call between the second party and the third party. For example, A and B are in a call, B performs attended transfer to transfer the call to C, A will be held. B can swap the call to talk with A.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
callid String The unique ID of each call.

Example 1

Confirm attended transfer.

Request example
POST /api/v2.0.0/call/attended_transfer_operate?token=2584a8eb3fe8739c185c534235ee9421 HTTP/1.1
Content-Type:application/json; charset=utf-8
 
{
	"channelid": "PJSIP/1020-0000003b",
	"operate": "complete"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"callid": "1571983052.150"
}

Example 2

Invite the consulting party to join the call.

Request example
POST /api/v2.0.0/call/attended_transfer_operate?token=2584a8eb3fe8739c185c534235ee9421 HTTP/1.1
Content-Type:application/json; charset=utf-8

{
	"channelid": "PJSIP/1020-0000003b",
	"operate": "threeway"
}

Response example

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"callid": "1571983052.151"
}