Home > API Center > API interface guide
Cancel Task (Auto Recall)
POST
https://api.laaffic.com/voice/recallFlow/cancel
Cancel AI Agent auto-recall task. You can cancel the entire
auto-recall task, or cancel the execution of the current node and subsequent nodes
starting from a specific node in the auto-recall task.
Request Parameters
| Parameter | Description | Required | Type |
|---|---|---|---|
| type | Cancellation Type:1 - Cancel the automatic redial task based on the
primary key of the automatic redial task process;2 - Cancel the
automatic redial task based on the parent task ID;3 - Cancel the
current node and subsequent nodes using the unique primary key of
the process node.
For Cancellation Types [1, 2], the entire automatic redial task can be canceled, but only when the task is in a "Pending" status. For Cancellation Type [3], the execution of the current node and subsequent nodes within the automatic redial task can be canceled starting from a specific node, but only when that node is in a "Pending" status. |
Yes | Int |
| id | Pass parameters according to the type. When type is 3, pass the `keyId` in `nodeList`. |
Yes | Int |
Request Example
Request URL:
https://api.laaffic.com/voice/recallFlow/cancel
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"type": 1,
"id":12
}
Response Parameters
| Parameter | Description | Type |
|---|---|---|
| code | Status code, 0 for success, for other failures refer to Response Status Codes | String |
| reason | Description of failure reason | String |
| data | Returned data details | Object |
Response Example
{
"code": 0,
"msg": "success",
"data": null
}
Response Status Codes
| code | Status Description |
|---|---|
| 0 | Success |
| -1 | Account authentication error |
| -2 | IP limit |
| -16 | Timestamp expired |
| -18 | Port program unusual |
| -22 | Parameter exception |
Was this page helpful?
Questions about integration? Contact our technical support
LAAFFIC API dedicated TG technical support channel, real-time response to your needs