Автоматичні голосові дзвінки

Голосові дзвінки – це інструмент масового обдзвону абонентів, з метою швидко донести аудіо інформацію.
Аудіо розсилку можна запустити як через кабінет користувача, так і через JSON API.

URI: /api/voice.php

Усі запити до API надсилаються у форматі JSON за допомогою методу POST.

Параметри заголовків

У запитах обов'язково має бути заголовок Content-Type: multipart/form-data.

Параметри запиту

keystringобов'язковий Ваш API-ключ, який можна отримати в особистому кабінеті

phonestringобов'язковий Номер телефону одержувача дзвінка

voicefileобов'язковий Прикріплений аудіофайл, який буде відтворюватися під час дзвінка

hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

dtmfboolean Ознака використання тонального набору (DTMF)

Приклад запиту

curl -L -X POST 'https://endpoint.net/api/voice.php' \
-F 'key="bb56a4369eb19***cfec6d1776bd25"' \
-F 'phone="380501234567" \
-F 'voice=@"audio.wav"' \
-F 'hook="https://webhook.url/webhook.php?id=123456"' \
-F 'dtmf=true'

Параметри відповіді

idinteger Результат виконання запиту

pricestring Вартість дзвінка

phonestring Номер телефону одержувача дзвінка

statusstring Статус завершеного дзвінка

durationstring Тривалість дзвінка

dtmfstring Код, який набрав абонент під час дзвінка

Приклади відповіді

Успішний

HTTP Status Code: 200
Content Type: JSON application/json

{
    "id": 100500,
    "price": 0.4
}

API ключ не передано

HTTP Status Code: 200
Content Type: JSON application/json

{
    "errors": [
        "API key missing"
    ]
}

Вебхук

HTTP Status Code: 200
Content Type: JSON application/json

{
    "id": 100500,
    "phone": "380501234567",
    "status": "ANSWERED",
    "duration": 123,
    "dtmf": "7"
}