Dropping a Call
Prerequisites
- The agent has signed in.
- The agent has an ongoing call.
Description
This interface is invoked by an agent to hang up an ongoing call. Only the current call can be hung up. The call ID needs to be specified. For details, see Disconnecting a Call of a Specified ID.
Interface Method
The request method must be set to DELETE. This interface supports only the DELETE method.
URI
1.https://ip:port/agentgateway/resource/voicecall/{agentid}/release
2.https://ip:port/agentgateway/resource/voicecall/{agentid}
The second interface is provided to be compatible with earlier versions and is not recommended.
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. |
Method Name in Logs
1. Name of the method for the URL https://ip:port/agentgateway/resource/voicecall/{agentid}/release: release
2. Name of the method for the URL https://ip:port/agentgateway/resource/voicecall/{agentid}: releaseEx
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-017
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