Отчеты по обзвонам

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

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

Тело запроса

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

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

подсказка

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

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

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

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

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

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

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

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