Примеры событий с основными полями

Примеры событий с основными полями (.xls)

Описание столбцов таблицы:

Case – Рассматриваемая ситуация звонка.

Full description – Полное описание звонка.

Manipulations – предполагаемые действия во внешней системе.

Priority – Приоритет получения событий (события имеющие одинаковый приоритет отправляются платформой одновременно, но будут получены в разной последовательности).

Event-name – название пришедшего события, возможные значения:
CHANNEL_CREATE, CHANNEL_ANSWER, CHANNEL_DESTROY.

Call-direction – направление плеча вызова, возможные значения:
Inbound, outbound.

Answer-state – состояние события, возможные события:
Ringing, Answered, Hangup.

Request – заголовок из sip пакета, содержит информацию вида sip uri.
До @ содержит номер или логин, на который маршрутизируется звонок.
Значения после @:
213.145.53.135 – входящий сервер (обрабатывает входящие звонки из ТФоП, исходящие звонки с SIP и отправляет вызовы на SIP в случае внутристанционных звонков).
213.145.53.138 – исходящий сервер (явный признак отправки исходящего звонка в ТФоП).

Caller-ID-Number – номер А.

Callee-ID-Number – номер Б.

Custom-Channel-Vars.Owner-ID – ID пользователя ВАТС, может быть получен через API – https://api.zebratelecom.ru/v1/kazoos/accounts/{account_id}/users

Hangup-Code – sip код завершения звонка (поле может быть пустым).

Hangup-Cause – sip причина завершения вызова.

Не затронутые в документе поля, но имеющие значение для разработки:

Custom-Channel-Vars.Account-ID – уникальный ID ВАТС на платформе.

Custom-Channel-Vars.Realm – уникальный sip realm ВАТС (он же сервер для регистрации sip).

Custom-Channel-Vars.Bridge-ID – Уникальный ID звонка (совокупность сообщений).

Msg-ID – уникальный ID события.

Это основные используемые поля для анализа событий webhooks.

Рекомендации:

Сбор событий в рамках одного звонка осуществляется по полю BRIDGE_ID.

Каждое событие имеет поле Account-ID значение которого явное определяет уникальную ВАТС в рамках платформы.

Для отсева дубликатов события имеют уникальное значение в поле MSG_ID.

Абонентская служба