Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

> 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 página.

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.