Documentation
Table of Contents
Objeto de tipo de medio
Los siguientes objetos están directamente relacionados con la API mediatype.
Tipo de medio
El objeto de tipo de medio tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| mediatypeid | cadena | ID del tipo de medio. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| name | cadena | Nombre del tipo de medio. Comportamiento de la propiedad: - obligatorio para las operaciones de creación |
| type | entero | Transporte utilizado por el tipo de medio. Valores posibles: 0 - Correo electrónico; 1 - Script; 2 - SMS; 4 - Webhook.< br> Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| exec_path | string | Para tipos de medios de secuencias de comandos, exec_path contiene el nombre de la secuencia de comandos ejecutada.Comportamiento de la propiedad: - * requerido* si type está configurado en "Script" |
| gsm_modem | string | Nombre del dispositivo serie del módem GSM. Comportamiento de la propiedad: - obligatorio si type es establecido en "SMS" |
| contraseña | cadena | Contraseña de autenticación. Comportamiento de la propiedad: - compatible si type está configurado en "Correo electrónico" |
| smtp_email | string | Dirección de correo electrónico desde la que se enviarán las notificaciones. Comportamiento de la propiedad: - obligatorio si type está configurado en "Correo electrónico" |
| smtp_helo | string | SMTP HELO. Comportamiento de la propiedad: - obligatorio si type está configurado en "Correo electrónico" |
| smtp_server | cadena | Servidor SMTP. Comportamiento de la propiedad: - obligatorio si type está configurado en "Correo electrónico" |
| smtp_port | entero | Puerto del servidor SMTP al que conectarse. |
| smtp_security | entero | Nivel de seguridad de conexión SMTP a utilizar. Valores posibles: 0 - Ninguno; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL verificar host para SMTP. Valores posibles: 0 - No; 1 - Sí. |
| smtp_verify_peer | integer | Verificación SSL del par para SMTP. Valores posibles: 0 - No; 1 - Sí. |
| smtp_authentication | entero | Método de autenticación SMTP a utilizar. Valores posibles: 0 - Ninguno; 1 - Contraseña normal. |
| status | entero | Si el tipo de medio está habilitado. Valores posibles: 0 - (predeterminado) Habilitado; 1 - Deshabilitado. |
| nombre de usuario | cadena | Nombre de usuario. Comportamiento de la propiedad: - compatible si type está configurado en "Correo electrónico" |
| maxsessions | entero | El número máximo de alertas que se pueden procesar en paralelo. Valores posibles si tipo está configurado en "SMS": (predeterminado) 1.Posible valores si tipo está configurado en "Correo electrónico", "Script" o "Webhook": 0-100. |
| maxattempts | entero | El número máximo de intentos para enviar una alerta. Valores posibles: 1-100. Valor predeterminado: 3. |
| attempt_interval | cadena | El intervalo entre reintentos. Acepta segundos y unidad de tiempo con sufijo. Valores posibles: 0-1h. Valor predeterminado: 10s. |
| content_type | entero | Formato de mensaje. Valores posibles: 0 - texto sin formato; 1 - (predeterminado) html. |
| script | cadena | Cuerpo de javascript del script de webhook de tipo de medio. |
| timeout | string | Tiempo de espera del script de webhook del tipo de medio. Acepta segundos y unidades de tiempo con sufijo. Valores posibles: 1-60 s. Predeterminado: 30 s. |
| process_tags | entero | Define si la respuesta del script del webhook debe interpretarse como etiquetas y estas etiquetas deben agregarse al evento asociado. Valores posibles: 0 - (predeterminado) Ignorar el script del webhook respuesta; 1 - Procesar la respuesta del script del webhook como etiquetas. |
| show_event_menu | entero | Mostrar la entrada de tipo de medio en problem.get y event.get propiedad urls.Valores posibles: 0 - (predeterminado) Hacer no agregar la entrada urls;1 - Agregar tipo de medio a la propiedad urls. |
| event_menu_url | string | Defina la propiedad url de la entrada de tipo de medio en la propiedad urls de problem.get y event.get. |
| event_menu_name | cadena | Defina la propiedad name de la entrada de tipo de medio en la propiedad urls de problem.get y event.get. |
| parameters | matriz | Matriz de parámetros de entrada webhook o script. |
| description | cadena | Descripción del tipo de medio. |
Parámetros del webhook
Los parámetros pasados a un script de webhook cuando se llama tienen las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | cadena | Nombre del parámetro. Comportamiento de la propiedad: - obligatorio |
| value | cadena | Valor del parámetro, admite macros. Las macros admitidas se describen en la página Macros admitidas. |
Parámetros de secuencia de comandos
Los parámetros pasados a un script cuando se llama tienen las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| sortorder | entero | El orden en el que 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: - obligatorio |
| value | cadena | Valor del parámetro, admite macros. Las macros admitidas se describen en la página Macros admitidas. |
Plantilla de mensaje
El objeto de plantilla de mensaje define una plantilla que se utilizará como mensaje predeterminado para operaciones de acción para enviar una notificación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| eventsource | entero | Fuente del evento. Valores posibles: 0 - desencadenantes; 1 - descubrimiento; 2 - registro automático; 3 - interno; 4 - servicios. Comportamiento de la propiedad: - obligatorio |
| recovery | entero | Modo de operación. Valores posibles: 0 - operaciones; 1 - operaciones de recuperación; 2 - operaciones de actualización. [Comportamiento de la propiedad] (/manual/api/reference_commentary#property-behavior): - obligatorio |
| subject | cadena | Asunto del mensaje. |
| message | cadena | Texto del mensaje. |