Statistics API

Statistics API позволяет получить статистику по исходящим и входящим звонкам.

Получить статистику по звонкам:

• GetList - получает историю всех звонков за определенный период времени;
• GetInfo - получает историю звонков по их уникальным идентификаторам.

Получить текстовые расшифровки звонков и речевую аналитику по ним можно с помощью этих методов:

• GetTranscribation - получает текстовую расшифровку аудиозаписи звонка по его ID;
• GetTranscribationsList - получает список текстовых расшифровок аудиозаписей звонков за выбранный период времени;
• GetSpeechAnalytic — получает результат речевой аналитики звонка по его ID;
• GetSpeechAnalyticsList — получает список результатов речевой аналитики звонков за выбранный период времени.

Получить историю HLR-запросов можно с помощью этих методов:

• GetHLRListActivityScore — получает историю HLR-запросов периодов времени, в течение которых наиболее высока вероятность дозвониться до абонентов;
• GetHLRListBestCallTime — получает историю HLR-запросов оценки телеком-доступности номеров абонентов;
• GetHLRListAggregation — получает агрегированную историю HLR-запросов об оценке телеком-доступности и походящих периодов времени для контакта с абонентами.

Также можно получать уведомления о ходе звонков в режиме онлайн на URL-адрес вашего сервера. Установить URL можно в Личном кабинете разработчика или с помощью метода SetCallForwarding Numbering API. Доступны уведомлениz:

• Inbound Call Events — о ходе входящих звонков, переадресованных по API на URL-адрес, номер телефона или SIP-соединение;
• Outbound Call Events — о ходе исходящих звонков с SIP ID;
• Callback Call Events — о ходе обратных звонков (callback).

Решения, где используется Statistics API

Интеграция виртуальной АТС с CRM

Голосовые SMS

Сервис статистики по API

Попробовать бесплатно

Метод GetList

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

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

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

Авторизация

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

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

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

StatusType

ServiceType

DirectionType

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

Calls

Status

Direction

Service

Legs

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

Примеры

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

{
    "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
       }
   ]
}

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

Метод GetInfo

Примените метод GetInfo для получения информации о звонке по его идентификатору.

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

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

Авторизация

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

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

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

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

ServiceType

Legs

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

Примеры

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

{
   "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
}

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

При поступлении входящих звонков, переадресованных на другие номера или SIP ID, можно получать автоматические уведомления на URL-адрес вашего сервера. Для этого укажите его в настройках приложения в Личном кабинете.

Параметры уведомлений при входящих звонках

Begin

Соединение с вызывающим абонентом (с которого поступил вызов).

Пример

{
    "service": "redirect",
    "type": "b",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "black_list": false,
    "date_time": "2025-11-30T08:35:34.644585Z",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455"
}

Originate

Инициация вызова на номер переадресации.

Пример

{
    "service": "redirect",
    "type": "o",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "reserve": false,
    "date_time": "2025-11-30T08:35:34.644585Z",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455",
    "record_call": true
}

Start

Фактический ответ стороны B — номера переадресации.

Пример

{
    "service": "redirect",
    "type": "s",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "reserve": false,
    "date_time": "2025-11-30T08:35:34.644585Z",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455",
    "record_call": true
}

Hungup

Разъединение/окончание вызова.

Пример

{
    "service": "redirect",
    "type": "h",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "reserve": false,
    "date_time": "2025-11-30T08:35:34.644585Z",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455",
    "record_call": true
}

Definition

redirect_number Окончание вызова с причинами разъединения каждого номера переадресации (при последовательной или параллельной переадресации).

Пример

{
    "service": "redirect",
    "type": "d",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "reserve": false,
    "date_time": "2023-11-30T08:35:34.644585Z",
    "cause_code": "16",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455",
    "record_call": true,
    "wait_time": 17943,
    "duration": 25740,
    "talk_time": 7797,
    "transcribe": false,
    "speech_analytics": false
}

End

Окончание вызова.

Пример

{
    "service": "redirect",
    "type": "e",
    "redirect_type": 1,
    "call_sid": "call-test-12345",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "customer_id": 1111,
    "reserve": false,
    "date_time": "2025-11-30T08:35:34.644585Z",
    "call_id": 12345678910,
    "from": "79991112233",
    "to": "79991114455",
    "record_call": true
}

Call record ready

Готова запись разговора.

Пример

{
    "uid": 7135909209505402880,
    "client_id": "777",
    "number_a": "79991112233",
    "call_sid": "call-test-12345",
    "type": "crr",
    "application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455791",
    "date_time": "2023-11-30T08:35:34.644585Z",
    "path": "https://api.exolve.ru/statistics/download/7135909209505402880",
    "service": "ipcr",
    "called_number": "74991112233",
    "calling_number": "74991112233",
    "expires_at": "2023-12-30T00:00:00Z",
    "customer_id": 1111,
    "size": 695084,
    "record_duration": 21
    }

Call transcribation ready

Готова транскрибация разговора.

Пример

{
    "type": "trc",
    "uid": 7135909209505402880,                    
    "transcribation": "ready"            
}

Speech analytics ready

Готов результат речевой аналитики разговора.

Пример

{
    "type": "sar",
    "uid": 7135909209505402880,                    
    "speech_analytics": "ready"            
}

Описание уведомлений, которые отправляются на установленный URL при исходящих звонках с SIP ID.

Примечание

Чтобы получать уведомления об исходящих звонках с SIP ID, необходимо установить URL-адреса для получения уведомлений в поле «SIP ID» в настройках приложения в Личном кабинете.

Параметры уведомлений при исходящих звонках с SIP ID

Begin

Соединение с вызывающим абонентом (с которого поступил вызов) .

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:29.934881Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "b",
    "sip_id": "883140123456789",
    "record_call": true,
    "call_id": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233"
}

Originate

Инициация вызова с SIP ID на номер B-абонента (номер телефона, на который совершается вызов).

Пример

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:29.934881Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "o",
    "sip_id": "883140123456789",
    "record_call": true,
    "call_id": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233"
}

Start

Фактический ответ B-абонента (владелец номера, на который совершается вызов, поднял трубку).

Пример

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:38.579416Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "s",
    "sip_id": "883140123456789",
    "record_call": true,
    "call_id": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233"
}

Hungup

Разъединение/окончание вызова.

Пример

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:42.862513Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "h",
    "sip_id": "883140123456789",
    "record_call": true,
    "call_id": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233"
}

Definition

Окончание вызова с причинами разъединения для каждого из абонентов (SIP ID и номер, на который совершён вызов).

Пример

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:42.885372Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "d",
    "sip_id": "883140123456789",
    "setup_time": 13959,
    "wait_time": 13959,
    "talk_time": 12920,
    "duration": 26879,
    "record_call": true,
    "call_id": 12345678910,
    "cause_code": "16",
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233",
    "speech_analytics": false
}

End

Окончание вызова.

Пример

{
    "service": "sip",
    "date_time": "2024-01-05T11:09:42.866477Z",
    "from": "79991112233",
    "to": "79994445566",
    "call_sid": "call-test-12345",
    "type": "e",
    "sip_id": "883140123456789",
    "record_call": true,
    "call_id": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "direction": "outbound",
    "display_number": "79991112233"
}

Call record ready

Готова запись разговора.

Пример

{
    "uid": 12345678910,
    "client_id": "777",
    "number_a": "79991112233",
    "call_sid": "call-test-12345",
    "type": "crr",
    "application_uuid": "12345",
    "date_time": "2023-11-30T08:35:34.644585Z",
    "path": "http://api.exolve.ru/statistics/download/12345678910",
    "service": "ipcr",
    "called_number": "74991112233",
    "calling_number": "74991112233",
    "expires_at": "2023-12-30T00:00:00Z",
    "customer_id": 1111,
    "size": 695084,
    "record_duration": 21,
    "redirect_type": 1
}

Call transcribation ready

Готова транскрибация разговора.

Пример

{
    "type": "trc",
    "uid": 7135909209505402880,                    
    "transcribation": "ready"            
}

Speech analytics ready

Готов результат речевой аналитики разговора.

Пример

{
    "type": "sar",
    "uid": 7135909209505402880,                    
    "speech_analytics": "ready"            
}

Описание уведомлений, которые отправляются на установленный URL при обратных звонках звонках.

Примечание

Чтобы получать уведомления об обратных звонках, необходимо установить URL для получения уведомлений в поле “Callback” в настройках приложения в Личном кабинете разработчика.

Параметры уведомлений при обратных звонках

Originate

Инициация обратного звонка для одного из абонентов.

Пример

// Инициация звонка с первым абонентом (A-абонент)
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:01.957366Z",
    "call_sid": "call-test-12345",
    "number": "79991112233",
    "type": "o",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "A",
    "record_call": true,
}

// Инициация звонка со вторым абонентом (B-абонент).
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:13.493309Z",
    "call_sid": "call-test-12345",
    "number": "79994445566",
    "type": "o",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "B",
    "record_call": true,
}

Start

Фактический ответ одного из абонентов (владелец номера, на который совершается вызов, поднял трубку).

Пример

// Первый абонент (A-абонент) ответил на звонок
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:11.418221Z",
    "call_sid": "call-test-12345",
    "number": "79991112233",
    "type": "s",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "A",
    "record_call": true,
}

// Второй абонент (B-абонент) ответил на звонок
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:36.548487Z",
    "call_sid": "call-test-12345",
    "number": "79994445566",
    "type": "s",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "B",
    "record_call": true,
}

Hungup

Разъединение/окончание вызова с одним из абонентов.

Пример

// Первый абонент (A-абонент) ответил на звонок
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:57.002096Z",
    "call_sid": "call-test-12345",
    "number": "79991112233",
    "type": "h",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "A",
    "record_call": true,
}

// Второй абонент (B-абонент) ответил на звонок
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:57.007305Z",
    "call_sid": "call-test-12345",
    "number": "79994445566",
    "type": "h",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "B",
    "record_call": true,
}

Definition

Окончание вызова с причиной разъединения с одним из абонентов.

Пример

// Окончание вызова с первым абонентом (A-абонент)
{
  "service": "callback",
  "date_time": "2024-01-07T10:54:57.009979Z",
  "call_sid": "cala188947f-3ba8-4fe6-b291-12fda2f90079",
  "number": "79991112233",
  "type": "d",
  "uid": 7149714791827935000,
  "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
  "customer_id": 25513,
  "started": "2024-01-07T10:54:11.385017Z",
  "ended": "2024-01-07T10:54:56.965018Z",
  "hangup_cause": "NORMAL_CLEARING",
  "cause": "16",
  "calling_number": "78000009988",
  "called_number": "79991112233",
  "setup_time": 10385,
  "wait_time": 10385,
  "duration": 45580,
  "full_duration": 55965,
  "event_side": "A",
  "record_call": true
}

// Окончание вызова со вторым абонентом (B-абонент)
{
  "service": "callback",
  "date_time": "2024-01-07T10:54:57.017228Z",
  "call_sid": "cala188947f-3ba8-4fe6-b291-12fda2f90079",
  "number": "79994445566",
  "type": "d",
  "uid": 7149714791827935000,
  "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
  "customer_id": 25513,
  "started": "2024-01-07T10:54:36.505022Z",
  "ended": "2024-01-07T10:54:56.965018Z",
  "hangup_cause": "NORMAL_CLEARING",
  "cause": "16",
  "calling_number": "78000009988",
  "called_number": "79994445566",
  "setup_time": 35505,
  "wait_time": 35505,
  "duration": 20459,
  "full_duration": 55965,
  "event_side": "B",
  "record_call": true
}

Call record ready

Готова запись разговора.

Пример

{
  "uid": 7149714791827935000,
  "call_sid": "call-test-12345",
  "type": "crr",
  "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
  "recording_sid": "record-call-test-12345",
  "path": "http://api.exolve.ru/statistics/download/7149714791827935000",
  "service": "callback",
  "hangup_cause": "",
  "called_number": "79994445566",
  "calling_number": "78000009988",
  "expires_at": "2024-02-18T00:00:00Z",
  "customer_id": 25513,
  "size": 499884,
  "duration": 20459
}

Call transcribation ready

Готова транскрибация записи разговора.

Пример

{
    "type": "trc",
    "uid": 7149714791827935000,                    
    "transcribation": "ready"            
}

End

Окончание вызова с одним из абонентов.

Пример

// Окончание вызова с первым абонентом (A-абонент)
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:57.007305Z",
    "call_sid": "call-test-12345",
    "number": "79991112233",
    "type": "e",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "A",
    "record_call": true,
}

// Окончание вызова с первым абонентом (A-абонент)
{
    "service": "callback",
    "date_time": "2024-01-07T10:54:57.007305Z",
    "call_sid": "call-test-12345",
    "number": "79994445566",
    "type": "e",
    "uid": 12345678910,
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "customer_id": 1111,
    "event_side": "B",
    "record_call": true,
}