HangupCall
Invoke HangupCall to execute the agent hang-up operation.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Unique customer request ID. Used for idempotency validation and can be generated using UUID. |
46c1341e-2648-447a-9b11-70b6a298d94d |
| InstanceId |
string |
Yes |
AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. |
ccc_xp_pre-cn-*** |
| AccountName |
string |
Yes |
Agent account name (agent logon name). |
123@123.com |
| CallId |
string |
No |
Hotline session ID. |
7719786 |
| JobId |
string |
No |
The jobId from the WebSocket after an inbound call. |
7719787 |
| ConnectionId |
string |
No |
The connId from the WebSocket after an inbound call. |
7719788 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
result |
||
| Message |
string |
Status code description. |
xxxx |
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| Code |
string |
Status code. A return value of Success indicates that the request succeeded. |
Success |
| Success |
boolean |
Indicates whether the API call succeeded. |
true |
Examples
Success response
JSON format
{
"Message": "xxxx",
"RequestId": "EE338D98-9BD3-4413-B165",
"Code": "Success",
"Success": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | NoTenantFound | The specified tenant does not exist. | |
| 500 | SystemError | A system error occurred. Please contact the administrator. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.