JAICP

Отчеты по обзвону


Следующие методы Calls API позволяют получить отчёт в формате JSON:

  • POST /api/calls/campaign/{token}/callJob/getReport — отчет по номерам.
  • POST /api/calls/campaign/{token}/callAttempt/getReport — отчет по попыткам.

Тело запроса

В теле запроса к данному методу передается JSON с любым из следующих полей:

  • phones — массив номеров, по которым нужно получить отчет.
  • ids — идентификаторы заданий на обзвон, по которым требуется отчет.

Вы также можете передать оба поля одновременно.


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

curl --request POST 'https://app.jaicp.com/api/calls/campaign/8231.7056.1b131df1/callJob/getReport' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phones": [
        79110000000
    ],
    "ids": [
        12345,
        67890
    ]
}'

Содержимое отчета

Ответ на запрос — массив объектов с полями, содержащими информацию по заданиям на обзвон или попыткам их выполнить. Приведем некоторые из них:

  • startedAt и finishedAt — Unix-время начала и окончания звонка в миллисекундах.
  • callDuration — продолжительность звонка в секундах.
  • callResultрезультат звонка.
  • reportData — данные, зафиксированные в сценарии методом $dialer.reportData.
  • jobStatusстатус задания на обзвон в момент формирования отчета.

Статусы заданий на обзвон


Значение поля Описание
canceled Звонок был отменен.
inProcess Звонок в процессе.
longCallWithNoResult Звонок завершен без результата.
longCallWithResult Звонок завершен с результатом.
noAnswer Все попытки дозвониться закончились без ответа абонента.
nonexistentNumber Звонок был совершен на несуществующий номер.
notDone Звонок не был совершен, но обзвон завершен.
onRetry Идет повторная попытка дозвониться.
planned Звонок находится в очереди: например, ждет доступных линий.