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

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

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

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

Свойство Тип Описание
mediatypeid ID ID способа оповещения.

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

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

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

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

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

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

Поведение свойства:
- поддерживается, если smtp_authentication установлен в значение "Обычный пароль"
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 - Обычный пароль;
2 - OAuth token.
Аутентификация OAuth не допускается для провайдера электронной почты Office365 relay.

Поведение свойства:
- поддерживается, если type установлен в значение "Email"
redirection_url string URL веб-интерфейса Zabbix для обратного перенаправления OAuth-авторизации.

По умолчанию:
Значение свойства настроек API url с частью zabbix.php?action=oauth.authorize

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
client_id string Идентификатор клиента, зарегистрированный на сервере OAuth-авторизации.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
client_secret string Секрет клиента, зарегистрированный на сервере OAuth-авторизации. Доступен только пользователю типа Super Admin.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
authorization_url string OAuth URL с параметрами для получения токенов доступа и обновления.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
token_url string OAuth URL для обмена токена авторизации на токены доступа и обновления.
Этот URL также используется сервером для обновления недействительного токена доступа.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
tokens_status integer Битовая маска состояния токенов.

Возможные значения:
0 - (по умолчанию) Оба токена содержат недействительное значение
1 - Токен доступа содержит действительное значение
2 - Токен обновления содержит действительное значение
3 - Оба токена содержат действительное значение.

Поведение свойства:
- поддерживается, если smtp_authentication установлен в значение "OAuth token"
access_token string Значение токена доступа OAuth.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
access_token_updated timestamp Метка времени последнего изменения access_token, выполненного сервером при обновлении с помощью refresh_token или API при изменении токенов.

Поведение свойства:
- поддерживается, если smtp_authentication установлен в значение "OAuth token"
access_expires_in integer Время в секундах, по истечении которого access_token устареет и потребуется выполнить запрос к refresh_url.
Устанавливается сервером Zabbix при обновлении access_token или API при изменении токенов.

Метка времени вычисляется добавлением значения access_token_updated.

Поведение свойства:
- поддерживается, если smtp_authentication установлен в значение "OAuth token"
refresh_token string Значение токена обновления OAuth.

Поведение свойства:
- обязательно, если smtp_authentication установлен в значение "OAuth token"
status integer Включен ли способ оповещения.

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

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

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

Возможные значения, если type установлен в значение "Email", "Скрипт" или "Вебхук": 0-100.

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

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

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

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

По умолчанию: 10s.
message_format integer Формат сообщения.

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

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

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

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

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

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

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

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

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

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

Поведение свойства:
- поддерживается, если show_event_menu установлен в значение "Включать запись меню события и свойство urls"
event_menu_name string Имя, используемое для записи меню события и в свойстве urls, возвращаемом problem.get и event.get.

Поведение свойства:
- поддерживается, если show_event_menu установлен в значение "Включать запись меню события и свойство urls"
parameters array Параметры вебхука или скрипта.

Поведение свойства:
- поддерживается, если type установлен в значение "Вебхук" или "Скрипт"
description text Описание способа оповещения.

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

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

Свойство Тип Описание
name string Имя параметра.

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

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

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

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

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

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

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

Свойство Type Описание
eventsource integer Источник события.

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

Поведение свойства:
- обязательно
recovery integer Режим операции.

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

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