Documentation
Table of Contents
> Объект способа оповещения
Следующие объекты напрямую связаны с mediatype API.
Способ оповещения
Объект способа оповещения имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| mediatypeid | строка | (только чтение) ID способа оповещения. |
| name (требуется) |
строка | Имя способа оповещения. |
| type (требуется) |
целое число | Транспорт используемый способом оповещения. Возможные значения: 0 - e-mail; 1 - скрипт; 2 - SMS. |
| exec_path | строка | В способах оповещений с типом скрипт свойство exec_path содержит имя выполняемого скрипта.Требуется при способах оповещений с типом скрипт. |
| gsm_modem | строка | Имя серийного устройства GSM модема. Требуется при способе оповещения с типом SMS. |
| passwd | строка | Пароль аутентификации. Требуется при способах оповещений с типом скрипт. |
| smtp_email | строка | Email адрес с которого будут отправляться оповещения. Требуется при способе оповещения с типом email. |
| smtp_helo | строка | SMTP HELO. Требуется при способе оповещения с типом email. |
| smtp_server | строка | SMTP сервер. Требуется при способе оповещения с типом email. |
| smtp_port | целое число | Порт SMTP сервера, к которому необходимо подключаться. |
| smtp_security | целое число | Используемый уровень безопасности SMTP соединения. Возможные значения: 0 - Нет; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | целое число | Проверка SSL узла для SMTP. Возможные значения: 0 - Нет; 1 - Да. |
| smtp_verify_peer | целое число | Проверка SSL хоста для SMTP. Возможные значения: 0 - Нет; 1 - Да. |
| smtp_authentication | целое число | Используемый метод SMTP аутентификации. Возможные значения: 0 - Нет; 1 - Нормальный пароль. |
| status | целое число | Активирован ли способ оповещения. Возможные значения: 0 - (по умолчанию) активирован; 1 - деактивирован. |
| username | строка | Имя пользователя или Jabber идентификатор. Требуется при способах оповещений с типом скрипт. |
| exec_params | строка | Параметры скрипта. Каждый параметр заканчивается переводом на новую строку. |
| maxsessions | целое число | Максимальное количество оповещений, которые можно обрабатывать одновременно. Возможные значения для SMS: 1 - (по умолчанию) Возможные значения для остальных типов способов оповещений: 0-100 |
| maxattempts | целое число | Максимальное количество попыток отправки оповещения. Возможные значения: 1-10 Значение по умолчанию: 3 |
| attempt_interval | строка | Интервал между попытками отправки. Принимает секунды и единицы времени с суффиксом. Возможные значения: 0-60s Значение по умолчанию: 10s |
| content_type | целое число | Формат сообщения. Возможные значения: 0 - простой текст; 1 - (по умолчанию) html. |
| script | строка | Тело javascript для способа оповещения webhook. Требуется при способах оповещений с типом Webhook. |
| timeout | строка | Время ожидания скрипта способа оповещения webhook. Принимает секунды и единицы времени с суффиксом. Возможные значения: 1-60s Значение по умолчанию: 30s |
| process_tags | целое число | Определение должен ли ответ webhook скрипта интерпретироваться в виде тегов и должны ли эти теги добавляться к связанному событию. Возможные значения: 0 - (по умолчанию) Игнорировать ответ webhook скрипта. 1 - Обрабатывать ответ webhook скрипта тегами в виде тегов. |
| show_event_menu | целое число | Отображение записи способа оповещения в свойстве urls в problem.get и event.get.Возможные значения: 0 - (по умолчанию) Не добавлять запись urls.1 - Добавлять способ оповещения в urls свойство.Используется для способов оповещения с типом Webhook. |
| event_menu_url | строка | Определение свойства url записи способа оповещения в urls свойстве в problem.get и event.get.Используется для способов оповещения с типом Webhook. |
| event_menu_name | строка | Определение свойства name записи способа оповещения в urls свойстве в problem.get и event.get.Используется для способов оповещения с типом Webhook. |
| parameters | массив параметров webhook | Массив входных параметров webhook. |
| description | строка | Описание способа оповещения. |
Параметры Webhook
Параметры, которые передаются webhook скрипту при его вызове, имеют следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| name (требуется) |
строка | Имя параметра. |
| value | строка | Значение параметра, поддерживает макросы. Поддерживаемые макросы описаны на этой странице. |