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 | (readonly) ID del tipo de medio. |
| name (obligatorio) |
cadena | Nombre del tipo de medio. |
| type (obligatorio) |
entero | Transporte utilizado por el tipo de medio. Valores posibles: 0 - correo electrónico; 1 - script; 2 - SMS; 4 - Webhook. |
| exec_path | cadena | Para los tipos de medios de script, exec_path contiene el nombre del script ejecutado.Obligatorio para los tipos de medios de script. |
| gsm_modem | cadena | Nombre del dispositivo serial del módem GSM. Requerido para los tipos de medios SMS. |
| passwd | cadena | Contraseña de autenticación. Se utiliza para los tipos de medios de correo electrónico. |
| smtp_email | cadena | Dirección de correo electrónico desde la que se enviarán las notificaciones. Requerido para los tipos de medios de correo electrónico. |
| smtp_helo | cadena | SMTP HELO. Requerido para los tipos de medios de correo electrónico. |
| smtp_server | cadena | Servidor SMTP. Requerido para los tipos de medios de correo electrónico. |
| smtp_port | entero | Puerto del servidor SMTP al que conectarse. |
| smtp_security | entero | Nivel de seguridad de la conexión SMTP a utilizar. Valores posibles: 0 - Ninguno; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | entero | Equipo de verificación SSL para SMTP. Valores posibles: 0 - No; 1 - Sí. |
| smtp_verify_peer | entero | Punto de verificación SSL 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. |
| username | cadena | Nombre de usuario. Se utiliza para los tipos de medios de correo electrónico. |
| exec_params | cadena | Parámetros de script. Cada parámetro termina con un nuevo salto de línea. |
| maxsessions | entero | El número máximo de alertas que se pueden procesar en paralelo. Valores posibles para SMS: 1 - (predeterminado) Valores posibles para otros tipos de medios: 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 los intentos de reintento. Acepta segundos y unidades de tiempo con sufijo. Valores posibles: 0-1h Valor predeterminado: 10s |
| content_type | entero | Formato del mensaje. Valores posibles: 0 - texto sin formato; 1 - (predeterminado) html. |
| script | texto | Tipo de medio: cuerpo de script de webhook en javascript. |
| timeout | cadena | Tipo de medio: tiempo de espera de script de webhook. Acepta segundos y unidades de tiempo con sufijo. Valores posibles: 1-60s Valor predeterminado: 30s |
| process_tags | entero | Define si la respuesta del script del webhook debe interpretarse como etiquetas y si estas etiquetas deben agregarse al evento asociado. Posibles valores: 0 - (predeterminado) Ignorar la respuesta del script del webhook. 1 - Procesar la respuesta del script del webhook como etiquetas. |
| show_event_menu | entero | Mostrar la entrada del tipo de medio en la propiedad urls de problem.get y event.get.Posibles valores: 0 - (predeterminado) No agregar la entrada urls.1 - Agregar el tipo de medio a la propiedad urls. |
| event_menu_url | cadena | Definir la propiedad url de la entrada del 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 de webhook. |
| description | texto | Descripción del tipo de medio. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros obligatorios/opcionales es diferente.
Parámetros del webhook
Los parámetros pasados al script de webhook cuando se llama, tienen las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name (obligatorio) |
cadena | Nombre del parámetro. |
| 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 las operaciones de acción para enviar una notificación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| eventsource (obligatorio) |
entero | Fuente del evento. Valores posibles: 0 - desencadenantes; 1 - descubrimiento; 2 - registro automático;<br >3 - interno; 4 - servicios. |
| recovery (obligatorio) |
entero | Modo de operación. Valores posibles: 0 - operaciones; 1 - operaciones de recuperación; 2 - operaciones de actualización. |
| subject | cadena | Asunto del mensaje. |
| message | cadena | Texto del mensaje. |