Skip to navigation
Management APIReferenceCall Lists

CancelCallListTask

View as Markdown

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.

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_idintegerOptional
Task's ID
task_uuidstringOptional
Task's UUID
resultboolean or list of anyOptional
Result of the operation
error_msgstringOptional
Reason for the error