Objeto media type

Os seguintes objetos estão diretamente relacionados à API mediatype.

Tipo de mídia

O objeto do tipo de mídia possui as seguintes propriedades.

Property Type Description
mediatypeid ID ID do tipo de mídia.

Property behavior:
- somente leitura
- obrigatório para operações de atualização
name string Nome do tipo de mídia.

Property behavior:
- obrigatório para operações de criação
type integer Transporte usado pelo tipo de mídia.

Valores possíveis:
0 - Email;
1 - Script;
2 - SMS;
4 - Webhook.

Property behavior:
- obrigatório para operações de criação
exec_path string Nome do arquivo de script (por exemplo, notification.sh) localizado no diretório especificado no parâmetro de configuração do server AlertScriptsPath.

Property behavior:
- obrigatório se type estiver definido como "Script"
gsm_modem string Nome do dispositivo serial do modem GSM.

Property behavior:
- obrigatório se type estiver definido como "SMS"
passwd string Senha de autenticação.

Property behavior:
- suportado se smtp_authentication estiver definido como "Normal password"
provider integer Provedor de email.

Valores possíveis:
0 - (padrão) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string Endereço de email a partir do qual as notificações serão enviadas.

Property behavior:
- obrigatório se type estiver definido como "Email"
smtp_helo string SMTP HELO.

Property behavior:
- suportado se type estiver definido como "Email"
smtp_server string SMTP server.

Property behavior:
- obrigatório se type estiver definido como "Email"
smtp_port integer Porta do SMTP server para conexão.

Padrão: 25.

Property behavior:
- suportado se type estiver definido como "Email"
smtp_security integer Nível de segurança da conexão SMTP a ser usado.

Valores possíveis:
0 - (padrão) Nenhum;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- suportado se type estiver definido como "Email"
smtp_verify_host integer Verificação SSL do host para SMTP.

Valores possíveis:
0 - (padrão) Não;
1 - Sim.

Property behavior:
- suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS"
smtp_verify_peer integer Verificação SSL do peer para SMTP.

Valores possíveis:
0 - (padrão) Não;
1 - Sim.

Property behavior:
- suportado se smtp_security estiver definido como "STARTTLS" ou "SSL/TLS"
smtp_authentication integer Método de autenticação SMTP a ser usado.

Valores possíveis:
0 - (padrão) Nenhum;
1 - Normal password.

Property behavior:
- suportado se type estiver definido como "Email"
status integer Se o tipo de mídia está habilitado.

Valores possíveis:
0 - (padrão) Habilitado;
1 - Desabilitado.
username string Nome de usuário.

Property behavior:
- suportado se smtp_authentication estiver definido como "Normal password"
maxsessions integer Número máximo de alertas que podem ser processados em paralelo.

Valores possíveis se type estiver definido como "SMS": 1.

Valores possíveis se type estiver definido como "Email", "Script" ou "Webhook": 0-100.

Padrão: 1.
maxattempts integer Número máximo de tentativas para enviar um alerta.

Valores possíveis: 1-100.

Padrão: 3.
attempt_interval string Intervalo entre tentativas de nova execução.
Aceita segundos e unidade de tempo com sufixo.

Valores possíveis: 0-1h.

Padrão: 10s.
content_type
(deprecated)		 integer Este parâmetro está obsoleto, use message_format em seu lugar.
Formato da mensagem.

Valores possíveis:
0 - Texto simples;
1 - (padrão) HTML.

Property behavior:
- suportado se type estiver definido como "Email"
message_format integer Formato da mensagem.

Valores possíveis:
0 - Texto simples;
1 - (padrão) HTML.

Property behavior:
- suportado se type estiver definido como "Email"
script text Corpo do script do Webhook (JavaScript).

Property behavior:
- obrigatório se type estiver definido como "Webhook"
timeout string Tempo limite do script do Webhook.
Aceita segundos e unidade de tempo com sufixo.

Valores possíveis: 1-60s.

Padrão: 30s.

Property behavior:
- suportado se type estiver definido como "Webhook"
process_tags integer Processa os valores das propriedades JSON na resposta do script do Webhook como tags. Essas tags são adicionadas a quaisquer tags de problema já existentes.

Valores possíveis:
0 - (padrão) Ignorar a resposta do script do Webhook;
1 - Processar a resposta do script do Webhook como tags.

Property behavior:
- suportado se type estiver definido como "Webhook"
show_event_menu integer Inclui uma entrada no menu de eventos que aponta para uma URL personalizada. Também adiciona a propriedade urls à saída de problem.get e event.get.

Valores possíveis:
0 - (padrão) Não incluir a entrada do menu de eventos nem a propriedade urls;
1 - Incluir a entrada do menu de eventos e a propriedade urls.

Property behavior:
- suportado se type estiver definido como "Webhook"
event_menu_url string URL usada na entrada do menu de eventos e na propriedade urls retornada por problem.get e event.get.

Property behavior:
- suportado se show_event_menu estiver definido como "Incluir entrada do menu de eventos e propriedade urls"
event_menu_name string Nome usado para a entrada do menu de eventos e na propriedade urls retornada por problem.get e event.get.

Property behavior:
- suportado se show_event_menu estiver definido como "Incluir entrada do menu de eventos e propriedade urls"
parameters array Parâmetros de Webhook ou script.

Property behavior:
- suportado se type estiver definido como "Webhook" ou "Script"
description text Descrição do tipo de mídia.

Parâmetros do webhook

Os parâmetros do webhook possuem as seguintes propriedades.

Propriedade Tipo Descrição
name string Nome do parâmetro.

Comportamento da propriedade:
- obrigatório
value string Valor do parâmetro, suporta macros.
As macros suportadas estão descritas na página Macros suportadas.

Parâmetros do script

Os parâmetros do script possuem as seguintes propriedades.

Propriedade Tipo Descrição
sortorder integer A ordem em que os valores dos parâmetros serão passados para o script como argumentos de linha de comando, começando com 0 como o primeiro.

Comportamento da propriedade:
- obrigatório
value string Valor do parâmetro, suporta macros.
As macros suportadas estão descritas na página Macros suportadas.

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. Ele possui as seguintes propriedades.

Propriedade Tipo Descrição
eventsource integer Fonte do evento.

Valores possíveis:
0 - Triggers;
1 - Descoberta;
2 - Autoregistro;
3 - Interno;
4 - Serviços.

Comportamento da propriedade:
- obrigatório
recovery integer Modo de operação.

Valores possíveis:
0 - Operações;
1 - Operações de recuperação;
2 - Operações de atualização.

Comportamento da propriedade:
- obrigatório
subject string Assunto da mensagem.
message string Texto da mensagem.