Statistics API

Statistics API — программный интерфейс, который позволяет пользователям получить статистику по исходящим и входящим звонках (callback звонки, переадресованные входящие звонки, голосовые SMS).

Statistics API Exolve предлагает пользователям следующие методы для получения статистики по звонкам:

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

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

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

  • Inbound Call Events - уведомления о ходе входящих звонков, переадресованных на URL, номер телефона или SIP ID;

  • Outbound Call Events - уведомления о ходе исходящих звонков с SIP ID;

  • Callback Call Events - уведомления о ходе обратных звонков.

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

Метод 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, если разговор не записывался
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": "2023-12-30T13:27:00Z",
    "sip_id": "79999999999"
}

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

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

Метод GetInfo

Примените этот метод для получения информации о звонках по уникальным идентификаторам вызовов. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

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

Авторизация

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

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

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

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

Параметр Тип Описание
ids uint64 уникальные идентификаторы вызовов

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

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

CallElement

Параметр Тип Описание
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, если разговор не записывался
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 (принимает переадресованный вызов)
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 syntax error синтаксическая ошибка в запросе

Примеры

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

{
    "ids": [
        7013503421000974336
    ]
}

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

{
    "call": [
        {
            "call_id": "7013503421000974336",
            "duration": 0,
            "number_a": "7499000000",
            "number_b": "79999999999",
            "extension": "",
            "call_start": "2022-12-27T13:58:40Z",
            "call_end": "2022-12-27T13:58:40Z",
            "record_call": false,
            "redirect_type": 0,
            "customer": "246",
            "application_uuid": "d25b1d5a-6879-44a2-95fd-c9487bc4a1f4",
            "setup_time": 16358,
            "wait_time": 16358,
            "full_duration": 30,
            "call_sid": "cal120584e5-917d-4131-9baf-206b6987c93d",
            "redirects": [
                {
                    "disconnect_side": "",
                    "number_c": "79841234444",
                    "init_redirect_time": "2022-12-27T13:58:40Z",
                    "answer_time": "2022-12-27T13:58:40Z",
                    "end_redirect_time": "2022-12-27T13:58:40Z",
                    "reserve": false
                }
            ]
        }
    ]
}

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

Примечание

Чтобы получать уведомления о входящих вызовах, переадресованных на URL, номер телефона, или SIP ID, необходимо установить URL для получения уведомлений в поле “Переадресация вхд. вызовов на 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 признак готовности текстовой расшифровки звонка
type string тип уведомления, значение - trc

Пример

{
    "type": "trc",
    "uid": 7135909209505402880,                    
    "transcribation": "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,
}