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

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

Тип медиа

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

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

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

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

Возможные значения:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Поведение свойства:
- обязательно для операций создания
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 host для SMTP.

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

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

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

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

Возможные значения:
0 - (по умолчанию) Нет;
1 - Normal password;
2 - OAuth token.
Аутентификация OAuth не разрешена для почтового провайдера Office365 relay.

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

По умолчанию:
Значение свойства API settings 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 URL OAuth с параметрами для получения токенов доступа и обновления.

Поведение свойства:
- обязательно, если smtp_authentication установлен в "OAuth token"
token_url string URL OAuth для обмена токена авторизации на токены доступа и обновления.
Этот 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 установлен в "Normal password"
maxsessions integer Максимальное число оповещений, которые могут обрабатываться параллельно.

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

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

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

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

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

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

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

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

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

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

Возможные значения: 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 Текст сообщения.