Documentation
Table of Contents
> Objeto de tipo de m¨ªdia
Os objetos a seguir est?o diretamente relacionados ¨¤ API mediatype.
Tipo de m¨ªdia
O objeto de tipo de m¨ªdia tem as seguintes propriedades.
| Propriedade | Tipo | Descri??o |
|---|---|---|
| mediatypeid | string | (somente leitura) ID do tipo de m¨ªdia. |
| name (requerido) |
string | Nome do tipo de m¨ªdia. |
| type (requerido) |
integer | Transporte usado pelo tipo de m¨ªdia. Valores poss¨ªveis: 0 - email; 1 - script; 2 - SMS; 4 - Webhook. |
| exec_path | string | Para tipos de m¨ªdia de script, exec_path cont¨¦m o nome do script executado.Obrigat¨®rio para tipos de m¨ªdia de script. |
| gsm_modem | string | Nome do dispositivo serial do modem GSM. Obrigat¨®rio para tipos de m¨ªdia SMS. |
| smtp_email | string | Endere?o de e-mail do qual as notifica??es ser?o enviadas. Obrigat¨®rio para tipos de m¨ªdia de e-mail. |
| smtp_helo | string | SMTP HELO. Obrigat¨®rio para tipos de m¨ªdia de e-mail. |
| smtp_server | string | SMTP server. Obrigat¨®rio para tipos de m¨ªdia de e-mail. |
| smtp_port | integer | Porta do servidor SMTP para se conectar. |
| smtp_security | integer | N¨ªvel de seguran?a de conex?o SMTP a ser usado. Valores poss¨ªveis: 0 - Nenhum; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | Host de verifica??o SSL para SMTP. Valores poss¨ªveis: 0 - N?o; 1 - Sim. |
| smtp_verify_peer | integer | SSL verificar peer para SMTP. Valores poss¨ªveis: 0 - N?o; 1 - Sim. |
| smtp_authentication | integer | M¨¦todo de autentica??o SMTP a ser usado. Valores poss¨ªveis: 0 - Nenhum; 1 - Senha normal. |
| status | integer | Se o tipo de m¨ªdia est¨¢ ativado. Valores poss¨ªveis: 0 - (padr?o) ativado; 1 - desativado. |
| username | string | User name. Usado para tipos de m¨ªdia de e-mail. |
| exec_params | string | Par?metros de script. Cada par?metro termina com um novo feed de linha. |
| maxsessions | integer | O n¨²mero m¨¢ximo de alertas que podem ser processados ??em paralelo. Valores poss¨ªveis para SMS: 1 - (padr?o) Valores poss¨ªveis para outros tipos de m¨ªdia: 0 -100 |
| maxattempts | integer | O n¨²mero m¨¢ximo de tentativas para enviar um alerta. Valores poss¨ªveis: 1-100 Valor padr?o: 3 |
| attempt_interval | string | O intervalo entre as tentativas de repeti??o. Aceita segundos e unidade de tempo com sufixo. Valores poss¨ªveis: 0-1h Valor padr?o: 10s |
| content_type | integer | Formato da mensagem. Valores poss¨ªveis: 0 - texto simples; 1 - (padr?o) html. |
| script | string | Corpo de javascript do script de webhook do tipo de m¨ªdia. |
| timeout | string | Tempo limite do script de webhook do tipo de m¨ªdia. Aceita segundos e unidade de tempo com sufixo. Valores poss¨ªveis: 1-60s Valor padr?o: 30s |
| process_tags | integer | Define se a resposta do script do webhook deve ser interpretada como tags e essas tags devem ser adicionadas ao evento associado. Valores poss¨ªveis: 0 - (padr?o) Ignorar resposta do script do webhook. 1 - Processar a resposta do script do webhook como tags. |
| show_event_menu | integer | Mostrar entrada de tipo de m¨ªdia na propriedade problem.get e event.get urls.Valores poss¨ªveis: 0 - (padr?o) N?o adicionar entrada urls.>1 - Adicionar tipo de m¨ªdia ¨¤ propriedade urls. |
| event_menu_url | string | Defina a propriedade url da entrada do tipo de m¨ªdia na propriedade urls de problem.get e event.get. |
| event_menu_name | string | Defina a propriedade name da entrada do tipo de m¨ªdia na propriedade urls de problem.get e event.get. |
| parameters | array | Array de par?metros de entrada do webhook. |
| description | string | Descri??o do tipo de m¨ªdia. |
Par?metros do webhook
Os par?metros passados ??para o script de webhook quando ele ¨¦ chamado t¨ºm as seguintes propriedades.
| Propriedade | Tipo | Descri??o |
|---|---|---|
| name (requerido) |
string | Nome do par?metro. |
| value | string | Valor do par?metro, macros de suporte. Macros compat¨ªveis descritas na ±è¨¢²µ¾±²Ô²¹. |
Script parameters
Parameters passed to a script when it is being called have the following properties.
| Property | Type | Description |
|---|---|---|
| sortorder (required) |
integer | The order in which the parameters will be passed to the script as command-line arguments. Starting with 0 as the first one. |
| value | string | Parameter value, supports macros. Supported macros are described on the Supported macros page. |
Modelo de mensagem
O objeto de modelo de mensagem define um modelo que ser¨¢ usado como mensagem padr?o para opera??es de a??o para enviar uma notifica??o. Tem as seguintes propriedades.
| Propriedade | Tipo | Descri??o |
|---|---|---|
| eventsource (requerido) |
integer | Origem do evento. Valores poss¨ªveis: 0 - acionadores; 1 - descoberta; 2 - registro autom¨¢tico; 3 - interno; 4 - servi?os. |
| recovery (requerido) |
integer | Modo de opera??o. Valores poss¨ªveis: 0 - opera??es; 1 - opera??es de recupera??o; 2 - opera??es de atualiza??o. |
| subject | string | Assunto da mensagem. |
| message | string | Mensagem de texto. |