Objeto de tipo de medio

Los siguientes objetos están directamente relacionados con la API mediatype.

Tipo de medio

El objeto tipo de medio tiene las siguientes propiedades.

Propiedad Tipo Descripción
mediatypeid ID ID del tipo de medio.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
name string Nombre del tipo de medio.

Comportamiento de la propiedad:
- requerido para operaciones de creación
type integer Transporte utilizado por el tipo de medio.

Valores posibles:
0 - Correo electrónico;
1 - Script;
2 - SMS;
4 - Webhook.

Comportamiento de la propiedad:
- requerido para operaciones de creación
exec_path string Nombre del archivo de script (por ejemplo, notification.sh) que se encuentra en el directorio especificado en el parámetro de configuración del server AlertScriptsPath.

Comportamiento de la propiedad:
- requerido si type está establecido en "Script"
gsm_modem string Nombre del dispositivo serie del módem GSM.

Comportamiento de la propiedad:
- requerido si type está establecido en "SMS"
passwd string Contraseña de autenticación.

Comportamiento de la propiedad:
- soportado si smtp_authentication está establecido en "Contraseña normal"
provider integer Proveedor de correo electrónico.

Valores posibles:
0 - (por defecto) SMTP genérico;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Dirección de correo electrónico desde la que se enviarán las notificaciones.

Comportamiento de la propiedad:
- requerido si type está establecido en "Email"
smtp_helo string SMTP HELO.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
smtp_server string Servidor SMTP.

Comportamiento de la propiedad:
- requerido si type está establecido en "Email"
smtp_port integer Puerto del servidor SMTP al que conectarse.

Por defecto: 25.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
smtp_security integer Nivel de seguridad de la conexión SMTP a utilizar.

Valores posibles:
0 - (por defecto) Ninguno;
1 - STARTTLS;
2 - SSL/TLS.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
smtp_verify_host integer Verificación SSL del host para SMTP.

Valores posibles:
0 - (por defecto) No;
1 - Sí.

Comportamiento de la propiedad:
- soportado si smtp_security está establecido en "STARTTLS" o "SSL/TLS"
smtp_verify_peer integer Verificación SSL del par para SMTP.

Valores posibles:
0 - (por defecto) No;
1 - Sí.

Comportamiento de la propiedad:
- soportado si smtp_security está establecido en "STARTTLS" o "SSL/TLS"
smtp_authentication integer Método de autenticación SMTP a utilizar.

Valores posibles:
0 - (por defecto) Ninguno;
1 - Contraseña normal.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
status integer Indica si el tipo de medio está habilitado.

Valores posibles:
0 - (por defecto) Habilitado;
1 - Deshabilitado.
username string Nombre de usuario.

Comportamiento de la propiedad:
- soportado si smtp_authentication está establecido en "Contraseña normal"
maxsessions integer El número máximo de alertas que se pueden procesar en paralelo.

Valores posibles si type está establecido en "SMS": 1.

Valores posibles si type está establecido en "Email", "Script" o "Webhook": 0-100.

Por defecto: 1.
maxattempts integer El número máximo de intentos para enviar una alerta.

Valores posibles: 1-100.

Por defecto: 3.
attempt_interval string El intervalo entre intentos de reintento.
Acepta segundos y unidad de tiempo con sufijo.

Valores posibles: 0-1h.

Por defecto: 10s.
content_type
(obsoleto)		 integer Este parámetro está obsoleto, por favor use message_format en su lugar.
Formato del mensaje.

Valores posibles:
0 - Texto plano;
1 - (por defecto) HTML.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
message_format integer Formato del mensaje.

Valores posibles:
0 - Texto plano;
1 - (por defecto) HTML.

Comportamiento de la propiedad:
- soportado si type está establecido en "Email"
script text Cuerpo del script de webhook (JavaScript).

Comportamiento de la propiedad:
- requerido si type está establecido en "Webhook"
timeout string Tiempo de espera del script de webhook.
Acepta segundos y unidad de tiempo con sufijo.

Valores posibles: 1-60s.

Por defecto: 30s.

Comportamiento de la propiedad:
- soportado si type está establecido en "Webhook"
process_tags integer Procesar los valores de las propiedades JSON en la respuesta del script de webhook como etiquetas. Estas etiquetas se añaden a cualquier etiqueta de problema existente.

Valores posibles:
0 - (por defecto) Ignorar la respuesta del script de webhook;
1 - Procesar la respuesta del script de webhook como etiquetas.

Comportamiento de la propiedad:
- soportado si type está establecido en "Webhook"
show_event_menu integer Incluir una entrada en el menú de eventos que enlace a una URL personalizada. También añade la propiedad urls a la salida de problem.get y event.get.

Valores posibles:
0 - (por defecto) No incluir entrada en el menú de eventos ni la propiedad urls;
1 - Incluir entrada en el menú de eventos y la propiedad urls.

Comportamiento de la propiedad:
- soportado si type está establecido en "Webhook"
event_menu_url string URL utilizada en la entrada del menú de eventos y en la propiedad urls devuelta por problem.get y event.get.

Comportamiento de la propiedad:
- soportado si show_event_menu está establecido en "Incluir entrada en el menú de eventos y la propiedad urls"
event_menu_name string Nombre utilizado para la entrada del menú de eventos y en la propiedad urls devuelta por problem.get y event.get.

Comportamiento de la propiedad:
- soportado si show_event_menu está establecido en "Incluir entrada en el menú de eventos y la propiedad urls"
parameters array Parámetros de webhook o parámetros de script.

Comportamiento de la propiedad:
- soportado si type está establecido en "Webhook" o "Script"
description text Descripción del tipo de medio.

Parámetros de webhook

Los parámetros de webhook tienen las siguientes propiedades.

Propiedad Tipo Descripción
name string Nombre del parámetro.

Comportamiento de la propiedad:
- obligatorio
value string Valor del parámetro, admite macros.
Las macros admitidas se describen en la página Macros admitidas.

Parámetros de script

Los parámetros de script tienen las siguientes propiedades.

Propiedad Tipo Descripción
sortorder integer El orden en que los valores de los parámetros se pasarán al script como argumentos de línea de comandos, comenzando con 0 como el primero.

Comportamiento de la propiedad:
- requerido
value string Valor del parámetro, admite macros.
Las macros admitidas se describen en la página Macros soportadas.

Plantilla de mensaje

El objeto de plantilla de mensaje define una plantilla que se utilizará como mensaje por defecto para las operaciones de acción para enviar una notificación. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
eventsource integer Fuente del evento.

Valores posibles:
0 - Triggers;
1 - Descubrimiento;
2 - Autoregistro;
3 - Interno;
4 - Servicios.

Comportamiento de la propiedad:
- obligatorio
recovery integer Modo de operación.

Valores posibles:
0 - Operaciones;
1 - Operaciones de recuperación;
2 - Operaciones de actualización.

Comportamiento de la propiedad:
- obligatorio
subject string Asunto del mensaje.
message string Texto del mensaje.