Objecte de tipus de suport

Els següents objectes són relacionats amb l'API mediatype.

Tipus de suport

L'objecte de tipus de suport té les propietats següents.

Propietat Tipus Descripció
mediatypeid ID ID del tipus de suport.

Comportament de la propietat:
- només lectura
- obligatori per operacions d'actualització
name string Nom del tipus de suport.

Comportament de la propietat:
- obligatori en operacions de creació
type integer Transport emprat pel tipus de suport.

Valors possibles:
0 - correu-e;
1 - script;
2 - SMS;
4 - Webhook.

Comportament de la propietat:
- obligatori en operacions de creació
exec_path string Per als tipus de suport d'script, exec_path conté el nom de l'script executat.

Comportament de la propietat:
- obligatori si type és "Script"
gsm_modem string Nom del dispositiu sèrie del mòdem GSM.

Comportament de la propietat:
- obligatori si type és "SMS"
passwd string Mot de pas d'autenticació.

Comportament de la propietat:
- obligatori si type és "Correu-e"
smtp_email string Adreça de correu-e des de la que s'enviaran les notificacions.

Comportament de la propietat:
- obligatori si type és "Correu-e"
smtp_helo string SMTP HELO.

Comportament de la propietat:
- obligatori si type és "Correu-e"
smtp_server string Servidor SMTP.

Comportament de la propietat:
- obligatori si type és "Correu-e"
smtp_port integer Port del servidor SMTP per connectar-se.
smtp_security integer Nivell de seguretat de la connexió SMTP que cal emprar.

Valors possibles:
0 - Cap;
1 - STARTTLS;
2 - SSL/TLS.
smtp_verify_host integer SSL verifica l'equip per a SMTP.

Valors possibles:
0 - No;
1 - Sí.
smtp_verify_peer integer SSL verifica el parell per a SMTP.

Valors possibles:
0 - No;
1 - Sí.
smtp_authentication integer Mètode d'autenticació SMTP que cal emprar.

Valors possibles:
0 - Cap;
1 - Mot de pas normal.
status integer Si el tipus de suport és habilitat.

Valors possibles:
0 - (per defecte) activat;
1 - desactivat.
username string Nom d'usuari.

Comportament de la propietat:
- admès si type és "Correu-e"
maxsessions integer El nombre màxim d'alertes que es poden processar en paral·lel.

Valors possibles si type és "SMS": (per defecte) 1.

Valors possibles si type és "Correu-e", "Script" o "Webhook": 0-100.
maxattempts integer El nombre màxim d'intents per enviar una alerta.

Valors possibles:
1-100

Per defecte:
3
attempt_interval string L'interval de reintent. Accepta segons i unitat de temps amb sufix.

Valors possibles:
0-1h

Valor per defecte:
10s
content_type integer Format del missatge.

Valors possibles:
0 - text sense format;
1 - (per defecte) html.
message_format integer Format del missatge.

Valors possibles:
0 - text pla;
1 - (per defecte) html.
script string Cos de JavaScript de l'script del tipus de suport webhook.
timeout string Temps d'espera de l'script del tipus de suport Webhook.
Accepta segons i unitat de temps amb sufix.

Valors possibles:
1-60s

Valor per defecte:
30s
process_tags integer Defineix si la resposta de l'script webhook s'ha d'interpretar com a etiquetes i aquestes etiquetes s'han d'afegir a l'esdeveniment associat.

Valors possibles:
0 - (per defecte) Ignora la resposta de l'script webhook.
1 - Tracta la resposta de l'script webhook com a etiquetes.
show_event_menu integer Mostra l'entrada del tipus de suport a problem.get i event.get a la propietat urls.

Valors possibles:
0 - (per defecte) No afegiu l'entrada urls.
1 - Afegeix un tipus de suport a la propietat urls.
event_menu_url string Defineix la propietat url de l'entrada del tipus de suport a la propietat urls de problem.get i event.get.
event_menu_name string Defineix la propietat name de l'entrada del tipus de suport a la propietat urls de problem.get i event.get.
parameters array Matriu de paràmetres d'entrada del webhook o de l'script.
description string Descripció del tipus de suport.

Paràmetres Webhook

Els paràmetres passats a l'script webhook quan es crida tenen les propietats següents.

Propietat Tipus Descripció
name string Nom del paràmetre.

Comportament de la propietat:
- obligatori
value string Valor del paràmetre, admet macros.
Admet les macros descrites a la pàgina de macros admeses.

Paràmetres d'scripts

Els paràmetres passats a l'script quan es crida tenen les propietats següents.

Propietat Tipus Descripció
sortorder L'ordre en que els paràmetres es passaran a l'script com a arguments de línia de comandes. Comença amb un 0 per al primer.

Comportament de la propietat:
- obligatori

|value|cadena|Valor del paràmetre. Admet macros.
Admet les macros descrites a la pàgina de macros admeses.|

Plantilla de missatge

L'objecte defineix una plantilla que s'emprarà com a missatge predeterminat per a les operacions d'acció per enviar una notificació. Té les següents propietats.

Propietat Tipus Descripció
eventsource integer Font de l'esdeveniment.

Valors possibles:
0 - triggers;
1 - descobriment;
2 - enregistrament automàtic;< br>3 - intern;
4 - serveis.

Comportament de la propietat:
- obligatori
recovery integer Mode d'operació.

Valors possibles:
0 - operacions;
1 - operacions de recuperació;
2 - operacions d'actualització.

Comportament de la propietat:
- obligatori
subject string Assumpte del missatge.
message string Text del missatge.