Ringostat
Вхід

API і вебхуки

~5 хв · Результати дзвінків у вашу CRM і ключ API для розробника.
Що отримаєте:
результати дзвінків автоматично потрапляють у вашу CRM чи іншу систему, а кампаніями можна керувати без інтерфейсу.
Що потрібно заздалегідь:
URL, який приймає POST-запити з JSON; для ключа API — права адміністратора проєкту і розробник або сервіс автоматизації.

1. Налаштуйте дані для передачі

У картці «Витягування даних» редактора кампанії задайте поля, які агент витягує з розмови: бюджет, зацікавленість, дата зворотного дзвінка тощо. Саме вони прийдуть у вебхуку та в CRM. Детальніше — у гайді «Розширені налаштування кампанії».

Витягування даних
Витягування даних

2. Підключіть вебхук

  1. 1
    Редактор кампанії → картка «Webhook і звіти».
    Налаштування вебхука
    Налаштування вебхука
  2. 2
    Вставте адресу в поле «URL для відправки вебхука».
  3. 3
    У полі «Коли надсилати webhook» оберіть, для яких дзвінків надсилати.
  4. 4
    Збережіть кампанію.

Після кожного завершеного дзвінка на цю адресу приходить JSON з результатом і витягнутими даними; campaign_id і campaign_name в ньому допоможуть розрізнити кампанії. Щоб перевірити адресу, натисніть «Зберегти налаштування вебхука», а потім «Надіслати тестовий запит»: на неї прийдуть синтетичні дані дзвінка.

3. Створіть ключ API

  1. 1
    Ліве меню → «Налаштування» → блок «Розширені налаштування». Його бачать лише адміністратори проєкту.
  2. 2
    Натисніть «+ Створити новий ключ» і за бажанням дайте йому назву.
    Ключі API
    Ключі API
  3. 3
    Скопіюйте ключ і передайте розробнику. Ключ показується лише один раз.

Ключ передається в заголовку X-API-Key у запитах до JSON-RPC API платформи. Приклад запиту — на тій самій сторінці, під заголовком «Використання».

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

Ідентифікатор проєкту

«ID проекту» потрібен у запитах до API. Він є в «Налаштуваннях» → «Розширені налаштування», поруч — кнопка копіювання.

ID проєкту
ID проєкту
Ключ API діє від імені адміністратора, який його створив, у межах одного проєкту: з ним можна робити в проєкті все, що може цей адміністратор. Не публікуйте ключ і створюйте окремий для кожної інтеграції.

Що далі