Ringostat
Вхід

Вебхуки: результати дзвінків

~5 хв · Коли надсилається звіт, payload, авторизація Basic/OAuth 2.0 і доставка.

Після кожного завершеного дзвінка Ringostat надсилає звіт на ваш URL. Вкажіть його в кампанії → блок «Webhook і звіти» (або webhookURL у voiceagent_create_campaign).

«Коли надсилати webhook»: all — кожен дзвінок (за замовчуванням); answered — лише дзвінки з відповіддю; interaction — дзвінки, де людина натиснула клавішу або, в кампаніях з AI-агентом, говорила. Номер, що вичерпав усі спроби, надсилається лише з all.

За замовчуванням це POST з Content-Type: application/json і тілом JSON-RPC 2.0: method завжди callCompleted, дані дзвінка — в params.

POST https://your-app.example/webhooks/ringostat
Content-Type: application/json

{ "jsonrpc":"2.0", "method":"callCompleted", "id":1760437456000000000,
  "params":{ "campaign_id":799, "campaign_name":"Підтвердження замовлень",
    "number_id":1001, "phone_number":"+380671234567", "status":"completed",
    "start_time":1760437400, "answered_time":1760437408, "end_time":1760437456,
    "duration":56, "connected_duration":48, "wait_time":8,
    "custom_fields":{"name":"Іван"}, "dtmf_responses":[],
    "voicemail_detected":false, "transferred_to":"",
    "aisdr_final_response":{ … } } }

status: completed, answered, transferred, voicemail, abandoned, failed або retry. Час — Unix-секунди, тривалості — у секундах. aisdr_final_response — структурований звіт дзвінка AI-агента (aisdr), його ключі задають налаштування звіту кампанії. Номер, що вичерпав спроби, приходить зі status failed і полями attempt_count та max_attempts. Запису розмови в payload немає: його повертає voiceagent_get_call_detail.

Для кампаній з AI-агентом у payload є ще tools: останній успішний результат кожного інструмента, який агент викликав у розмові, за його назвою. Так у вебхук потрапляє, наприклад, номер бронювання Servio HMS чи номер створеного замовлення. Невдалі виклики й відмови сюди не потрапляють; якщо інструмент не викликався, його ключа немає.

"tools": {
  "servio_create_booking": { "ok": true, "booking_id": "100245",
    "payment_link": "https://pay.example.com/booking?account=100245", … } }

У власному шаблоні тіла звертайтеся до них так: {{tools.<інструмент>.<поле>}}. Додавайте ? в кінці, якщо інструмент могли не викликати: тоді поле буде null, а без ? вебхук такого дзвінка не надішлеться. Тестовий запит з кабінету не має результатів інструментів: поле з ? там буде null, а поле без ? — зразок <sample: tools…>.

{"phone":"{{phone_number}}","booking":"{{tools.servio_create_booking.booking_id?}}",
 "payment":"{{tools.servio_create_booking.payment_link?}}"}

Так само працює будь-який інструмент інтеграції. Наприклад, ТТН Нової пошти, створена під час дзвінка: nova_poshta_create_waybill повертає ttn, delivery_cost, estimated_delivery_date, warehouse і city.

{"phone":"{{phone_number}}","ttn":"{{tools.nova_poshta_create_waybill.ttn?}}",
 "delivery_date":"{{tools.nova_poshta_create_waybill.estimated_delivery_date?}}"}
Запити не підписуються. Щоб автентифікувати їх, оберіть HTTP Basic або OAuth 2.0 у розділі «Авторизація» блоку «Webhook і звіти» (адміністратори проекту). Там само можна змінити метод на PUT чи PATCH і замінити тіло своїм шаблоном JSON або form. Вебхук з авторизацією потребує https-URL і не переходить за редиректами.
Відповідайте 2xx за 30 секунд (20 секунд з Basic чи OAuth 2.0). Невдала доставка не повторюється, крім одного повтору після OAuth 401. Кожна спроба видна в картці дзвінка → «Доставка вебхука»; надіслати звіт ще раз — кнопкою «Перевідправити вебхук» або voiceagent_resend_call_webhook. Дублі відсікайте за number_id + end_time.