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 | string | (readonly) ID del tipo de medio. |
| nombre (obligatorio) |
cadena | Nombre del tipo de medio. |
| tipo (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 tipos de medios de script, exec_path contiene el nombre del script ejecutado.Obligatorio para tipos de medios de script. |
| gsm_modem | string | Nombre del dispositivo serie del módem GSM. Obligatorio para tipos de medios SMS. |
| passwd | string | Contraseña de autenticación. Se utiliza para tipos de medios de correo electrónico. |
| smtp_email | string | Dirección de correo electrónico desde la que se enviarán las notificaciones. Obligatorio para los tipos de medios de correo electrónico. |
| smtp_helo | string | SMTP HELO. Obligatorio para los tipos de medios de correo electrónico. |
| smtp_server | cadena | Servidor SMTP. Obligatorio para los tipos de medios de correo electrónico. |
| smtp_port | entero | Puerto del servidor SMTP al que conectarse. |
| smtp_security | integer | 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. Se utiliza para tipos de medios de correo electrónico. |
| exec_params | string | Parámetros del script. Cada parámetro termina con un nuevo avance de línea. |
| maxsessions | integer | 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 | integer | 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 unidades 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-60s Valor predeterminado: 30s |
| proceso_tags | integer | 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 | integer | 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. |
| evento_menu_name | cadena | Defina la propiedad nombre de la entrada de tipo de medio en la propiedad urls de problem.get y event.get. |
| parámetros | matriz | Matriz de parámetros de entrada del webhook. |
| descripción | cadena | Descripción del tipo de medio. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/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. |