Ringostat API: описание, настройка и интеграция

Ringostat API (application programming interface) — это набор готовых средств (классов, процедур, функций) доступа, взаимодействия и управления, предоставляемых Ringostat для использования во внешних программных продуктах (CRM-системы, системы статистики и аналитики и т.п.).

Используя интеграцию с Ringostat по API у вас появляются возможности самостоятельно отправлять нужные запросы нам на сервер или вызывать определенные события.


Для настройки интеграции с Ringostat по API, необходимо сформировать запрос и указать нужные Вам параметры.
Общие данные необходимые для интеграции:

  • Адрес Ringostat APIhttps://api.ringostat.com
  • Доступ к Ringostat API — с помощью Project ID и token.

Project ID — это идентификатор проекта в системе Ringostat;
token (авторизации) — являются ключом для доступа к проекту в системе Ringostat;

Где найти Project ID и token?

Для того, чтобы получить Project ID и token, нужно перейти в раздел “Интеграции” - “Alytics” и скопировать данные:


Давайте рассмотрим несколько реализаций API-интеграции с CRM, которая будет вам полезной:

    1. Выгрузка статистики по звонкам в CRM.

Всего существует 29 параметров, которые вы можете экспортировать из журнала звонков в удобном для вас формате. Данную выгрузку можно использовать для дальнейшего импорта в нужную систему.

Возможные параметры, их описание, значения и примеры

Параметры:

  • формат взаимодействия с API: json или csv;
  • метод отправки данных к API: GET;
  • project_id — это идентификатор проекта в системе Ringostat;
  • token — являются ключом для доступа к проекту в системе Ringostat.
Имя параметра Описание Формат Возможные значения Значение по умолчанию
project_id Идентификатор проекта в системе Ringostat число нет
token Авторизационный токен строка нет
export_type Формат выгрузки одно из возможных значений csv, json json
from Начальные дата и время экспорта дата и время в формате 'YYYY-MM-DD HH:MM:SS' значение параметра "to" минус 24 часа
to Конечные дата и время экспорта дата и время в формате 'YYYY-MM-DD HH:MM:SS' текущие дата и время
fields Перечень необходимых полей для выборки одно или несколько возможных значений, разделенных запятыми
caller Номер звонящего calldate,caller,dst
dst
Куда звонили
disposition Статус
calldate Дата
category_mark Ценность
duration Длительность
call_type Тип
waittime Ожидание
billsec Разговор
connected_with С кем соединен
call_counter Какой по счету звонок
proper_flag Целевой
repeated_flag Повторный
utm_source Источник
utm_medium Канал
utm_campaign Кампания
utm_content Содержание объявления
utm_term Ключевое слово
region Регион
uniqueid id звонка
category_number Категория звонка
caller_region Регион звонящего
employee_number Код сотрудника
employee_mark Оценка сотрудника
client_id UUID посетителя
remote_ip IP посетителя
refferrer Откуда пришел посетитель
landing На какую страницу пришел
recording Ссылка на аудиозапись
filters Фильтры один или несколько фильтров, разделенных запятыми. Фильтр состоит из имени поля, символа сравниния и значением в соответствующей последовательности. Литерал регулярного выражения должен быть закодирован в base64.
> больше нет
< меньше
>= больше, либо равно
<= меньше, либо равно
= равно
<> не равно
~ регулярное выражение
merge Объединение по номеру звонящего одно из возможных значений:
0 - не объединять
1 - объединять за каждые сутки
2 - объединить за все время экспорта
0, 1, 2 0
order Сортировка одна или несколько сортировок, разделенных запятыми.
Сортировка состоит из имени поля и направлению сортировки через пробел.
asc по возрастанию calldate asc
desc по убыванию

Давайте рассмотрим несколько примеров:

Запрос:

https://api.ringostat.com/calls/export?project_id=999&token=be6d748913ccb22f2bv555555555c
&export_type=json&from=2016-05-05%2010:00:00&to=2015-06-06%2010:00:00
&fields=caller,disposition,calldate,duration&merge=1&order=calldate%20asc

Результат:

Запрос:

https://api.ringostat.com/calls/export?project_id=999&token=be6d748913ccb22f2bv555555555c
&export_type=json&from=2016-06-02%2000:00:00&to=2016-06-08%2000:00:00
&fields=caller,dst,connected_with,utm_source,utm_medium,remote_ip,recording&merge=1
&order=calldate%20asc

Результат:

Запрос:

https://api.ringostat.com/calls/export?project_id=999&token=be6d748913ccb22f2bv555555555c
&export_type=json&from=2016-05-05%2000:00:00&to=2016-06-06%2010:00:00
&fields=disposition,calldate,refferrer&filters=duration<10

Результат:

    2. Звонок клиенту после отправки формы заказа.

Для оперативности обработки заявок от клиентов, вы можете настроить автоматический перезвон клиенту, который отправляет заполненную форму регистрации или заказа на вашем сайте. Аналогично можно инициировать звонок из карточки клиента в вашей CRM.

Возможные параметры, их описание и пример
Параметры:
  • метод отправки данных к API:  POST;
  • project_id — это идентификатор проекта в системе Ringostat;
  • token — являются ключом для доступа к проекту в системе Ringostat;
  • extension — номер в международном формате или sip-аккаунт с которого звонить (номер должен быть подключен в проект как "входящий", в раздел "Подключение номеров");
  • destination — номер в международном формате на который звонить.

Параметры project_id и token должны быть в URL-е, остальные в теле пост запроса.

Пример готового запроса:

https://api.ringostat.com/callback/outbound_call?project_id=999&token=be6d748913ccb22f2bv555555555c
extension=380441111111
destination=380442222222

    3. Проверка доступности sip-аккаунтов менеджеров.

Данный метод позволяет в крупном отделе продаж контролировать менеджеров в системе и проверять кто из них разговаривает. Эту информацию можно использовать для распределения звонков между менеджерами.

  • Узнать какие SIP aккаунты по проекту онлайн. 
Возможные параметры, их описание и пример

Данный метод позволит определить какие sip-аккаунты активны.

Параметры:
  • формат взаимодействия с API: json;
  • метод отправки данных к API: GET;
  • project_id — это идентификатор проекта в системе Ringostat;
  • token — являются ключом для доступа к системе Ringostat.

Пример готовой ссылки:

https://api.ringostat.com/sipstatus/siponline?project_id=999&token=be6d748913ccb22f2bv555555555c

Результат:

Возвращает массив в формате JSON sip-аккаунтов менеджеров проекта, которые в данный момент on-line.

  • Узнать какие SIP aккаунты по проекту разговаривают.
Возможные параметры, их описание и пример

Данный метод позволит определить какие sip-аккаунты не заняты.

Параметры:
  • формат взаимодействия с API: json;
  • метод отправки данных к API: GET;
  • project_id — это идентификатор проекта в системе Ringostat;
  • token — являются ключом для доступа к системе Ringostat.

Пример готовой ссылки:

https://api.ringostat.com/sipstatus/speakingNow?project_id=999&token=be6d748913ccb22f2bv555555555c

Результат:


Возвращает массив в формате JSON sip-аккаунтов менеджеров проекта, которые в данный момент разговаривают.

Если в процессе установки или использования у Вас возникли сложности – спросите нас и Ваш вопрос будет решён в самые короткие сроки :)

Была ли статья полезной?