Ringostat API (Application Programming Interface) – це набір готових засобів для використання у зовнішніх програмних продуктах (CRM-системах, системах статистики та аналітики тощо).
З інтеграцією по Ringostat API з'явиться можливість самостійно надсилати потрібні запити нам на сервер або викликати певні події.
У цій документації ви знайдете опис методів, за допомогою яких зможете вирішити необхідні для вашого бізнесу завдання. Наприклад, наступні:
у будь-який зручний момент отримати понад 30 параметрів за дзвінками, включаючи дані по коллтрекінгу;
звертатися до вашого проекту для перевірки номера абонента
ініціювати дзвінок між двома напрямами (простий метод Callback) використовується для ініціювання дзвінків із CRM-системи (якщо вона дозволяє і один з напрямків - це SIP-аккаунт або номер у проекті);
ініціювати дзвінок між двома напрямами (розширений метод Callback) використовується для реалізації власного віджета зворотнього дзвінка;
перевірити доступність SIP-акаунта (створеного в рамках проекту) у відповідь на запит буде надіслано масив логінів SIP-акаунтів, які на момент перевірки знаходяться в мережі (online);
перевірити активність SIP-акаунта (створеного в рамках проекту)
у відповідь на запит буде надіслано масив логінів SIP-акаунтів, які на момент перевірки беруть участь у розмові (вхідний або вихідний дзвінок).
Доступ до методів API
Доступ до API-методів Ringostat можливий лише за наявності унікального ключа авторизації Auth-key . Ключ авторизації має бути переданий як додатковий заголовок (header) HTTP-запиту.
Ключ авторизації доступний в особистому кабінеті Ringostat, на сторінці Налаштування -> Інтеграція -> Ringostat API:
Якщо заголовок Auth-key буде проігноровано або передано з помилкою, запит поверне неуспішний статус код 401 Unauthorized та помилку Cross-Origin Resource Sharing (CORS)