Calls

Place a call

POSThttps://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/call

Queues an outbound phone call. Calls are dialled by a worker as soon as one of your workspace’s call slots is free and, unless ignore_call_window is set, inside the agent’s calling hours (call.call_start_hour to call.call_end_hour).

user_data fills the agent’s {variables}. The caller ID is from_number, else the agent’s own number; with neither the call is refused with 400. Returns 402 when the workspace is out of credits.

Follow the call with Get a call, its timeline, or webhooks.

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

agent_idstringrequired

The agent's id.

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

tostringrequired

The number to call, with country code (+919812345678).

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

from_numberstring

Caller ID; defaults to the agent's phone_number. Must be a number assigned to your workspace.

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

user_dataobject

Values for the agent's {variables}; also sent back on the call record and in webhooks.

ignore_call_windowbooleandefault: false

Dial even outside the agent's calling hours.

Response

201Success.

call_idstring

statusenum<string>

positioninteger

Place in the workspace's queue (1 is next).

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/agents/{agent_id}/call?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "to": "+919812345678", "user_data": { "caller_name": "Rohan" }, "ignore_call_window": false }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/agents/{agent_id}/call" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "to": "+919812345678", "user_data": { "caller_name": "Rohan", }, "ignore_call_window": False, } 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/agents/{agent_id}/call?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "to": "+919812345678", "user_data": { "caller_name": "Rohan" }, "ignore_call_window": false }), }) const data = await response.json() console.log(response.status, data)