REST API v1

Автоматты қоңырау шалу қызметін өз өніміңізге қосыңыз

Қоңыраулар мен таратылымдарды CRM, ERP жүйеңізден немесе қосымшаңыздан тікелей іске қосыңыз. JSON, Bearer токен, webhooks. Бір сұрау жіберсеңіз, жүйе қоңырау шала бастайды.

Құжаттама → OpenAPI файлы Тіркелу
quick start
# Қоңырау науқанын іске қосу
POST https://autocall.kz/api/v1/autocalls
Authorization: Bearer {your_token}
Accept: application/json

{
  "name": "Акция: 20% жеңілдік",
  "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
токен арқылы авторизация
Webhook
нақты уақыттағы нәтижелер
5 мин
API арқылы алғашқы қоңырауға дейін

API арқылы не істеуге болады

AutoCall.kz барлық қызметтерін толық басқару

Автоматты қоңыраулар

Науқандарды құрыңыз, іске қосыңыз, тоқтатыңыз және қайта іске қосыңыз. Әр қоңырау бойынша нәтиже алыңыз.

/api/v1/autocalls
GET POST PUT DEL

Контактілер мен базалар

Контактілер тізімдерін басқарыңыз. Бір сұраумен 10 000 нөмірге дейін жүктеп, бөліп-бөліп қосыңыз.

/api/v1/lists
GET POST DEL

SMS тарату

Жаппай SMS науқандарын іске қосыңыз, құнын есептеңіз, жеткізу мәртебелерін бақылаңыз.

/api/v1/bulks
GET POST PUT DEL

IVR сценарийлері

Тармақталуы, сөйлеуді тануы және пернелерді басуы бар интерактивті сценарийлер құрыңыз.

/api/v1/scenarios
GET POST PUT DEL

Аудиожазбалар

MP3/WAV/OGG файлдарын немесе BASE64 жүктеңіз не мәтіннен сөйлеу синтездеңіз.

/api/v1/sounds
GET POST DEL

Flash Call

Кіріс қоңырау арқылы растау. Автокод немесе өз кодыңыз. Нәтиже 3–10 секундта.

/api/v1/flash-calls
POST

Баланс және статистика

Ағымдағы балансты, төлемдер тарихын және шығыстар детализациясын тексеріңіз.

/api/v1/balance
GET

Webhook / Callback

Әр қоңырау және таратылым мәртебесінің өзгеруі туралы хабарламаларды серверіңізге нақты уақытта алыңыз.

callback_url
CB

Аутентификация

Барлық сұрауларға Bearer токен, яғни API кілті қажет. Оны жеке кабинеттің API бөлімінде жасаңыз. Кілттер бірнешеу болуы мүмкін, мысалы, әр жобаға жеке кілт.

Кілтті қорғалған жерде сақтаңыз. Кілт жария болса, зиянды шектеу үшін оған тек қажетті API әдістерін және тек серверлеріңіздің мекенжайларын рұқсат етуге болады.

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

Негізгі URL

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

5 минутта үш қадам

1-қадам — Контакт базасын құрыңыз
POST
/api/v1/lists
{
  "name": "Клиенттер мамыр 2025",
  "numbers": ["+77001234567", "+77089876543"]
}
← 201 { "id": 1234, "count": 2 }
2-қадам — Қоңырау науқанын іске қосыңыз
POST
/api/v1/autocalls
{
  "name": "Акция: 20% жеңілдік",
  "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" }
3-қадам — Нәтижелерді алыңыз
GET
/api/v1/autocalls/9999012
← 200 OK
{
  "id": 99012,
  "status": "completed",
  "processed_percentage": 100,
  "success": 612,
  "no_answer": 312,
  "recalled": 47,
  "busy": 29
}

Webhooks: нақты уақыттағы нәтижелер

Қоңырау науқанын немесе SMS тарату науқанын құрған кезде callback_url өрісін көрсетіңіз, сонда әр науқан аяқталғаннан кейін жүйе серверіңізге толық деректері бар POST сұрауын жібереді.

Сондай-ақ mid-call webhook бар: IVR сценарийіндегі request нодасы қоңырау кезінде HTTP POST жасайды, бұл CRM жүйеңіздегі динамикалық деректер үшін ыңғайлы.

Қоңырау мәртебелері
success Жауап беріп, тыңдады
recalled Өзі кері қоңырау шалды (тегін)
no_answer Жауап бермеді
busy Бос емес
error Қосылу қатесі
spam Спам деп анықталды
cancelled Болдырылмады
Webhook payload мысалы
POST
→ your.app/webhook
{
  "id": 99012,
  "name": "Акция: 20% жеңілдік",
  "status": "completed",
  "processed_percentage": 100,
  "success": 612,
  "recalled": 47,
  "no_answer": 312,
  "busy": 29,
  "error": 0,
  "spam": 0,
  "cancelled": 0,
  "total_duration": 18453, // секунд
  "date_start": "2025-05-17 09:00:00",
  "date_end": "2025-05-17 11:23:44"
}
API арқылы Flash Call
POST
/api/v1/flash-calls
# Автокод: жүйе жасайды
{ "number": "+77001234567", "digits": 4 }
← 201 { "code": "3910" }

# Өз кодыңыз: сіз көрсетесіз
{ "number": "+77001234567", "code": "2511" }
← 201 Created

IVR сценарийлері: нодалар

Интерактивті қоңырау науқаны нодалардан, яғни логика блоктарынан құралады. Сценарийді конструктор сияқты жинап, API немесе интерфейс арқылы жүктейсіз.

Толық құжаттама →
playback

Ойнату

Абонентке аудиофайл ойнату

dtmf

Пернені басу

0–9 пернесінің басылуын күтіп, сценарийді тармақтау

speech

Сөйлеуді тану

Жауапты танып, келесі блокқа беру

talk_detect

Жауап детекторы

Тірі адам ба, әлде автожауапбергіш пе, анықтау

record

Дауысты жазу

Абоненттің жауабын жазу (5–60 сек)

sms

Абонентке SMS

Қоңырау барысында SMS жіберу

sms_me

Операторға SMS

Қоңырау нәтижесі туралы нөміріңізге хабарлау

request

HTTP-сұрау (mid-call)

Қоңырау кезінде серверіңізге POST жіберу

dial

Қоңырауды ауыстыру

Абонентті расталған нөмірмен қосу

Эндпоинттер анықтамалығы

Барлық қолжетімді әдістердің толық кестесі

Әдіс Эндпоинт Сипаттама
GET /api/v1/autocalls Қоңырау науқандарының тізімі
POST /api/v1/autocalls Қоңырау науқанын құру
GET /api/v1/autocalls/{id} Науқан нәтижелері
PUT /api/v1/autocalls/{id} Науқанды жаңарту
DEL /api/v1/autocalls/{id} Науқанды жою
GET /api/v1/autocalls/relaunch/{id} Науқанды қайта іске қосу
POST /api/v1/autocalls/calculate Құнын есептеу
GET /api/v1/calls/{id} Нақты қоңыраудың мәліметтері
GET /api/v1/calls/recordings/{id} Сөйлесу жазбасын жүктеп алу
GET /api/v1/lists Контакт базаларының тізімі
POST /api/v1/lists База құру (10 000 нөмірге дейін)
POST /api/v1/lists/append/{id} Базаға нөмірлер қосу
DEL /api/v1/contacts/{id} Контактіні базадан жою
GET /api/v1/bulks SMS тарату науқандарының тізімі
POST /api/v1/bulks SMS тарату науқанын іске қосу
POST /api/v1/bulks/calculate SMS құнын есептеу
GET /api/v1/messages/{id} Нақты SMS мәртебесі
GET /api/v1/scenarios IVR сценарийлерінің тізімі
POST /api/v1/scenarios Сценарий құрастыру
PUT /api/v1/scenarios/{id} Сценарийді жаңарту
DEL /api/v1/scenarios/{id} Сценарийді жою
GET /api/v1/sounds Аудиожазбалар тізімі
POST /api/v1/sounds Аудиофайл жүктеу
DEL /api/v1/sounds/{id} Аудиофайлды жою
POST /api/v1/flash-calls Flash Call арқылы растау
GET /api/v1/balance Ағымдағы баланс
GET /api/v1/payments Төлемдер тарихы
GET /api/v1/settings Баптаулар және тарифтер

Лимиттер мен шектеулер

Бір сұраудағы контактілер 10 000-ға дейін
Қоңырау әрекеттері (max_tries) 1–4
Әрекеттер арасындағы аралық 3–120 минут
SMS ұзындығы (кириллица) 70 таңба / бөлік
SMS ұзындығы (латын) 160 таңба / бөлік
Дауысты жазу (record нодасы) 5–60 секунд
Жазу үшін үнсіздік уақыты 2–5 секунд
Flash Call коды 3 немесе 4 цифр
Нөмірлер тек Қазақстан (+7)
API токені Bearer, мерзімі өтпейді

Интеграцияға дайынсыз ба?

API кілті тіркелгеннен кейін бірден жеке кабинетте қолжетімді. Тіркелгеннен кейін балансыңызға интеграцияға жететін бонус қаражат беріледі.

Құжаттама → Тегін тіркелу