Почтовые оповещения о событиях на внутреннем номере (/mail_notification/)

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

Данный ресурс предназначен для указания почтовых адресов, на которые будут направлены сообщения о каком-либо событии на внутреннем номере (например, о пропущенном вызове).

Описание структур данных

Имя

Тип

Описание

Имя

Тип

Описание

mail

string

Почтовый адрес или несколько адресов, перечисленных через запятую

event_type

string

Имя события. Возможные варианты:

  • "call_failed_mail" — доступно для внутренних номеров типа “IVR (голосовое меню)”. Возникает, если вызов после попадания в голосовое меню не был соединен с конечным устройством

id

long

Уникальный (для внутреннего номера) идентификационный номер оповещения

Пример

Установим оповещения о неотвеченных вызовах, пришедших в голосовое меню (IVR) с номером 099:

Ответ системы:

{ "mail": "admin@myhost", "id": 20, "event_type": "call_failed_mail" }

Ресурсы раздела "Внутренний номер"

POST /extension/{extension_id}/mail_notification/

Добавить оповещение о событии на внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

Имя

Тип

Обязательный

mail

string

да

event_type

string

да

Поля ответа

Имя

Тип

Имя

Тип

mail

string

event_type

string

id

long

GET /extension/{extension_id}/mail_notification/

Получить список оповещений о событиях на внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

Поля ответа

Имя

Тип

Имя

Тип

mail

string

event_type

string

id

long

PUT /extension/{extension_id}/mail_notification/{id}

Обновить оповещение о событии на внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

id

integer

Параметры JSON

Имя

Тип

Обязательный

Имя

Тип

Обязательный

mail

string

нет

event_type

string

нет

Поля ответа

Имя

Тип

Имя

Тип

mail

string

event_type

string

id

long

GET /extension/{extension_id}/mail_notification/{id}

Получить оповещение о событии на внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

id

integer

Поля ответа

Имя

Тип

Имя

Тип

mail

string

event_type

string

id

long

DELETE /extension/{extension_id}/mail_notification/{id}

Удалить оповещение о событии на внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

string

id

integer