> Объект способа оповещения

Следующие объекты напрямую связаны с mediatype API.

Способ оповещения

Объект способа оповещения имеет следующие свойства.

Свойство Тип Описание
mediatypeid строка (только чтение) ID способа оповещения.
description
(требуется)
строка Имя способа оповещения.
type
(требуется)
целое число Транспорт используемый способом оповещения.

Возможные значения:
0 - e-mail;
1 - скрипт;
2 - SMS;
3 - Jabber;
100 - Ez Texting.
exec_path строка При способах оповещений при помощи скрипта свойство exec_path содержит имя выполняемого скрипта.

При Ez Texting свойство exec_path содержит ограничение текстового сообщения.
Возможные значения ограничения текста:
0 - США (160 символов);
1 - Канада (136 символов).

Требуется при способах оповещений с типами скрипт и Ez Texting.
gsm_modem строка Имя серийного устройства GSM модема.

Требуется при способе оповещения с типом SMS.
passwd строка Пароль аутентификации.

Требуется при способе оповещения с типами Jabber и Ez Texting.
smtp_email строка Email адрес с которого будут отправляться оповещения.

Требуется при способе оповещения с типом email.
smtp_helo строка SMTP HELO.

Требуется при способе оповещения с типом email.
smtp_server строка SMTP сервер.

Требуется при способе оповещения с типом email.
status целое число Активирован ли способ оповещения.

Возможные значения:
0 - (по умолчанию) активирован;
1 - деактивирован.
username строка Имя пользователя или Jabber идентификатор.

Требуется при способе оповещения с типами Jabber и Ez Texting.
exec_params строка Параметры скрипта.

Каждый параметр заканчивается переводом на новую строку.
maxsessions целое число Максимальное количество оповещений, которые можно обрабатывать одновременно.

Возможные значения для SMS:
1 - (по умолчанию)

Возможные значения для остальных типов способов оповещений:
0-100
maxattempts целое число Максимальное количество попыток отправки оповещения.

Возможные значения:
1-10

Значение по умолчанию:
3
attempt_interval строка Интервал между попытками отправки. Принимает секунды и единицы времени с суффиксом.

Возможные значения:
0-60s

Значение по умолчанию:
10s

Webhook parameters

Parameters passed to webhook script when it is called, have the following properties.

Property Type Description
name
(required)
string Parameter name.
value string Parameter value, support macros. Supported macros described on page.

Message template

The message template object defines a template that will be used as a default message for action operations to send a notification. It has the following properties.

Property Type Description
eventsource
(required)
integer Event source.

Possible values:
0 - triggers;
1 - discovery;
2 - autoregistration;
3 - internal.
recovery
(required)
integer Operation mode.

Possible values:
0 - operations;
1 - recovery operations;
2 - update operations.
subject string Message subject.
message string Message text.