GetList (deprecated)
ВНИМАНИЕ! Этот метод больше не поддерживается. Используйте новый метод 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 | string | дата начала выборки звонков в формате RFC-3339 / ISO-8601 |
| date_to | string | дата окончания выборки звонков в формате RFC-3339 / ISO-8601 |
| sip_id | string | B-номер, на который поступил звонок |
| limit | uint32 | лимит выводимых строк |
| offset | uint64 | номер строки, с которой начинать выборку (начинается с 0) |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| calls | Calls | информация о звонках |
Calls
| Параметр | Тип | Описание |
|---|---|---|
| call_id | uint64 | уникальный идентификатор вызова. Одинаков во всех событиях и запросах в рамках одного вызова |
| duration | uint32 | время разговора в секундах без учета проигрывания аудиосообщения абоненту B (принимает вызов) |
| number_a | string | номер, с которого поступил вызов |
| number_b | string | номер, на который поступил вызов |
| extension | string | добавочный номер |
| call_start | string | дата начала вызова со стороны абонента A (инициирует вызов) в формате RFC-3339 / ISO-8601 |
| call_end | string | дата окончания соединения в формате RFC-3339 / ISO-8601 |
| premedia_a_start | string | дата начала проигрывания аудиосообщения абоненту A (инициирует вызов) в формате RFC-3339 / ISO-8601 |
| premedia_a_end | string | дата завершения проигрывания аудиосообщения абоненту A (инициирует вызов) в формате RFC-3339 / ISO-8601 |
| record_call | boolean | True, если разговор записывался. False, если разговор не записывался |
| transcribe | boolean | True, если текстовая расшифровка подключена. False, если текстовая расшифровка отключена |
| voice_transcribe_exist | boolean | True, текстовая расшифровка доступна. False, если текстовая расшифровка недоступна |
| speech_analytics | boolean | True, если речевая аналитика подключена. False, если речевая аналитика отключена |
| speech_analytics_exist | boolean | True, результат речевой аналитики доступен. False, результат речевой аналитики недоступен |
| redirect_type | uint32 | тип переадресации. Для услуги IPCR (переадресация на URL): 1 - одиночная, 2- последовательная, 3- параллельная. Для переадресации на номер и услуги VoiceMessage (голосовое SMS): 0 |
| 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 | информация о переадресации |
| sip_id | string | номер Exolve |
ServiceType
| Параметр | Значение | Описание |
|---|---|---|
| 0 | SERVICE_TYPE_UNSPECIFIED | услуга не определена |
| 1 | SERVICE_TYPE_IPCR | услуга переадресации на URL |
| 2 | SERVICE_TYPE_CALLBACK | услуга обратного звонка |
| 3 | SERVICE_TYPE_MESSAGE | услуга голосового SMS |
| 4 | SERVICE_TYPE_REDIRECT | услуга переадресации на номер, голосовые SMS |
| 5 | SERVICE_TYPE_SIP | услуга SIP |
RedirectElement
| Параметр | Тип | Описание |
|---|---|---|
| disconnect_cause | string | причина отбоя |
| disconnect_side | string | инициатор отбоя |
| number_c | string | номер для переадресации вызова |
| init_redirect_time | string | дата начала вызова абонента C (принимает переадресованный вызов) в формате RFC-3339 / ISO-8601 |
| answer_time | string | дата фактического ответа абонента C (принимает переадресованный вызов) в формате RFC-3339 / ISO-8601 |
| premedia_b_start | string | дата начала проигрывания аудиосообщения абоненту B (принимает и переадресовывает вызов) в формате RFC-3339 / ISO-8601 |
| premedia_b_end | string | дата завершения проигрывания аудиосообщения абоненту B (принимает и переадресовывает вызов) в формате RFC-3339 / ISO-8601 |
| talk_time | string | начало разговорной фазы в формате RFC-3339 / ISO-8601 |
| end_redirect_time | string | дата окончания вызова абонента C (принимает переадресованный вызов) в формате RFC-3339 / ISO-8601 |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | malformed token | не указан / не правильно указан API-ключ приложения |
| 400 | Bad Request | invalid uuid format | неправильный формат в параметре запроса |
| 400 | Bad Request | invalid value | значения параметра не валидно |
Примеры
Входные параметры:
{
"date_from": "2022-12-20T13:25:00Z",
"date_to": "2024-12-30T13:27:00Z",
"sip_id": "79999999999"
}
Выходные параметры:
{
"calls": [
{
"call_id": "7031327459723317248",
"duration": 74365,
"number_a": "79241112255",
"number_b": "79999999999",
"extension": "",
"call_start": "2022-12-20T13:25:00Z",
"call_end": "2024-12-30T13:27:00Z",
"record_call": false,
"speech_analytics": 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
}
]
}
]
}