Canceling Transfer

Prerequisites

• The agent has signed in.
• The agent has a transferred call (the transfer mode is three-party transfer or talk forwarding, and the transfer device is an external number).

Description

This interface is used by the agent to retrieve the transferred call.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/canceltransfer

In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent gateway server.

Method Name in Logs

cancelTransfer

Request Description

• Message header

  Table 2 Parameters in the request message header

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	Content-Type	string	Yes	Coding mode of the message body. The default value is application/json; charset=UTF-8.
  2	Guid	string	Yes	GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

• Message body

  None

Response Description

Triggered Event

• AgentEvent_Talking
• AgentEvent_Customer_Release

Error Code

• 100-006
• 100-007
• 200-012

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  None

• Response parameter

  {
    "result": {},
    "message": "success",
    "retcode": "0"
  }