GetInfo

Метод GetInfo

Примените метод GetInfo для получения информации о звонках, используя их идентификаторы. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/statistics/call-history/v2/GetInfo

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, выделенные жирным шрифтом, обязательны.

Параметр Тип Описание
call_id uint64 уникальные идентификаторы звонков

Выходные параметры

Параметр Тип Описание
call_id uint64 идентификатор звонка
service string ServiceType услуга, в рамках которой совершён звонок
application_uuid string идентификатор приложения, с/на номер которого совершён звонок
start_time timestamp дата и время начала звонка UTC
end_time timestamp дата и время окончания звонка UTC
from string номер-инициатор звонка
to string номер принимающего абонента
status string общий статус звонка: UNSPECIFIED — не определён, ANSWERED — ответ, BUSY — занят, NO_ANSWER — нет ответа, CANCELED — отменен, REJECTED — вызов сброшен/отклонён, ERROR — ошибка
direction string направление звонка: UNSPECIFIED — не определён, OUTBOUND — исходящий, INBOUND — входящий
duration uint32 полная длительность звонка в сек от момента инициации до завершения
redirect_type string тип переадресации, только для услуг REDIRECT, SIP_REDIRECT, IPCR. 1 — одиночная, 2 — последовательная, 3 — параллельная
black_list boolean признак наличия номера звонящего в чёрном списке, только для услуг REDIRECT, SIP_REDIRECT, IPCR. True — номер в чёрном списке. False — номера нет в чёрном списке
reserve boolean признак переадресации на резервный номер, только для услуг REDIRECT, SIP_REDIRECT, IPCR. True — звонок переадресован на резервный номер. False — звонок не переадресован на резервный номер
legs структура Legs информация о ходе звонка на каждом плече
record_call boolean признак, показывающий, подключена ли услуга записи разговора на номере. True — услуга подключена. False — услуга не подключена
voice_record_exist boolean признак готовности записи разговора. True — запись разговора готова для прослушивания и скачивания. False — запись разговора не готова для прослушивания и скачивания
transcribe boolean признак, показывающий, подключена ли услуга текстовой расшифровки аудиозаписи разговора на номере. True — услуга подключена. False — услуга не подключена
transcribations_record_exist boolean признак готовности текстовой расшифровки аудиозаписи разговора. True — расшифровка готова для скачивания. False — расшифровка не готова для скачивания
speech_analytics boolean признак, показывающий, подключена ли услуга речевой аналитики разговора на номере. True — услуга подключена. False — услуга не подключена
speech_analytics_exist boolean признак готовности результатов речевой аналитики разговора. True — речевая аналитика готова. False — речевая не аналитика готова
detection boolean признак, показывающий, подключена ли услуга детектирования автоответчика на номере. True — услуга подключена. False — услуга не подключена
voice_detection_exist boolean признак разрыва соединения по причине обнаруженного автоответчика. True — звонок завершён из-за обнаруженного автоответчика. False — автоответчик не обнаружен

ServiceType

Параметр Значение Описание
0 UNSPECIFIED услуга не определена
1 IPCR услуга динамической переадресации по API
3 VOICE_MESSAGE услуга голосового SMS
4 REDIRECT услуга переадресации на номер
5 SIP услуга SIP
6 SIP_REDIRECT услуга переадресации на SIP

Legs

Параметр Тип Описание
start_time timestamp дата и время начала звонка UTC
end_time timestamp дата и время окончания звонка UTC
from string номер-инициатор звонка
to string номер принимающего абонента
status string статус вызова данного плеча
setup_time uint32 время установки соединения в сек
wait_time uint32 время ожидания соединения в сек, совпадает с setup_time
talk_time uint32 длительность разговора в сек
duration uint32 общая длительность в сек по данному плечу с учётом гудков, ожидания, разговора
cause_code uint32 код причины отбоя

Коды причин отбоя

Код Статус Описание
1 rejected UNALLOCATED_NUMBER вызов отменён — номер получателя не найден, формат верный
2 rejected NO_ROUTE_TRANSIT_NET вызов отменён — нет маршрута к указанной транзитной сети
3 rejected NO_ROUTE_DESTINATION вызов отменён — нет маршрута до указанного номера
21 rejected CALL_REJECTED вызов отклонён
17 busy USER_BUSY вызываемый номер занят
18 no_answer NO_USER_RESPONSE нет ответа
19 no_answer NO_ANSWER нет сигнализации от пользователя, нет ответа
20 no_answer SUBSCRIBER_ABSENT нет ответа
41 no_answer NORMAL_TEMPORARY_FAILURE временная неработоспособность
502 no_answer LOSE_RACE нет ответа
487 canceled ORIGINATOR_CANCEL вызов отменён звонящим
16 completed NORMAL_CLEARING нормальное завершение вызова
604 completed MEDIA_TIMEOUT нормальное завершение вызова

Возможные ошибки

Код Статус Пример сообщения Описание
400 Bad Request invalid uuid format неправильный формат в параметре запроса
400 Bad Request invalid value значения параметра невалидно
401 Unauthorized malformed token не указан / неправильно указан API-ключ приложения

Примеры

Входные параметры:

{
   "call_id": [
       7013203421000674336
   ]
}

Выходные параметры:

{
   "call_id": "7116111127119111116",
   "service": "ipcr_redirect",
   "application_uuid": "1111e1cd-1d48-1ada-bbbf-1111110bd1c6",
   "start_time": "2025-01-01T07:22:19.066Z",
   "end_time": "2025-01-01T07:22:50.150Z",
   "from": "79111111118",
   "to": "79801111111",
   "status": "answered",
   "direction": "inbound",
   "duration": 31,
   "redirect_type": "1",
   "black_list": false,
   "legs": [
       {
           "start_time": "2025-01-01T07:22:27.503Z",
           "end_time": "2025-01-01T07:22:50.150Z",
           "from": "79801111111",
           "to": "79101110112",
           "status": "answered",
           "setup_time": 20,
           "wait_time": 20,
           "talk_time": 11,
           "duration": 31,
           "cause_code": 16
       }
   ],
   "record_call": true,
   "voice_record_exist": true,
   "transcribe": false,
   "transcribations_record_exist": false,
   "speech_analytics": true,
   "speech_analytics_exist": true,
   "detection": false,	
   "voice_detection_exist": false
}

Содержание статьи