GetList

Метод GetList

Примените метод GetList для получения истории звонков за определённый период по заданным параметрам.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

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

Авторизация

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

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

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

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

ПараметрТипОписание
date_fromstringдата начала выборки звонков в формате RFC-3339 / ISO-8601
date_tostringдата окончания выборки звонков в формате RFC-3339 / ISO-8601
limituint32лимит выводимых строк
offsetuint64номер строки, с которой начинать выборку (начинается с 0)
fromstringпоиск по номеру звонящего абонента
tostringпоиск по номеру принимающего абонента
statusarray StatusTypeпоиск по общему статусу звонка
directionarray DirectionTypeпоиск по направлению звонка
servicearray ServiceTypeпоиск по услуге, в рамках которой совершён звонок
duration_fromuint32поиск по длительности вызова в секундах, min duration
duration_touint32поиск по длительности вызова в секундах, max duration

StatusType

ПараметрЗначение
0статус не определён
1абонент занят
2нет ответа
3отменён
4сброшен/отклонён
5принят
6ошибка

ServiceType

ПараметрЗначение
0услуга не определена
1услуга динамической переадресации по API
3услуга голосового SMS (автообзвон)
4услуга переадресации входящего звонка на номер
5услуга исходящий вызов через SIP
6услуга переадресации входящего звонка на SIP
9услуга звонков с помощью робота
10услуга карусели

DirectionType

ПараметрЗначение
0направление не определено
1входящее направление
3исходящее направление

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

ПараметрТипОписание
callsCallsинформация о звонках

Calls

ПараметрТипОписание
call_iduint64идентификатор звонка
servicestring Serviceуслуга, в рамках которой совершён звонок
application_uuidstringидентификатор приложения, с/на номер которого совершён звонок
start_timetimestampдата и время начала звонка UTC
end_timetimestampдата и время окончания звонка UTC
fromstringномер-инициатор звонка
tostringномер принимающего абонента
statusstring Statusобщий статус звонка
directionstring Directionнаправление звонка
durationuint32полная длительность звонка в сек от момента инициации до завершения
redirect_typestringтип переадресации, только для услуг REDIRECT, SIP_REDIRECT, IPCR. 1 — одиночная, 2 — последовательная, 3 — параллельная
black_listbooleanпризнак наличия номера звонящего в чёрном списке, только для услуг REDIRECT, SIP_REDIRECT, IPCR. True — номер в чёрном списке. False — номера нет в чёрном списке
reservebooleanпризнак переадресации на резервный номер, только для услуг REDIRECT, SIP_REDIRECT, IPCR. True — звонок переадресован на резервный номер. False — звонок не переадресован на резервный номер
legsструктура Legsинформация о ходе звонка на каждом плече
record_callbooleanпризнак, показывающий, подключена ли услуга записи разговора на номере. True — услуга подключена. False — услуга не подключена
voice_record_existbooleanпризнак готовности записи разговора. True — запись разговора готова для прослушивания и скачивания. False — запись разговора не готова для прослушивания и скачивания
transcribebooleanпризнак, показывающий, подключена ли услуга текстовой расшифровки аудиозаписи разговора на номере. True — услуга подключена. False — услуга не подключена
transcribations_record_existbooleanпризнак готовности текстовой расшифровки аудиозаписи разговора. True — расшифровка готова для скачивания. False — расшифровка не готова для скачивания
speech_analyticsbooleanпризнак, показывающий, подключена ли услуга речевой аналитики разговора на номере. True — услуга подключена. False — услуга не подключена
speech_analytics_existbooleanпризнак готовности результатов речевой аналитики разговора. True — речевая аналитика готова. False — речевая не аналитика готова
detectionbooleanпризнак, показывающий, подключена ли услуга детектирования автоответчика на номере. True — услуга подключена. False — услуга не подключена
voice_detection_existbooleanпризнак разрыва соединения по причине обнаруженного автоответчика. True — звонок завершён из-за обнаруженного автоответчика. False — автоответчик не обнаружен

Status

ПараметрЗначение
unspecifiedстатус не определён
busyабонент занят
no_answerнет ответа
canceledотменён
rejectedсброшен/отклонён
answeredпринят
errorошибка

Direction

ПараметрЗначение
unspecifiedнаправление не определено
inboundвходящее направление
outboundисходящее направление

Service

ПараметрЗначение
unspecifiedуслуга не определена
ipcr_redirectуслуга динамической переадресации по API
voice_messageуслуга голосового SMS
redirectуслуга переадресации входящего звонка на номер
sipисходящий вызов через SIP
sip_redirectуслуга переадресации входящего звонка на SIP
robotуслуга звонков с помощью робота
carouselуслуга карусели

Legs

ПараметрТипОписание
start_timetimestampдата и время начала звонка UTC
end_timetimestampдата и время окончания звонка UTC
fromstringномер-инициатор звонка
tostringномер принимающего абонента
statusstring Statusстатус вызова этого плеча
setup_timeuint32время установки соединения в сек
wait_timeuint32время ожидания соединения в сек, совпадает с setup_time
talk_timeuint32длительность разговора в сек
durationuint32общая длительность в сек по данному плечу с учётом гудков, ожидания, разговора
cause_codeuint32код причины отбоя

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

КодСтатусОписание
1rejectedUNALLOCATED_NUMBERвызов отменён — номер получателя не найден, формат верный
2rejectedNO_ROUTE_TRANSIT_NETвызов отменён — нет маршрута к указанной транзитной сети
3rejectedNO_ROUTE_DESTINATIONвызов отменён — нет маршрута до указанного номера
21rejectedCALL_REJECTEDвызов отклонён
17busyUSER_BUSYвызываемый номер занят
18no_answerNO_USER_RESPONSEнет ответа
19no_answerNO_ANSWERнет сигнализации от пользователя, нет ответа
20no_answerSUBSCRIBER_ABSENTнет ответа
41no_answerNORMAL_TEMPORARY_FAILUREвременная неработоспособность
502no_answerLOSE_RACEнет ответа
487canceledORIGINATOR_CANCELвызов отменён звонящим
16answeredNORMAL_CLEARINGнормальное завершение вызова
604answeredMEDIA_TIMEOUTнормальное завершение вызова

Примеры

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

{
    "date_from": "2025-01-15T00:02:34.341Z",
    "date_to": "2025-05-16T15:07:34.351Z",
    "limit": 0,
    "offset": 10
}

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

{
   "calls": [
       {
           "call_id": "7285581555017551200",
           "service": "sip",
           "application_uuid": "45b2bf47-fa06-4352-a202-b347f372ff90",
           "start_time": "2025-01-16T09:00:02.997Z",
           "end_time": "2025-01-16T09:01:04.089Z",
           "from": "883140005577000",
           "to": "7999999999",
           "status": "no_answer",
           "direction": "outbound",
           "duration": 61.03,
           "legs": [
               {
                   "start_time": "2025-01-16T09:00:04.188Z",
                   "end_time": "2025-01-16T09:01:04.089Z",
                   "from": "79334445566",
                   "to": "7999999999",
                   "status": "no_answer",
                   "setup_time": 61.03,
                   "wait_time": 61.03,
                   "talk_time": 0,
                   "duration": 61.03,
                   "cause_code": 16
               }
           ],
           "record_call": true,
           "voice_record_exist": false,
           "transcribe": false,
           "transcribations_record_exist": false,
           "speech_analytics": true,
           "speech_analytics_exist": false
       },
       {
           "call_id": "7285556908054962276",
           "service": "voice_message",
           "application_uuid": "45b2bf47-fa06-4352-a202-b347f372ff90",
           "start_time": "2025-01-16T07:22:05.987Z",
           "end_time": "2025-01-16T07:22:28.660Z",
           "from": "79334445566",
           "to": "79001111111",
           "status": "answered",
           "direction": "outbound",
           "duration": 22.61,
           "legs": [
               {
                   "start_time": "2025-01-16T07:22:06.192Z",
                   "end_time": "2025-01-16T07:22:28.660Z",
                   "from": "79334445566",
                   "to": "79001111111",
                   "status": "answered",
                   "setup_time": 17.55,
                   "wait_time": 17.55,
                   "talk_time": 5.06,
                   "duration": 22.61,
                   "cause_code": 16
               }
           ],
           "record_call": false,
           "voice_record_exist": false,
           "transcribe": false,
           "transcribations_record_exist": false,
           "speech_analytics": false,
           "speech_analytics_exist": false,
           "detection": false,	
           "voice_detection_exist": false
       }
   ]
}

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

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