Table of Contents
> Mediatype-object
De volgende objecten zijn direct gerelateerd aan de mediatype API.
Mediatype
Het mediatypeobject heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| mediatypeid | string | (alleen lezen) ID van het mediatype. |
| naam (vereist) |
string | Naam van het mediatype. |
| type (vereist) |
integer | Transportmethode gebruikt door het mediatype. Mogelijke waarden: 0 - e-mail; 1 - script; 2 - SMS; 4 - Webhook. |
| exec_path | string | Voor scriptmediatypes bevat exec_path de naam van het uitgevoerde script.Vereist voor scriptmediatypes. |
| gsm_modem | string | Seriaal apparaatnaam van de GSM-modem. Vereist voor SMS-mediatypes. |
| passwd | string | Authenticatiewachtwoord. Gebruikt voor e-mailmediatypes. |
| smtp_email | string | E-mailadres van waaruit meldingen worden verzonden. Vereist voor e-mailmediatypes. |
| smtp_helo | string | SMTP HELO. Vereist voor e-mailmediatypes. |
| smtp_server | string | SMTP-server. Vereist voor e-mailmediatypes. |
| smtp_port | integer | Poort van SMTP-server om verbinding mee te maken. |
| smtp_security | integer | Beveiligingsniveau van SMTP-verbinding om te gebruiken. Mogelijke waarden: 0 - Geen; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | SSL verifieer host voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_verify_peer | integer | SSL verifieer peer voor SMTP. Mogelijke waarden: 0 - Nee; 1 - Ja. |
| smtp_authentication | integer | SMTP-authenticatiemethode om te gebruiken. 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 e-mailmediatypes. |
| exec_params | string | Scriptparameters. Elke parameter eindigt met een nieuwe regel. |
| 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 maximale aantal pogingen om een waarschuwing te verzenden. Mogelijke waarden: 1-100 Standaardwaarde: 3 |
| attempt_interval | string | Het interval tussen herhalingspogingen. Accepteert seconden en tijdseenheid met achtervoegsel. Mogelijke waarden: 0-1u Standaardwaarde: 10s |
| content_type | integer | Berichtindeling. Mogelijke waarden: 0 - platte tekst; 1 - (standaard) html. |
| script | string | Lichaam van javascript-webhookscript van mediatype webhook. |
| timeout | string | Time-out van het javascript-webhookscript van mediatype webhook. Accepteert seconden en tijdseenheid met achtervoegsel. Mogelijke waarden: 1-60s Standaardwaarde: 30s |
| process_tags | integer | Definieert of het antwoord van het webhookscript moet worden geïnterpreteerd als tags en of deze tags moeten worden toegevoegd aan het bijbehorende evenement. Mogelijke waarden: 0 - (standaard) Negeer antwoord van webhookscript. 1 - Verwerk antwoord van webhookscript als tags. |
| show_event_menu | integer | Toon mediatype-item in problem.get en event.get eigenschap urls.Mogelijke waarden: 0 - (standaard) Voeg geen urls item toe.1 - Voeg mediatype toe aan urls eigenschap. |
| event_menu_url | string | Definieer de url eigenschap van het mediatype-item in de urls eigenschap van problem.get en event.get. |
| event_menu_name | string | Definieer de name eigenschap van het mediatype-item in de urls eigenschap van problem.get en event.get. |
| parameters | array | Reeks webhook invoerparameters. |
| beschrijving | string | Beschrijving van het mediatype. |
Let op dat voor sommige methoden (bijwerken, verwijderen) de vereiste/optionele parametercombinatie anders is.
Webhook parameters
Parameters die aan het webhook-script worden doorgegeven wanneer het wordt aangeroepen, hebben de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| naam (vereist) |
string | Naam van de parameter. |
| waarde | string | Parameterwaarde, ondersteunt macro's. Ondersteunde macro's worden beschreven op de pagina Ondersteunde macro's. |
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. |