Send Bulk Voice Call

Send a recorded voice call (Simple, Key Press or Call Patch) to one or many numbers, now or at a scheduled time. The cost is held from your wallet when the campaign is accepted; only answered calls are charged and the rest is refunded automatically.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Send a Simple, Key Press or Call Patch voice call to up to 1,00,000 numbers per request, now or with schedule_time.

CallSend
Simple Callnumbers, file_id
Key Pressnumbers, file_id, dtmf_keys
Call Patchnumbers, file_id, agent_groups, no_agent_file_id

The call type comes from what you send: dtmf_keys makes it a Key Press call, agent_groups a Call Patch call.

The reply's request_id (15 characters, starts with V) identifies the campaign in the report API and in webhooks. Mistakes return 422 with a message saying what to fix (for example a missing voice file, no keys, a key without an agent group, or not enough wallet balance).

Body Params
string
required

10-digit mobile numbers, comma separated. Max 1,00,000 per request.

integer
required

File ID of your approved voice file (Voice Files in the panel, or GET /dev/voice/files). For Key Press and Call Patch this is the file that asks the caller to press a key.

string

Key Press: keys the caller may press, e.g. 1,2. Sending it makes the call a Key Press call.

string

Call Patch: key:Group ID pairs, e.g. 1:12,2:15 (Group ID from Voice Call > Agent Groups). Sending it makes the call a Call Patch call.

integer

Call Patch: voice file played when no agent picks up.

string

Optional: send later, YYYY-MM-DD HH:MM:SS (IST). Empty = send now.

Headers
string
required
Defaults to YOUR_API_KEY

Provide "YOUR_API_KEY".

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json