Releasing a Connection of a Specified Number

Prerequisites

• The agent has signed in.
• The agent has an ongoing call.

Description

This interface is used by an agent to release the connection of a specified phone number. Generally, this interface is used in internal help calls and three-party calls.

You can release only the connections of numbers in the last call. For example, when you make a two-party help call and the user is on hold, if you release the user on hold, an error (200–204) will be reported (currently, this processing mode is followed) because the user is not in the last call. However, when you make an outbound call and place the user on hold, you can normally release the user on hold because the user is in the last call.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/disconnect/{number}

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

Method Name in Logs

disconnect

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_Call_Release
• AgentEvent_Customer_Release

Error Code

• 100-006
• 100-007
• 200-023
• 200-024

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