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
Метод GetList
Примените метод GetList для получения истории звонков за определенный период. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/statistics/call-history/v2/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 |
| limit | uint32 | лимит выводимых строк |
| offset | uint64 | номер строки, с которой начинать выборку (начинается с 0) |
| from | string | поиск по номеру-инициатору звонка |
| to | string | поиск по номеру принимающего абонента |
| status | string | поиск по общему статусу звонка: UNSPECIFIED — не определён, ANSWERED — ответ, BUSY — занят, NO_ANSWER — нет ответа, CANCELED — отменен, REJECTED — вызов сброшен/отклонён, ERROR — ошибка |
| direction | string | поиск по направлению звонка: UNSPECIFIED — не определён, OUTBOUND — исходящий, INBOUND — входящий |
| service | string ServiceType | поиск по услуге, в рамках которой совершён звонок |
| direction | string | поиск по направлению звонка: UNSPECIFIED — не определён, OUTBOUND — исходящий, INBOUND — входящий |
| duration_from | uint32 | поиск по длительности вызова в секундах, min duration |
| duration_to | uint32 | поиск по длительности вызова в секундах, max duration |
ServiceType
| Параметр | Значение | Описание |
|---|---|---|
| 0 | UNSPECIFIED | услуга не определена |
| 1 | IPCR | услуга динамической переадресации по API |
| 3 | VOICE_MESSAGE | услуга голосового SMS |
| 4 | REDIRECT | услуга переадресации на номер |
| 5 | SIP | услуга SIP |
| 6 | SIP_REDIRECT | услуга переадресации на SIP |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| calls | Calls | информация о звонках |
Calls
| Параметр | Тип | Описание |
|---|---|---|
| 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 | 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 |
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 | нормальное завершение вызова |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | malformed token | не указан / не правильно указан API-ключ приложения |
| 400 | Bad Request | invalid uuid format | неправильный формат в параметре запроса |
| 400 | Bad Request | invalid value | значения параметра невалидно |
Примеры
Входные параметры:
{
"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 для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| 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
}
При поступлении входящих звонков, переадресованных на другие номера или SIP ID, можно получать автоматические уведомления на URL-адрес вашего сервера. Для этого укажите его в настройках приложения в Личном кабинете.
Параметры уведомлений при входящих звонках
Begin
Соединение с вызывающим абонентом (с которого поступил вызов) .
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| type | string | тип уведомления, значение - b |
| sip_id | string | номер Exolve, на который поступает вызов |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| black_list | boolean | True - номер вызова находится в чёрном списке (вызов сбросится), false - номер вызова не в чёрном списке (вызов продолжится) |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:34.644585Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "b",
"sip_id": "74991112233",
"redirect_type": 1,
"uid": 12345678910,
"application_uuid": "12345",
"customer_id": 1111,
"black_list": false
}
Originate
Инициация вызова на redirect_number (номер переадресации).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - o |
| sip_id | string | номер Exolve, на который поступает вызов |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:34.644585Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "o",
"sip_id": "74991112233",
"reserve": false,
"redirect_type": 1,
"record_call": false,
"uid": 12345678910,
"application_uuid": "12345",
"customer_id": 1111
}
Start
Фактический ответ стороны B - стороны redirect_number (номер переадресации).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| type | string | тип уведомления, значение - s |
| sip_id | string | номер Exolve, на который поступает вызов |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:34.644585Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "s",
"sip_id": "74991112233",
"reserve": false,
"redirect_type": 1,
"record_call": false,
"uid": 12345678910,
"application_uuid": "12345",
"customer_id": 1111
}
Hungup
Разъединение/окончание вызова.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| type | string | тип уведомления, значение - h |
| sip_id | string | номер Exolve, на который поступает вызов |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:34.644585Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "h",
"sip_id": "74991112233",
"reserve": false,
"redirect_type": 1,
"record_call": false,
"uid": 12345678910,
"application_uuid": "12345",
"customer_id": 1111
}
Definition
Окончание вызова с причинами разъединения для каждого redirect_number (номер переадресации).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| type | string | тип уведомления, значение - d |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
| wait_time | uint32 | время ожидания A-абонента до фактического соединения с B-абонентом (ответ на звонок) в миллисекундах |
| duration | uint32 | время фактического разговора абонентов в миллисекундах |
| full_duration | uint32 | время разговора в миллисекундах c учетом проигрывания аудиосообщения абоненту B (принимает вызов) |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| cause | string | код причины разъединения звонка (Q.850) |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:52.406536Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "d",
"reserve": false,
"wait_time": 370,
"duration": 18059,
"full_duration": 18430,
"redirect_type": 1,
"record_call": false,
"uid": 12345678910,
"cause": "16",
"application_uuid": "12345",
"customer_id": 1111
}
Call record ready
Готова запись разговора.
| Параметр | Тип | Описание |
|---|---|---|
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| redirect_number | string | номер, на который переадресовывается вызов |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - crr |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| recording_sid | string | уникальный идентификатор записи разговора |
| path | string | ссылка на скачивания файла с записью звонка |
| service | string | сервис для отправки уведомления |
| called_number | string | номер Exolve, на которой совершён вызов |
| calling_number | string | номер Exolve, с которого совершён вызов на номер переадресации |
| expires_at | string | дата, до которой будет храниться запись RFC-3339 / ISO-8601 |
| customer_id | uint64 | уникальный идентификатор пользователя |
| size | uint64 | размер файла с записью (кб) |
| duration | uint64 | длительность записи в секундах |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
Пример
{
"uid": 12345678910,
"redirect_number": "79992223344",
"client_id": "777",
"number_a": "79991112233",
"call_sid": "call-test-12345",
"type": "crr",
"application_uuid": "12345",
"date_time": "2023-11-30T08:35:34.644585Z",
"recording_sid": "rec12345",
"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,
"duration": 21,
"redirect_type": 1,
}
Call transcribation ready
Готова транскрибация разговора.
| Параметр | Тип | Описание |
|---|---|---|
| uid | uint64 | уникальный идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова |
| transcribation | string | ready — признак готовности текстовой расшифровки звонка |
| type | string | тип уведомления, значение — trc |
Пример
{
"type": "trc",
"uid": 7135909209505402880,
"transcribation": "ready"
}
Speech anylytics ready
Готов результат речевой аналитики разговора.
| Параметр | Тип | Описание |
|---|---|---|
| uid | uint64 | уникальный идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова |
| speech_analytics | string | ready — признак готовности текстовой расшифровки звонка |
| type | string | тип уведомления, значение — sar |
Пример
{
"type": "sar",
"uid": 7135909209505402880,
"speech_analytics": "ready"
}
End
Окончание вызова.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (с которого поступил вызов) |
| redirect_number | string | номер, на который переадресовывается вызов |
| call_sid | string | уникальный идентификатор вызова |
| client_id | string | сквозной идентификатор от API клиента (необязательное поле, передается если значение было передано клиентом в запросе) |
| type | string | тип уведомления, значение - h |
| sip_id | string | номер Exolve, на который поступает вызов |
| reserve | boolean | признак переадресации на резервный номер. True, если вызов был отправлен на резервный номер. False, если вызов не отправлялся на резервный номер |
| redirect_type | enum | тип переадресации, значения: 1 - одиночная, 2 - последовательная, 3 - параллельная |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
Пример
{
"service": "ipcr",
"date_time": "2023-11-30T08:35:34.644585Z",
"number_a": "79991112233",
"redirect_number": "79992223344",
"call_sid": "call-test-12345",
"client_id": "777",
"type": "e",
"sip_id": "74991112233",
"reserve": false,
"redirect_type": 1,
"record_call": false,
"uid": 12345678910,
"application_uuid": "12345",
"customer_id": 1111
}
Описание уведомлений, которые отправляются на установленный URL при исходящих звонках с SIP ID.
Примечание
Чтобы получать уведомления об исходящих звонках с SIP ID, необходимо установить URL для получения уведомлений в поле “SIP” в настройках приложения в Личном кабинете разработчика.
Параметры уведомлений при исходящих звонках с SIP ID
Begin
Соединение с вызывающим абонентом (с которого поступил вызов) .
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - b |
| sip_id | string | SIP ID, с которого совершён звонок |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
{
"service": "sip",
"date_time": "2024-01-05T11:09:29.934881Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "b",
"sip_id": "883140123456789",
"record_call": true,
"uid": 12345678910,
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
Originate
Инициация вызова с SIP ID на номер B-абонента (номер телефона, на который совершается вызов).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - o |
| sip_id | string | SIP ID, с которого совершён звонок |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
Пример
{
"service": "sip",
"date_time": "2024-01-05T11:09:29.934881Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "o",
"sip_id": "883140123456789",
"record_call": true,
"uid": 12345678910,
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
Start
Фактический ответ B-абонента (владелец номера, на который совершается вызов, поднял трубку).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - s |
| sip_id | string | SIP ID, с которого совершён звонок |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
Пример
{
"service": "sip",
"date_time": "2024-01-05T11:09:38.579416Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "s",
"sip_id": "883140123456789",
"record_call": true,
"uid": 12345678910,
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
Hungup
Разъединение/окончание вызова.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - h |
| sip_id | string | SIP ID, с которого совершён звонок |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
Пример
{
"service": "sip",
"date_time": "2024-01-05T11:09:42.862513Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "h",
"sip_id": "883140123456789",
"record_call": true,
"uid": 12345678910,
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
Definition
Окончание вызова с причинами разъединения для каждого из абонентов (SIP ID и номер, на который совершён вызов).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - d |
| sip_id | string | SIP ID, с которого совершён звонок |
| setup_time | uint32 | время ожидания A-абонента до соединения с B-абонентом или отбоя |
| wait_time | uint32 | время ожидания A-абонента до фактического ответа B-абонента |
| duration | uint32 | время фактического разговора абонентов в миллисекундах |
| full_duration | uint32 | время разговора в миллисекундах c учетом проигрывания аудиосообщения B-абоненту |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| cause_code | string | код причины разъединения звонка (Q.850) |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
Пример
{
"service": "sip",
"date_time": "2024-01-05T11:09:42.885372Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "d",
"sip_id": "883140123456789",
"setup_time": 800,
"wait_time": 800,
"duration": 4279,
"full_duration": 13820,
"record_call": true,
"uid": 12345678910,
"cause_code": "16",
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
End
Окончание вызова.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| number_a | string | номер A-абонента (определяемый номер Exolve, привязанный к SIP ID) |
| number_b | string | номер B-абонент (номер телефона, на который совершён вызов) |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - e |
| sip_id | string | SIP ID, с которого совершён звонок |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| direction | string | направление звонка - outbound (исходящий) |
| display_number | string | номер, который видит B-абонент |
Пример
{
"service": "sip",
"date_time": "2024-01-05T11:09:42.866477Z",
"number_a": "79991112233",
"number_b": "79994445566",
"call_sid": "call-test-12345",
"type": "e",
"sip_id": "883140123456789",
"record_call": true,
"uid": 12345678910,
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"customer_id": 1111,
"direction": "outbound",
"display_number": "79991112233"
}
Описание уведомлений, которые отправляются на установленный URL при обратных звонках звонках.
Примечание
Чтобы получать уведомления об обратных звонках, необходимо установить URL для получения уведомлений в поле “Callback” в настройках приложения в Личном кабинете разработчика.
Параметры уведомлений при обратных звонках
Originate
Инициация обратного звонка для одного из абонентов.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| call_sid | string | уникальный идентификатор вызова |
| number | string | номер вызываемого абонента |
| type | string | тип уведомления, значение - o |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| event_side | string | к какому абоненту относится уведомление (A-абонент или B-абонент ) |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
Пример
// Инициация звонка с первым абонентом (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
Фактический ответ одного из абонентов (владелец номера, на который совершается вызов, поднял трубку).
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| call_sid | string | уникальный идентификатор вызова |
| number | string | номер вызываемого абонента |
| type | string | тип уведомления, значение - s |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| event_side | string | к какому абоненту относится уведомление (A-абонент или B-абонент ) |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
Пример
// Первый абонент (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
Разъединение/окончание вызова с одним из абонентов.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| call_sid | string | уникальный идентификатор вызова |
| number | string | номер вызываемого абонента |
| type | string | тип уведомления, значение - h |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| event_side | string | к какому абоненту относится уведомление (A-абонент или B-абонент ) |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
Пример
// Первый абонент (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
Окончание вызова с причиной разъединения с одним из абонентов.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| call_sid | string | уникальный идентификатор вызова |
| number | string | номер вызываемого абонента |
| type | string | тип уведомления, значение - d |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| started | string | дата начала звонка с абонентом RFC-3339 / ISO-8601 |
| ended | string | дата окончания звонка с абонентом RFC-3339 / ISO-8601 |
| hangup_cause | string | причина разъединения звонка |
| cause | string | код причины разъединения звонка (Q.850) |
| called_number | string | номер Exolve, на которой совершён вызов |
| calling_number | string | номер Exolve, с которого совершён вызов на номер переадресации |
| setup_time | uint32 | время ожидания A-абонента до соединения с B-абонентом или отбоя |
| wait_time | uint32 | время ожидания A-абонента до фактического ответа B-абонента |
| duration | uint32 | время фактического разговора абонентов в миллисекундах |
| full_duration | uint32 | время разговора в миллисекундах c учетом проигрывания аудиосообщения B-абоненту |
| event_side | string | к какому абоненту относится уведомление (A-абонент или B-абонент ) |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
Пример
// Окончание вызова с первым абонентом (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 | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| call_sid | string | уникальный идентификатор вызова |
| type | string | тип уведомления, значение - crr |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| recording_sid | string | уникальный идентификатор записи разговора |
| path | string | ссылка на скачивания файла с записью звонка |
| service | string | сервис для отправки уведомления |
| hangup_cause | string | причина разъединения звонка |
| called_number | string | номер Exolve, на которой совершён вызов |
| calling_number | string | номер Exolve, с которого совершён вызов на номер переадресации |
| expires_at | string | дата, до которой будет храниться запись RFC-3339 / ISO-8601 |
| customer_id | uint64 | уникальный идентификатор пользователя |
| size | uint64 | размер файла с записью (кб) |
| duration | uint64 | длительность записи в секундах |
Пример
{
"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
Готова транскрибация записи разговора.
| Параметр | Тип | Описание |
|---|---|---|
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| transcribation | string | признак готовности текстовой расшифровки звонка |
| type | string | тип уведомления, значение - trc |
Пример
{
"type": "trc",
"uid": 7149714791827935000,
"transcribation": "ready"
}
End
Окончание вызова с одним из абонентов.
| Параметр | Тип | Описание |
|---|---|---|
| service | string | сервис для отправки уведомления |
| date_time | string | дата события в формате RFC-3339 / ISO-8601 |
| call_sid | string | уникальный идентификатор вызова |
| number | string | номер вызываемого абонента |
| type | string | тип уведомления, значение - e |
| uid | uint64 | уникальный идентификатор вызова. Одинаковый во всех событиях и запросах в рамках одного вызова |
| application_uuid | string | уникальный идентификатор приложения, через которое проходит вызов |
| customer_id | uint64 | уникальный идентификатор пользователя |
| event_side | string | к какому абоненту относится уведомление (A-абонент или B-абонент ) |
| record_call | boolean | признак записи разговора. True, если разговор записывается. False, если разговор не записывается |
Пример
// Окончание вызова с первым абонентом (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,
}