Получение информации об обзвоне
Следующие методы Calls API позволяют получить информацию об обзвоне:
GET /api/calls/campaign/{token}
— подробная информация об обзвоне.GET /api/calls/campaign/{token}/status
— статус обзвона.
Подробная информация об обзвоне
Пример запроса
curl https://app.jaicp.com/api/calls/campaign/123.456.bAYxokdzmkWBZP2Tjcf4W0nzCpkC9L85mZQyd1OqJuv
Содержимое ответа
Ответ на запрос — JSON-объект с полями:
Поле | Описание |
---|---|
id | Идентификатор обзвона. |
name | Название обзвона. |
projectName | Идентификатор проекта, в котором был создан обзвон. |
creationDate | Unix-время создания обзвона в миллисекундах. |
botId | Идентификатор телефонного канала. |
status | Статус обзвона. |
shortReport | Статистические данные об обзвоне. |
startTime | Unix-время начала обзвона в миллисекундах. |
endTime | Unix-время завершения обзвона в миллисекундах. |
maxSimultaneousCalls | Число одновременных звонков в обзвоне. |
Поля объекта shortReport
:
Поле | Описание |
---|---|
totalNumbers | Общее число номеров в обзвоне. |
processedNumbers | Число обработанных номеров. |
usedTalkingTime | Сколько использовано минут телефонии. |
usedAsrSeconds | Сколько использовано минут ASR/TTS. |
inProcessCalls | Число звонков в процессе. |
retryCalls | Число повторных попыток дозвониться. |
Статус обзвона
Пример запроса
curl https://app.jaicp.com/api/calls/campaign/123.456.bAYxokdzmkWBZP2Tjcf4W0nzCpkC9L85mZQyd1OqJuv/status
Содержимое ответа
Ответ на запрос — строка, обозначающая статус обзвона:
Значение | Статус обзвона |
---|---|
planned | Запланирован. |
inProcess | В процессе. |
finished | Завершен. |
paused | Приостановлен. |
deleted | Удален. |