Skip to main content

Canceling call jobs

The following Calls API method allows canceling previously created call jobs:

  • POST /api/calls/campaign/{token}/callJob/cancel
caution
You can only cancel calls to phone numbers that were added via the Calls API.

Request body​

The body of requests to this method contains a JSON with any of the following properties:

  • phones — an array of phone numbers which should have calls to them canceled.
  • ids — an array of call job IDs which should be canceled.
tip
You can also pass both properties in one request.

Example request​

curl --request POST 'https://platform.tovie.ai/api/calls/campaign/8231.7056.1b131df1/callJob/cancel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phones": [
        16500000000
    ],
    "ids": [
        12345,
        67890
    ]
}'

The response will be an array of all canceled call job IDs.