Batches

Create a batch

POSThttps://voxa.abhinavyadav.in/api/v1/batches

Schedule a batch from an upload. Each valid row becomes a contact; the other columns become its user_data. Calls go through the workspace’s outbound queue inside the agent’s calling hours.

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

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.

Body application/json

upload_idstringrequired

at most 64 characters

agent_idstringrequired

at most 64 characters

namestring

at most 120 characters

phone_columnstring

detected when empty

at most 64 characters

from_numberstring

the agent's number when empty

matches ^$|^\+?[0-9]{8,15}$

start_atstring | null

when to start; empty or past = now. Without an offset it is read in timezone

date-time

timezonestringdefault: "Asia/Kolkata"

at most 64 characters

retryobject

Show child attributes

outcomesenum<string>[]

call outcomes that are retried

max_retriesintegerdefault: 1

extra attempts per contact after the first call

0 to 3

delay_minutesintegerdefault: 30

wait between attempts

1 to 1440

Response

201Success.

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?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "upload_id": "upload", "agent_id": "agent", "name": "", "phone_column": "", "from_number": "", "start_at": null, "timezone": "Asia/Kolkata", "retry": { "outcomes": [ "no-answer" ], "max_retries": 1, "delay_minutes": 30 } }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/batches" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "upload_id": "upload", "agent_id": "agent", "name": "", "phone_column": "", "from_number": "", "start_at": None, "timezone": "Asia/Kolkata", "retry": { "outcomes": [ "no-answer", ], "max_retries": 1, "delay_minutes": 30, }, } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/batches?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "upload_id": "upload", "agent_id": "agent", "name": "", "phone_column": "", "from_number": "", "start_at": null, "timezone": "Asia/Kolkata", "retry": { "outcomes": [ "no-answer" ], "max_retries": 1, "delay_minutes": 30 } }), }) const data = await response.json() console.log(response.status, data)