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:port/agentgateway/resource/voicecall/{agentid}/disconnect/{number}
In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.
No. |
Parameter |
Data Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|---|
1 |
agentid |
string |
Yes |
Agent ID. The value ranges from 101 to 59999. |
2 |
number |
string |
Yes |
Phone number whose connection needs to be released. The value is a number of 1 to 24 digits. During an internal help call, the current agent can release the requested agent (the value is the employee ID of the requested agent) or the current agent (the value is the softphone number of the current agent). The requested agent can release only the requested agent but cannot release the current agent or user. |
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).
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
message |
string |
Description. |
2 |
retcode |
string |
Error code. The options are as follows: 0: success Other values: failure |
3 |
result |
object |
Reserved field. |
Triggered Event
- AgentEvent_Call_Release
- AgentEvent_Customer_Release
Error Code
- 100-006
- 100-007
- 200-023
- 200-024
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot