Outbound Call Events (SIP ID) | Statistics API | документация Exolve

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

Примечание

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

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

Begin

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
type	string	тип уведомления, значение: `b`
service	string	сервис для отправки уведомления
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
sip_id	string	SIP ID, с которого совершён звонок
record_call	boolean	признак записи разговора. `True` — разговор записывается. `False` — разговор не записывается
direction	string	направление звонка: `outbound` (исходящий)
display_number	string	номер, который видит B-абонент
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя


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

Originate

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
service	string	сервис для отправки уведомления
type	string	тип уведомления, значение: `o`
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
call_sid	string	идентификатор вызова
sip_id	string	SIP ID, с которого совершён звонок
record_call	boolean	признак записи разговора. `True` — разговор записывается. `False` — разговор не записывается
direction	string	направление звонка: `outbound` (исходящий)
display_number	string	номер, который видит B-абонент
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя

Пример

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

Start

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
service	string	сервис для отправки уведомления
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
type	string	тип уведомления, значение: `s`
sip_id	string	SIP ID, с которого совершён звонок
record_call	boolean	признак записи разговора. `True` — разговор записывается. `False` — разговор не записывается
direction	string	направление звонка: `outbound` (исходящий)
display_number	string	номер, который видит B-абонент
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя

Пример

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

Hungup

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
service	string	сервис для отправки уведомления
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
type	string	тип уведомления, значение: `h`
sip_id	string	SIP ID, с которого совершён звонок
record_call	boolean	признак записи разговора. `True`, если разговор записывается. `False`, если разговор не записывается
direction	string	направление звонка: `outbound` (исходящий)
display_number	string	номер, который видит B-абонент
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя

Пример

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

Definition

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
type	string	тип уведомления, значение: `d`
service	string	сервис для отправки уведомления
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
sip_id	string	SIP ID, с которого совершён звонок
setup_time	uint32	время ожидания A-абонента до соединения с B-абонентом или отбоя
wait_time	uint32	время ожидания A-абонента до фактического ответа B-абонента
duration	uint32	полное время вызова в миллисекундах (с учётом ожидания, проигрывания аудиосообщений и времени фактического разговора абонентов)
talk_time	uint32	время фактического разговора абонентов в миллисекундах
record_call	boolean	признак записи разговора. `True` — разговор записывается. `False` — разговор не записывается
speech_analytics	boolean	признак речевой аналитики разговора. `True` — вызов анализируется. `False` — вызов не анализируется
cause_code	string	код причины разъединения звонка (Q.850)
direction	string	направление звонка: `outbound` (исходящий)
disconnect_side	string	признак разрыва вызова детектированием автоответчиков. В этом случае значение: `amd`. Если вызов не разорван, параметр не передается (применимо только при подключенной услуге «Детектирование автоинформаторов»)
display_number	string	номер, который видит B-абонент
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя

Пример

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

End

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

Параметр	Тип	Описание
call_id	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова. В онлайн-уведомлениях типа crr, ctr, sar называется `uid`
call_sid	string	идентификатор вызова
type	string	тип уведомления, значение: `e`
service	string	сервис для отправки уведомления
date_time	string	дата события в формате RFC-3339 / ISO-8601
from	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
to	string	номер B-абонента (номер телефона, на который совершён вызов)
direction	string	направление звонка - outbound (исходящий)
display_number	string	номер, который видит B-абонент
sip_id	string	SIP ID, с которого совершён звонок
record_call	boolean	признак записи разговора. `True` — разговор записывается. `False` — разговор не записывается
application_uuid	string	идентификатор приложения, через которое проходит вызов
customer_id	uint64	идентификатор пользователя

Пример

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

Call record ready

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

Параметр	Тип	Описание
uid	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова
call_sid	string	идентификатор вызова
type	string	тип уведомления, значение: `crr`
called_number	string	номер, на который совершён вызов
calling_number	string	SIP ID, с которого совершён вызов
number_a	string	номер A-абонента (определяемый номер Exolve, привязанный к SIP ID)
date_time	string	дата события в формате RFC-3339 / ISO-8601
path	string	ссылка на скачивания файла с записью звонка
service	string	сервис для отправки уведомления
expires_at	string	дата, до которой будет храниться запись RFC-3339 / ISO-8601
size	uint64	размер файла с записью (кб)
record_duration	uint64	длительность записи в секундах
customer_id	uint64	идентификатор пользователя
application_uuid	string	идентификатор приложения, через которое проходит вызов
client_id	string	сквозной идентификатор от вашего API (это необязательное поле передается, если значение было передано в запросе)

Пример

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

Call transcribation ready

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

Параметр	Тип	Описание
uid	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова
call_sid	string	идентификатор вызова
transcribation	string	`ready` — признак готовности текстовой расшифровки звонка
type	string	тип уведомления, значение: `trc`

Пример

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

Speech analytics ready

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

Параметр	Тип	Описание
uid	uint64	идентификатор вызова, одинаковый во всех событиях и запросах в рамках одного вызова
call_sid	string	идентификатор вызова
type	string	тип уведомления, значение: `sar`
speech_analytics	string	`ready` — признак готовности речевой аналитики звонка

Пример

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