VoipWebhookRequest

Событие телефонии

Представляет собой событие телефонии. Система использует эти данные, чтобы отобразить уведомления о звонке связанным пользователям.

async function VoipParseWebhookRequest(request: FetchRequest): Promise<VoipWebhookParseResult> {
    if (typeof request.body !== 'string') {
        return {};
    }
    const data = JSON.parse(request.body);
    return {
        event: {
            event: VoipWebhookEvent.NotifyStart,
            direction: VoipCallDirection.In,
            dstPhone: data.dstPhone,
            srcPhone: data.srcPhone,
            disposition: VoipCallDisposition.Unknown,
        }
    };
}

Hierarchy

  • VoipWebhookRequest

Properties

Optional callId

callId: undefined | string

Идентификатор звонка во внешней системе.

Используется системой для сопоставления нескольких событий телефонии к одному звонку. В случае если идентификатор звонка не указан, то система будет сопоставлять звонки по комбинации полей VoipWebhookRequest.srcPhone, VoipWebhookRequest.srcPhoneExt, VoipWebhookRequest.dstPhone, VoipWebhookRequest.dstPhoneExt и VoipWebhookRequest.direction.

direction

Направление звонка.

disposition

disposition: VoipCallDisposition

Результат звонка.

dstPhone

dstPhone: string

Номер, на который звонят.

Заполняется в зависимости от направления вызова:

  • входящий или внутренний звонок — внутренний номер оператора, принимающего вызов;
  • исходящий звонок — внешний номер клиента, которому звонит оператор.

Optional dstPhoneExt

dstPhoneExt: undefined | string

Добавочный номер сотрудника при инициации исходящего звонка на внешний номер VoipWebhookRequest.dstPhone.

Используется системой только для исходящих звонков. Для остальных направлений следует оставлять поле незаполненным.

event

Тип события телефонии.

srcPhone

srcPhone: string

Номер, с которого звонят.

Заполняется в зависимости от направления вызова:

  • входящий звонок — внешний номер клиента, звонящего оператору;
  • исходящий или внутренний звонок — внутренний номер оператора, инициировавшего вызов.

Optional srcPhoneExt

srcPhoneExt: undefined | string

Добавочный номер сотрудника при получении входящего звонка с внешнего номера VoipWebhookRequest.srcPhone.

Как правило, при получении входящего звонка из телефонной сети общего пользования информация о добавочном номере сотрудника внутри организации недоступна. Поле рекомендуется заполнять только в случае, если вышестоящая АТС предоставляет эту информацию.

Используется системой только для входящих звонков. Для остальных направлений следует оставлять поле незаполненным.