Автоматические голосовые звонки

Голосовые звонки – это инструмент массового обзвона абонентов, с целью быстро донести аудио информацию.
Аудио рассылку можно запустить как через кабинет пользователя, так и через 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"
}