GetList
Метод GetList
Примените этот метод для получения истории звонков за определенный период. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/statistics/call-history/v1/GetList
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
date_from | google.protobuf.Timestamp | дата начала выборки звонков |
date_to | google.protobuf.Timestamp | дата окончания выборки звонков |
sip_id | string | B-номер или SIP аккаунт, на который поступил звонок |
application_uuid | string | уникальный идентификатор приложения, через которое совершались звонки |
limit | uint32 | лимит выводимых строк |
offset | uint64 | номер строки, с которой начинать выборку (начинается с 0) |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
call_history | CallHistory | информация о звонках |
CallHistory
Параметр | Тип | Описание |
---|---|---|
call_id | uint64 | уникальный идентификатор вызова. Одинаков во всех событиях и запросах в рамках одного вызова |
duration | uint32 | время разговора в секундах без учета проигрывания аудиосообщения абоненту B (принимает вызов) |
number_a | string | номер, с которого поступил вызов |
number_b | string | номер, на который поступил вызов |
extension | string | добавочный номер |
call_start | google.protobuf.Timestamp | дата начала вызова со стороны абонента A (инициирует вызов) |
call_end | google.protobuf.Timestamp | дата окончания соединения |
premedia_a_start | google.protobuf.Timestamp | дата начала проигрывания аудиосообщения абоненту A (инициирует вызов) |
premedia_a_end | google.protobuf.Timestamp | дата завершения проигрывания аудиосообщения абоненту A (инициирует вызов) |
record_call | boolean | True , если разговор записывался. False , если разговор не записывался |
redirect_type | uint32 | тип переадресации (1 - одиночная, 2- последовательная, 3- параллельная) |
application_uuid | string | уникальный идентификатор приложения, через которое совершался звонок |
application_name | string | наименование приложения, через которое совершался звонок |
setup_time | uint32 | время ожидания абонента А (инициирует вызов) до соединения с абонентом B (принимает вызов) или отбоя |
wait_time | uint32 | время ожидания абонента А до фактического ответа абонента B (принимает вызов) |
full_duration | uint32 | время разговора в секундах c учетом проигрывания аудиосообщения абоненту B (принимает вызов) |
call_sid | string | идентификатор звонка |
service | enum ServiceType | услуга вызова |
redirects | RedirectElement | информация о переадресации |
ServiceType
Параметр | ID | Описание |
---|---|---|
SERVICE_TYPE_UNSPECIFIED | 0 | услуга не определена |
SERVICE_TYPE_IPCR | 1 | услуга вызова на URL |
SERVICE_TYPE_CALLBACK | 2 | услуга обратного звонка |
SERVICE_TYPE_MESSAGE | 3 | услуга голосового SMS |
SERVICE_TYPE_REDIRECT | 4 | услуга переадресации |
RedirectElement
Параметр | Тип | Описание |
---|---|---|
disconnect_cause | string | причина отбоя |
disconnect_side | string | инициатор отбоя |
number_c | string | номер для переадресации вызова |
init_redirect_time | google.protobuf.Timestamp | дата начала вызова абонента C (принимает переадресованный вызов) |
answer_time | google.protobuf.Timestamp | дата фактического ответа абонента C (принимает переадресованный вызов) |
premedia_b_start | google.protobuf.Timestamp | дата начала проигрывания аудиосообщения абоненту B (принимает и переадресовывает вызов) |
premedia_b_end | google.protobuf.Timestamp | дата завершения проигрывания аудиосообщения абоненту B (принимает и переадресовывает вызов) |
talk_time | google.protobuf.Timestamp | начало разговорной фазы |
end_redirect_time | google.protobuf.Timestamp | дата окончания вызова абонента C (принимает переадресованный вызов) |
reserve | boolean | признак переадресации на резервный номер. True , если вызов был отправлен на резервный номер. False , если вызов не отправлялся на резервный номер |
black_list | boolean | признак блокировки в чёрном списке. True , если номер находится в чёрном списке. False , если номера нет в чёрном списке |
Примеры
Входные параметры:
{
"date_from": "2022-12-20T13:25:00Z",
"date_to": "2023-12-30T13:27:00Z",
"sip_id": "79999999999"
}
Выходные параметры:
{
"call_history": [
{
"call_id": "7031327459723317248",
"duration": 74365,
"number_a": "79241112255",
"number_b": "79999999999",
"extension": "",
"call_start": "2023-02-14T18:25:02.148304Z",
"call_end": "2023-02-14T18:26:27.142397Z",
"record_call": false,
"redirect_type": 0,
"customer": "25513",
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"application_name": "Test",
"setup_time": 269,
"wait_time": 269,
"full_duration": 84724,
"call_sid": "cal6c62f1d3-a1bb-4292-8ee9-b920f8e187a9",
"service": "SERVICE_TYPE_REDIRECT",
"redirects": [
{
"disconnect_side": "",
"number_c": "79300008899",
"init_redirect_time": "2023-02-14T18:25:02.418070Z",
"answer_time": "2023-02-14T18:25:12.777086Z",
"end_redirect_time": "2023-02-14T18:26:27.147032Z",
"reserve": false,
"black_list": false
}
]
}
]
}