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

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

Тип медиа

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

Property Type Description
mediatypeid ID ID типа медиа.

Property behavior:
- только для чтения
- обязательно для операций обновления
name string Имя типа медиа.

Property behavior:
- обязательно для операций создания
type integer Транспорт, используемый типом медиа.

Possible values:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Property behavior:
- обязательно для операций создания
exec_path string Имя файла скрипта (например, notification.sh), расположенного в каталоге, указанном в параметре конфигурации сервера AlertScriptsPath.

Property behavior:
- обязательно если type установлен в "Script"
gsm_modem string Имя последовательного устройства GSM-модема.

Property behavior:
- обязательно если type установлен в "SMS"
passwd string Пароль аутентификации.

Property behavior:
- поддерживается если smtp_authentication установлен в "Normal password"
provider integer Почтовый провайдер.

Possible values:
0 - (default) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Адрес электронной почты, с которого будут отправляться уведомления.

Property behavior:
- обязательно если type установлен в "Email"
smtp_helo string SMTP HELO.

Property behavior:
- поддерживается если type установлен в "Email"
smtp_server string SMTP-сервер.

Property behavior:
- обязательно если type установлен в "Email"
smtp_port integer Порт SMTP-сервера для подключения.

Default: 25.

Property behavior:
- поддерживается если type установлен в "Email"
smtp_security integer Уровень безопасности SMTP-соединения, который следует использовать.

Possible values:
0 - (default) None;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- поддерживается если type установлен в "Email"
smtp_verify_host integer Проверка SSL host для SMTP.

Possible values:
0 - (default) No;
1 - Yes.

Property behavior:
- поддерживается если smtp_security установлен в "STARTTLS" или "SSL/TLS"
smtp_verify_peer integer Проверка SSL peer для SMTP.

Possible values:
0 - (default) No;
1 - Yes.

Property behavior:
- поддерживается если smtp_security установлен в "STARTTLS" или "SSL/TLS"
smtp_authentication integer Метод SMTP-аутентификации, который следует использовать.

Possible values:
0 - (default) None;
1 - Normal password.

Property behavior:
- поддерживается если type установлен в "Email"
status integer Включен ли тип медиа.

Possible values:
0 - (default) Enabled;
1 - Disabled.
username string Имя пользователя.

Property behavior:
- поддерживается если smtp_authentication установлен в "Normal password"
maxsessions integer Максимальное число оповещений, которые могут обрабатываться параллельно.

Possible values if type is set to "SMS": 1.

Possible values if type is set to "Email", "Script", or "Webhook": 0-100.

Default: 1.
maxattempts integer Максимальное число попыток отправки оповещения.

Possible values: 1-100.

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

Possible values: 0-1h.

Default: 10s.
content_type
(deprecated)		 integer Этот параметр устарел, используйте вместо него message_format.
Формат сообщения.

Possible values:
0 - Plain text;
1 - (default) HTML.

Property behavior:
- поддерживается если type установлен в "Email"
message_format integer Формат сообщения.

Possible values:
0 - Plain text;
1 - (default) HTML.

Property behavior:
- поддерживается если type установлен в "Email"
script text Тело скрипта вебхука (JavaScript).

Property behavior:
- обязательно если type установлен в "Webhook"
timeout string Тайм-аут скрипта вебхука.
Принимает секунды и единицу времени с суффиксом.

Possible values: 1-60s.

Default: 30s.

Property behavior:
- поддерживается если type установлен в "Webhook"
process_tags integer Обрабатывать значения свойств JSON в ответе скрипта вебхука как теги. Эти теги добавляются к любым существующим тегам проблемы.

Possible values:
0 - (default) Ignore webhook script response;
1 - Process webhook script response as tags.

Property behavior:
- поддерживается если type установлен в "Webhook"
show_event_menu integer Добавлять пункт в меню событий, который ведет на пользовательский URL. Также добавляет свойство urls в результат problem.get и event.get.

Possible values:
0 - (default) Do not include event menu entry or urls property;
1 - Include event menu entry and urls property.

Property behavior:
- поддерживается если type установлен в "Webhook"
event_menu_url string URL, используемый в пункте меню событий и в свойстве urls, возвращаемом problem.get и event.get.

Property behavior:
- поддерживается если show_event_menu установлен в "Include event menu entry and urls property"
event_menu_name string Имя, используемое в пункте меню событий и в свойстве urls, возвращаемом problem.get и event.get.

Property behavior:
- поддерживается если show_event_menu установлен в "Include event menu entry and urls property"
parameters array Параметры вебхука или скрипта.

Property behavior:
- поддерживается если type установлен в "Webhook" или "Script"
description text Описание типа медиа.

Параметры вебхука

Параметры вебхука имеют следующие свойства.

Property Type Description
name string Имя параметра.

Поведение свойства:
- required
value string Значение параметра, поддерживает макросы.
Поддерживаемые макросы описаны на странице Поддерживаемые макросы.

Параметры скрипта

Параметры скрипта имеют следующие свойства.

Property Type Description
sortorder integer Порядок, в котором значения параметров будут передаваться скрипту как аргументы командной строки, начиная с 0 как первого.

Property behavior:
- required
value string Значение параметра, поддерживает макросы.
Поддерживаемые макросы описаны на странице Supported macros.

Шаблон сообщения

Объект шаблона сообщения определяет шаблон, который будет использоваться как сообщение по умолчанию для операций действия при отправке уведомления. Он имеет следующие свойства.

Property Type Description
eventsource integer Источник события.

Возможные значения:
0 - Триггеры;
1 - Обнаружение;
2 - Автоматическая регистрация;
3 - Внутренние;
4 - Сервисы.

Поведение свойства:
- required
recovery integer Режим операции.

Возможные значения:
0 - Операции;
1 - Операции восстановления;
2 - Операции обновления.

Поведение свойства:
- required
subject string Тема сообщения.
message string Текст сообщения.