Ringostat API (Application Programming Interface) — это набор готовых средств для использования во внешних программных продуктах (CRM-системы, системы статистики и аналитики и т.п.).
Используя интеграцию с Ringostat по API у вас появляются возможности самостоятельно отправлять нужные запросы нам на сервер или вызывать определенные события.
В данной документации вы найдете описание методов, с помощью которых сможете решить необходимые для вашего бизнеса задачи. Например, такие как:
в любой удобный момент получить свыше 30 параметров по звонкам, включая данные по коллтрекингу;
обращаться в ваш проект для проверки номера звонящего
при реализации собственной логики переадресации звонков;инициациировать звонок между 2мя направлениями (простой метод)
используется для инициирования звонков из CRM-системы (если она позволяет и 1но из направлений — это SIP-аккаунт или номер в проекте);инициациировать звонок между 2мя направлениями (расширенный метод)
используется при реализации собственного виджета обратного звонка;проверить доступность SIP-аккаунта (созданного в рамках проекта)
в ответ на запрос будет отправлен массив логинов SIP-аккаунтов, которые на момент проверки находятся в сети (online);проверить активность SIP-аккаунта (созданного в рамках проекта)
в ответ на запрос будет отправлен массив логинов SIP-аккаунтов, на момент проверки участвуют в разговоре (входящий или исходящий звонок);
Доступ к методам API
Доступ к API-методам Ringostat возможен только при наличии уникального ключа авторизации Auth-key
Ключ авторизации должен быть передан как дополнительный заголовок (header) HTTP-Запроса.
Ключ авторизации доступен в личном кабинете Ringostat, на странице Настройки
-> Интеграция -> Ringostat API:
Если заголовок Auth-key будет проигнорирован или передан с ошибкой, запрос вернёт неуспешный статус код 401 Unauthorized и ошибку Cross-Origin Resource Sharing (CORS)