Это API позволяет получать информацию по избранным звонкам: как только приходит новый звонок, удовлетворяющий фильтрам отчета, система отправляет информацию по звонку на указанный сервер.

Схема работы с API:

  1. Получить список отчетов через метод /reports
  2. Выбрать нужные отчеты и создать по ним триггеры с помощью метода /reports/trigger, указав при этом номер отчета и url-адрес, на который будут отправляться POST-запросы с данными о звонках.
  3. Принимать и обрабатывать сообщения со звонками.

Список отчетов

GET /api/v1/project/{id проекта}/reports

Пример ответа:

{
   "reports":[
      {
         "columns":[...],
         "filters":{},
         "frozen":false,
         "id":98415669,
         "name":"Лояльность клиентов",
         "phrase_filters":[],
         "rating_template_id":42074243,
         "slices":[
            "rating"
         ]
      },
      {
         "columns":[...],
         "filters":{},
         "frozen":false,
         "id":63306199,
         "name":"Качество работы операторов",
         "phrase_filters":[],
         "rating_template_id":38878185,
         "slices":[...]
      },
   ...
}

Ответ содержит информацию о всех параметрах и фильтрах отчета, нам же нужно отсюда только name и id(название отчета и его идентификатор).

Создание подписок на триггеры

POST /api/v1/project/{id проекта}/reports/trigger

Метод принимает json-объект с параметрами:

report_id - идентификатор отчета
endpoint_url - url на который будут отправляться звонки

Пример запроса:

{"report_id":80286776, "endpoint_url":"<http://example.com:5001/calls>"}

Список созданных подписок на триггеры

GET /api/v1/project/{id проекта}/reports/triggers