Batches

Cancel a batch

POSThttps://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/cancel

Cancel every contact not called yet and the batch’s calls still queued. Calls already ringing or in progress finish normally.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.place permission.

X-API-KeyAuthorization: Bearercalls.place

Path parameters

batch_idstringrequired

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/cancel?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/cancel"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

response = requests.post(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/cancel?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (calls.place)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}