Calls API

Платформа JAICP предоставляет Calls API для работы с телефонией.

API предоставляет возможность:

Добавить телефонные номера с параметрами в рассылку.
Получить отчет по ID задания на обзвон.
Получить отчет по номеру телефона в рамках одной рассылки.

Перед началом работы с Calls API необходимо:

Методы API

Подробное описание Calls API: методы, параметры запроса, форматы ответа, примеры, возвращаемые ошибки >

Контроль доступа проверяется только по токену рассылки.

API предоставляет следующие методы:

Метод	Описание
`POST https://<host_name>/api/calls/campaign/{token}/addPhones`	Добавление телефонных номеров с параметрами в рассылку.
`POST https://<host_name>/api/calls/campaign/{token}/callJob/getReport`	Получение отчета `json` по номерам.
`POST https://<host_name>/api/calls/campaign/{token}/callAttempt/getReport`	Получение отчета `json` по попыткам дозвониться.
`POST https://<host_name>/api/calls/campaign/{token}/callJob/cancel`	Отмена новых звонков по номеру телефона или ID задания на обзвон. Обратите внимание, что отменить можно только звонки для номеров, которые добавлены при помощи Calls API.
`POST https://<host_name>/api/calls/campaign/{token}/control/start`	Запуск созданной голосовой рассылки.
`POST https://<host_name>/api/calls/campaign/{token}/control/pause`	Приостановление голосовой рассылки.
`POST https://<host_name>/api/calls/campaign/{token}/control/resume`	Возобновление приостановленной голосовой рассылки.
`POST https://<host_name>/api/calls/campaign/{token}/control/stop`	Остановка голосовой рассылки.

host_name вы можете скопировать из адресной строки, оно формируется следующим образом http://<host_name>.just-ai.com/.

Например, для https://zb04.just-ai.com/ метод добавления телефонных номеров будет выглядеть следующим образом:

https://zb04.just-ai.com/api/calls/campaign/123456.789.mBoMyfZLZqKHIPKjFjWYfRw9hgfIV9InFC4bHGVw5ND/addPhones

Токен конфигурируется при создании голосовой рассылки в платформе. Чтобы скопировать токен, перейдите к списку рассылок > нажмите иконку напротив названия рассылки > Копировать токен в буфер.

При добавлении телефонного номера в очередь определенной рассылки создается задание на обзвон с уникальным ID. При этом, если телефонный номер повторно добавлен в эту же рассылку будет создано новое задание на обзвон с другим ID.

Обратите внимание, что отчет о совершенных звонках будет содержать информацию о дате, длительности, результате звонка, а также все сведения, зафиксированные в сценарии методом $dialer.reportData($header, $value, $order).

Определение политики звонка через Calls API

При добавлении номера в рассылку при помощи API вы можете также задать индивидуальные параметры звонка.

Для этого при вызове метода addPhones в теле запроса передайте параметры CallJobParameters.

Если параметры не были переданы, номер добавляется в очередь, и звонки идут в общем порядке. При добавлении номера с параметрами индивидуальной политики, его приоритет относительно других номеров повышается согласно политике звонков.

Подробнее о политике звонков

Статусы звонков

В ответе API поле jobStatus описывает состояние номера для каждого звонка в момент формирования отчета.

Значение поля	Описание
`longСallWithResult`	Звонок завершен с результатом.
`longCallWithNoResult`	Звонок завершен без результата.
`noAnswer`	Все попытки звонков закончились без ответа абонента.
`planned`	Звонок находится в очереди, например, ждет доступных линий.
`notDone`	Статус будет проставлен, если рассылка завершена, но при этом не было совершено ни одного звонка. Например, рассылку завершили вручную.
`inProcess`	Идет дозвон или разговор с абонентом.
`onRetry`	Повторная попытка.
`canceled`	Статус проставляется, если звонки были отменены по Calls API.
`nonexistentNumber`	Статус проставляется, если звонок был совершен на несуществующий номер.