Batches

List a batch's contacts

GEThttps://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/contacts

Contacts in file order: number, user_data, status, attempts and the latest call id.

Authorization

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

X-API-KeyAuthorization: Bearercalls.view

Path parameters

batch_idstringrequired

Query parameters

statusstring

comma-separated contact statuses

at most 120 characters

qstring

phone number or a value in the first columns

at most 80 characters

limitintegerdefault: 50

How many to return.

1 to 200

skipintegerdefault: 0

How many to skip (for paging).

at least 0

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 GET \
  --url 'https://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/contacts?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

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

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

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/batches/{batch_id}/contacts?timezone=Asia/Kolkata", {
  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.view)"
}

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

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