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

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

Тип носителя

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

Свойство Тип Описание
mediatypeid ID Идентификатор типа носителя.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
name string Название типа носителя.

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

Возможные значения:
0 - Электронная почта;
1 - Скрипт;
2 - SMS;
4 - Вебхук.

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

Поведение свойства:
- обязательно, если для type установлено значение «Script»
gsm_modem string Имя последовательного устройства GSM-модема.

Поведение свойства:
- обязательно, если для type установлено значение «SMS»
passwd string Пароль аутентификации.

Поведение свойства:
- поддерживается, если для smtp_authentication установлено значение «Normal password»
provider integer Поставщик электронной почты.

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

Поведение свойства:
- обязательно, если для type установлено значение «Email»
smtp_helo string SMTP HELO.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
smtp_server string SMTP-сервер.

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

По умолчанию: 25.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
smtp_security integer Уровень безопасности SMTP-соединения.

Возможные значения:
0 - (по умолчанию) Нет;
1 - STARTTLS;
2 - SSL/TLS.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
smtp_verify_host integer Проверка узла сети SSL для SMTP.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Да.

Поведение свойства:
- поддерживается, если для smtp_security установлено значение «STARTTLS» или «SSL/TLS»
smtp_verify_peer integer Проверка узла сети SSL для SMTP.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Да.

Поведение свойства:
- поддерживается, если для smtp_security установлено значение «STARTTLS» или «SSL/TLS»
smtp_authentication integer Метод аутентификации SMTP.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Обычный пароль.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
status integer Определяет, включен ли тип носителя.

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

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

Возможные значения, если для type установлено значение «SMS»: 1.

Возможные значения, если для type установлено значение «Email», «Script» или «Webhook»: 0-100.

По умолчанию: 1.
maxattempts integer Максимальное количество попыток отправки уведомления.

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

По умолчанию: 3.
attempt_interval string Интервал между повторными попытками.
Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 1h).

Возможные значения: 0-1h.

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

Возможные значения:
0 - Обычный текст;
1 - (по умолчанию) HTML.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
message_format integer Формат сообщения.

Возможные значения:
0 - Обычный текст;
1 - (по умолчанию) HTML.

Поведение свойства:
- поддерживается, если для type установлено значение «Email»
script text Тело скрипта вебхука (JavaScript).

Поведение свойства:
- обязательно, если для type установлено значение «Webhook»
timeout string Тайм-аут скрипта вебхука.
Принимает количество секунд (например, 1, 60) или значение с суффиксом времени (например, 30s, 1m).

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

По умолчанию: 30s.

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

Возможные значения:
0 - (по умолчанию) Игнорировать ответ скрипта вебхука;
1 - Обрабатывать ответ скрипта вебхука как теги.

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

Возможные значения:
0 - (по умолчанию) Не добавлять запись в меню событий или свойство urls;
1 - Добавлять запись в меню событий и свойство urls.

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

Поведение свойства:
- поддерживается, если для show_event_menu установлено значение «Include event menu entry and urls property»
event_menu_name string Название, используемое для записи меню событий и в свойстве urls, возвращаемом методами problem.get и event.get.

Поведение свойства:
- поддерживается, если для show_event_menu установлено значение «Include event menu entry and urls property»
parameters array Параметры вебхука или скрипта.

Поведение свойства:
- поддерживается, если для 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 Текст сообщения.