Table of Contents
> Mediatype-object
De volgende objecten zijn direct gerelateerd aan de mediatype API.
Mediatype
Het mediatype-object heeft de volgende eigenschappen.
| Property | Type | Beschrijving |
|---|---|---|
| mediatypeid | string | (alleen-lezen) ID van het mediatype. |
| name (verplicht) |
string | Naam van het mediatype. |
| type (vereist) |
geheel getal | Transport gebruikt door het mediatype. Mogelijke waarden: 0 - email; 1 - script; 2 - Sms; 4 - Webhook. |
| exec_path | string | Voor scriptmediatypen bevat exec_path de naam van het uitgevoerde script.Vereist voor scriptmediatypen. |
| gsm_modem | string | Seriële apparaatnaam van de GSM-modem. Vereist voor SMS-mediatypes. |
| passwd | string | Verificatiewachtwoord. Gebruikt voor typen e-mailmedia. |
| smtp_email | string | E-mailadres van waaruit meldingen worden verzonden. Vereist voor e-mailmediatypen. |
| smtp_helo | string | SMTP HELO. Vereist voor e-mailmediatypen. |
| smtp_server | string | SMTP-server. Vereist voor e-mailmediatypen. |
| smtp_port | integer | SMTP-serverpoort om verbinding mee te maken. |
| smtp_security | integer | SMTP-verbindingsbeveiligingsniveau dat moet worden gebruikt. Mogelijke waarden: 0 - Geen; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL-host verifiëren voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_verify_peer | integer | SSL-verificatie-peer voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_authentication | integer | SMTP-verificatiemethode die moet worden gebruikt. Mogelijke waarden: 0 - Geen; 1 - Normaal wachtwoord. |
| status | integer | Of het mediatype is ingeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
| username | string | Gebruikersnaam. Gebruikt voor typen e-mailmedia. |
| exec_params | string | Scriptparameters. Elke parameter eindigt met een nieuwe regelinvoer. |
| maxsessions | integer | Het maximale aantal waarschuwingen dat parallel kan worden verwerkt. Mogelijke waarden voor sms: 1 - (standaard) Mogelijke waarden voor andere mediatypen : 0-100 |
| maxattempts | integer | Het maximum aantal pogingen om een waarschuwing te verzenden. Mogelijke waarden: 1-100 Standaardwaarde: 3 |
| attempt_interval | string | Het interval tussen nieuwe pogingen. Accepteert seconden en tijdseenheid met achtervoegsel. Mogelijke waarden: 0-1h Standaardwaarde: 10s |
| content_type | integer | Berichtindeling. Mogelijke waarden: 0 - platte tekst; 1 - (standaard) html. |
| script | string | Mediatype webhookscript javascript body. |
| timeout | string | Time-out van webhookscript voor mediatype. Accepteert seconden en tijdseenheid met achtervoegsel. Mogelijke waarden: 1-60s Standaardwaarde: 30s |
| process_tags | integer | Definieert of de webhook-scriptreactie moet worden geïnterpreteerd als tags en deze tags moeten worden toegevoegd aan de bijbehorende gebeurtenis. Mogelijke waarden: 0 - (standaard) Webhook-script negeren reactie. 1 - Verwerk de reactie van het webhook-script als tags. |
| show_event_menu | integer | Toon de invoer van het mediatype in problem.get en event.get eigenschap urls.Mogelijke waarden: 0 - (standaard) Do geen urls-item toevoegen.1 - Mediatype toevoegen aan urls-eigenschap. |
| event_menu_url | string | Definieer url eigenschap van mediatype invoer in urls eigenschap van problem.get en event.get. |
| event_menu_name | string | Definieer de eigenschap name van het mediatype-item in urls eigenschap van problem.get en event.get. |
| parameters | array | Array van webhook-invoerparameters. |
| description | string | Beschrijving mediatype. |
Webhook-parameters
Parameters die worden doorgegeven aan het webhook-script wanneer het wordt aangeroepen, hebben de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| naam (verplicht) |
string | Parameternaam. |
| value | string | Parameterwaarde, ondersteuningsmacro's. Ondersteunde macro's beschreven op pagina. |
Berichtsjabloon
Het berichtsjabloonobject definieert een sjabloon die wordt gebruikt als een standaardbericht voor actiebewerkingen om een melding te verzenden. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| gebeurtenisbron (vereist) |
geheel getal | Gebeurtenisbron. Mogelijke waarden: 0 - triggers; 1 - ontdekking; 2 - automatische registratie;<br >3 - intern; 4 - diensten. |
| herstel (vereist) |
geheel getal | Bewerkingsmodus. Mogelijke waarden: 0 - bewerkingen; 1 - herstelbewerkingen; 2 - updatebewerkingen. |
| subject | string | Berichtonderwerp. |
| message | string | Berichttekst. |