CancelCallListTask | Voximplant Voice AI

Cancels the specified tasks in the call list by their IDs or UUIDs. The maximum number of tasks to cancel is 1000.

Allowed roles: Owner, Admin, Developer, Call list manager.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

account_idstringRequired

Account's ID

list_idstringRequired

Call list's ID

tasks_idsstringOptional

Task IDs separated by a semicolon. Specify either tasks_ids or tasks_uuids. The method returns an error if none of the parameters is specified

tasks_uuidsstringOptional

Task UUIDs separated by a semicolon. Specify either tasks_ids or tasks_uuids. The method returns an error if none of the parameters is specified

Response

Successful response

task_idinteger

Task's ID

task_uuidstring

Task's UUID

resultboolean or list of any

Result of the operation

error_msgstring

Reason for the error

$	curl -X POST "https://api.voximplant.com/platform_api/CancelCallListTask?account_id=987654321&list_id=123456789&tasks_ids=101%3B102%3B103" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"result": [
3	{
4	"task_id": 101,
5	"task_uuid": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
6	"result": true
7	},
8	{
9	"task_id": 102,
10	"task_uuid": "b2c3d4e5-f678-9012-ab34-cd56ef789012",
11	"result": true
12	},
13	{
14	"task_id": 103,
15	"task_uuid": "c3d4e5f6-7890-1234-ab56-cd78ef901234",
16	"result": false,
17	"error_msg": "Task already cancelled"
18	}
19	]
20	}