REST API v1

Build automated calls into your product

Launch calls and broadcasts right from your CRM, ERP or app. JSON, Bearer token, webhooks. Send one request and the system starts calling.

Documentation → OpenAPI file Sign up
quick start
# Start a call campaign
POST https://autocall.kz/api/v1/autocalls
Authorization: Bearer {your_token}
Accept: application/json

{
  "name": "Promo: 20% off",
  "type": "regular",
  "list_id": [1234],
  "audio_id": [5678],
  "time_from": "09:00:00",
  "time_to": "21:00:00"
}

← 201 Created { "id": 99012 }
REST
JSON API
Bearer
token authorization
Webhook
results in real time
5 min
to your first call via API

What you can do with the API

Full control over all AutoCall.kz services

Automated calls

Create, start, stop and relaunch campaigns. Get results for every call.

/api/v1/autocalls
GET POST PUT DEL

Contacts and lists

Manage contact lists. Upload up to 10,000 numbers per request and add more in batches.

/api/v1/lists
GET POST DEL

SMS broadcasts

Launch bulk SMS campaigns, calculate the cost, track delivery statuses.

/api/v1/bulks
GET POST PUT DEL

IVR scenarios

Build interactive scenarios with branching, speech recognition and key presses.

/api/v1/scenarios
GET POST PUT DEL

Audio

Upload MP3/WAV/OGG files or BASE64, or generate speech from text.

/api/v1/sounds
GET POST DEL

Flash Call

Verification by an incoming call. An auto-generated code or your own. Result in 3–10 seconds.

/api/v1/flash-calls
POST

Balance and statistics

Check your current balance, payment history and spending breakdown.

/api/v1/balance
GET

Webhook / Callback

Get notifications about every call and broadcast status change on your server in real time.

callback_url
CB

Authentication

Every request needs a Bearer token, which is your API key. Create it in your dashboard, in the API section. You can have several keys, for example a separate one for each project.

Keep the key in a safe place. To limit the damage if it leaks, you can allow the key only the API methods you need and only your servers’ addresses.

AUTH
headers
Authorization: Bearer eyJ0eXAiOiJKV...
Content-Type: application/json
Accept: application/json

Base URL

https://autocall.kz/api/v1/

Three steps in 5 minutes

Step 1 — Create a contact list
POST
/api/v1/lists
{
  "name": "Customers May 2025",
  "numbers": ["+77001234567", "+77089876543"]
}
← 201 { "id": 1234, "count": 2 }
Step 2 — Launch a call campaign
POST
/api/v1/autocalls
{
  "name": "Promo: 20% off",
  "type": "regular",
  "list_id": [1234],
  "audio_id": [5678],
  "time_from": "09:00:00",
  "time_to": "21:00:00",
  "max_tries": 2,
  "callback_url": "https://your.app/webhook"
}
← 201 { "id": 9999012, "status": "awaiting" }
Step 3 — Get the results
GET
/api/v1/autocalls/9999012
← 200 OK
{
  "id": 99012,
  "status": "completed",
  "processed_percentage": 100,
  "success": 612,
  "no_answer": 312,
  "recalled": 47,
  "busy": 29
}

Webhooks: results in real time

Set callback_url when you create a call campaign or SMS broadcast, and after each campaign finishes the system sends a POST request with full data to your server.

There is also a mid-call webhook: the request node in an IVR scenario makes an HTTP POST during the call, which is handy for dynamic data from your CRM.

Call statuses
success Answered and listened
recalled Called back (free)
no_answer No answer
busy Busy
error Connection error
spam Flagged as spam
cancelled Cancelled
Sample webhook payload
POST
→ your.app/webhook
{
  "id": 99012,
  "name": "Promo: 20% off",
  "status": "completed",
  "processed_percentage": 100,
  "success": 612,
  "recalled": 47,
  "no_answer": 312,
  "busy": 29,
  "error": 0,
  "spam": 0,
  "cancelled": 0,
  "total_duration": 18453, // seconds
  "date_start": "2025-05-17 09:00:00",
  "date_end": "2025-05-17 11:23:44"
}
Flash Call via API
POST
/api/v1/flash-calls
# Auto code: the system generates it
{ "number": "+77001234567", "digits": 4 }
← 201 { "code": "3910" }

# Your own code: you set it
{ "number": "+77001234567", "code": "2511" }
← 201 Created

IVR scenarios: nodes

An interactive call campaign is built from nodes, which are logic blocks. You put the scenario together like building blocks and upload it via the API or the interface.

Full documentation →
playback

Playback

Play an audio file to the contact

dtmf

Key press

Wait for a 0–9 key press and branch the scenario

speech

Speech recognition

Recognize the answer and pass it to the next block

talk_detect

Answer detection

Tell a live person from an answering machine

record

Voice recording

Record the contact’s answer (5–60 sec)

sms

SMS to contact

Send an SMS during the call

sms_me

SMS to operator

Notify your number about the call result

request

HTTP request (mid-call)

POST to your server during the call

dial

Call transfer

Connect the contact to a confirmed number

Endpoint reference

A full table of all available methods

Method Endpoint Description
GET /api/v1/autocalls List call campaigns
POST /api/v1/autocalls Create a call campaign
GET /api/v1/autocalls/{id} Campaign results
PUT /api/v1/autocalls/{id} Update a campaign
DEL /api/v1/autocalls/{id} Delete a campaign
GET /api/v1/autocalls/relaunch/{id} Relaunch a campaign
POST /api/v1/autocalls/calculate Calculate the cost
GET /api/v1/calls/{id} Details of a single call
GET /api/v1/calls/recordings/{id} Download the call recording
GET /api/v1/lists List contact lists
POST /api/v1/lists Create a list (up to 10,000 numbers)
POST /api/v1/lists/append/{id} Add numbers to a list
DEL /api/v1/contacts/{id} Remove a contact from a list
GET /api/v1/bulks List SMS broadcasts
POST /api/v1/bulks Launch an SMS broadcast
POST /api/v1/bulks/calculate Calculate SMS cost
GET /api/v1/messages/{id} Status of a single SMS
GET /api/v1/scenarios List IVR scenarios
POST /api/v1/scenarios Create a scenario
PUT /api/v1/scenarios/{id} Update a scenario
DEL /api/v1/scenarios/{id} Delete a scenario
GET /api/v1/sounds List audio files
POST /api/v1/sounds Upload an audio file
DEL /api/v1/sounds/{id} Delete an audio file
POST /api/v1/flash-calls Flash Call verification
GET /api/v1/balance Current balance
GET /api/v1/payments Payment history
GET /api/v1/settings Settings and pricing

Limits and restrictions

Contacts per request up to 10,000
Call attempts (max_tries) 1–4
Interval between attempts 3–120 minutes
SMS length (Cyrillic) 70 characters / part
SMS length (Latin) 160 characters / part
Voice recording (record node) 5–60 seconds
Silence timeout for recording 2–5 seconds
Flash Call code 3 or 4 digits
Numbers Kazakhstan only (+7)
API token Bearer, does not expire

Ready to integrate?

Your API key is available in the dashboard right after sign-up. After sign-up you also get bonus funds on your balance, enough for the integration.

Documentation → Sign up free