Mediju tipa objekts

Tālāk norādītie objekti ir tieši saistīti ar mediatype API.

Mediju tips

Mediju tipa objektam ir šādas īpašības.

Property Type Description
mediatypeid ID Mediju tipa ID.

Property behavior:
- tikai lasāms
- obligāts atjaunināšanas operācijām
name string Mediju tipa nosaukums.

Property behavior:
- obligāts izveides operācijām
type integer Mediju tipa izmantotais transporta veids.

Iespējamās vērtības:
0 - E-pasts;
1 - Skripts;
2 - SMS;
4 - webhook.

Property behavior:
- obligāts izveides operācijām
exec_path string Skripta faila nosaukums (piem., notification.sh), kas atrodas direktorijā, kas norādīta servera konfigurācijas parametrā AlertScriptsPath.

Property behavior:
- obligāts, ja type ir iestatīts uz "Script"
gsm_modem string GSM modema seriālās ierīces nosaukums.

Property behavior:
- obligāts, ja type ir iestatīts uz "SMS"
passwd string Autentifikācijas parole.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "Normal password"
provider integer E-pasta pakalpojumu sniedzējs.

Iespējamās vērtības:
0 - (noklusējums) Generic SMTP;
1 - Gmail;
2 - Gmail relay;
3 - Office365;
4 - Office365 relay.
smtp_email string E-pasta adrese, no kuras tiks sūtīti paziņojumi.

Property behavior:
- obligāts, ja type ir iestatīts uz "Email"
smtp_helo string SMTP HELO.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_server string SMTP serveris.

Property behavior:
- obligāts, ja type ir iestatīts uz "Email"
smtp_port integer SMTP servera ports, ar kuru izveidot savienojumu.

Noklusējums: 25.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_security integer Izmantojamais SMTP savienojuma drošības līmenis.

Iespējamās vērtības:
0 - (noklusējums) Nav;
1 - STARTTLS;
2 - SSL/TLS.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
smtp_verify_host integer SSL verifikācija SMTP resursdatoram.

Iespējamās vērtības:
0 - (noklusējums) Nē;
1 - Jā.

Property behavior:
- atbalstīts, ja smtp_security ir iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_verify_peer integer SSL verifikācija SMTP vienaudžam.

Iespējamās vērtības:
0 - (noklusējums) Nē;
1 - Jā.

Property behavior:
- atbalstīts, ja smtp_security ir iestatīts uz "STARTTLS" vai "SSL/TLS"
smtp_authentication integer Izmantojamā SMTP autentifikācijas metode.

Iespējamās vērtības:
0 - (noklusējums) Nav;
1 - Normal password.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
status integer Vai mediju tips ir iespējots.

Iespējamās vērtības:
0 - (noklusējums) Iespējots;
1 - Atspējots.
username string Lietotājvārds.

Property behavior:
- atbalstīts, ja smtp_authentication ir iestatīts uz "Normal password"
maxsessions integer Maksimālais brīdinājumu skaits, ko var apstrādāt paralēli.

Iespējamās vērtības, ja type ir iestatīts uz "SMS": 1.

Iespējamās vērtības, ja type ir iestatīts uz "Email", "Script" vai "Webhook": 0-100.

Noklusējums: 1.
maxattempts integer Maksimālais mēģinājumu skaits brīdinājuma nosūtīšanai.

Iespējamās vērtības: 1-100.

Noklusējums: 3.
attempt_interval string Intervāls starp atkārtotiem mēģinājumiem.
Pieņem sekundes un laika vienību ar sufiksu.

Iespējamās vērtības: 0-1h.

Noklusējums: 10s.
content_type
(deprecated)		 integer Šis parametrs ir novecojis, lūdzu, izmantojiet message_format.
Ziņojuma formāts.

Iespējamās vērtības:
0 - Vienkāršs teksts;
1 - (noklusējums) HTML.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
message_format integer Ziņojuma formāts.

Iespējamās vērtības:
0 - Vienkāršs teksts;
1 - (noklusējums) HTML.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Email"
script text Webhook skripta saturs (JavaScript).

Property behavior:
- obligāts, ja type ir iestatīts uz "Webhook"
timeout string Webhook skripta noildze.
Pieņem sekundes un laika vienību ar sufiksu.

Iespējamās vērtības: 1-60s.

Noklusējums: 30s.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
process_tags integer Apstrādāt JSON īpašību vērtības Webhook skripta atbildē kā tagus. Šie tagi tiek pievienoti jebkuriem esošajiem problēmas tagiem.

Iespējamās vērtības:
0 - (noklusējums) Ignorēt Webhook skripta atbildi;
1 - Apstrādāt Webhook skripta atbildi kā tagus.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
show_event_menu integer Iekļaut ierakstu notikumu izvēlnē, kas norāda uz pielāgotu URL. Tāpat pievieno urls īpašību problem.get un event.get izvadei.

Iespējamās vērtības:
0 - (noklusējums) Neiekļaut notikumu izvēlnes ierakstu vai urls īpašību;
1 - Iekļaut notikumu izvēlnes ierakstu un urls īpašību.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook"
event_menu_url string URL, ko izmanto notikumu izvēlnes ierakstā un urls īpašībā, ko atgriež problem.get un event.get.

Property behavior:
- atbalstīts, ja show_event_menu ir iestatīts uz "Include event menu entry and urls property"
event_menu_name string Nosaukums, ko izmanto notikumu izvēlnes ierakstā un urls īpašībā, ko atgriež problem.get un event.get.

Property behavior:
- atbalstīts, ja show_event_menu ir iestatīts uz "Include event menu entry and urls property"
parameters array Webhook vai skripta parametri.

Property behavior:
- atbalstīts, ja type ir iestatīts uz "Webhook" vai "Script"
description text Mediju tipa apraksts.

Webhook parametri

Webhook parametriem ir šādas īpašības.

Īpašība Tips Apraksts
name string Parametra nosaukums.

Īpašības darbība:
- obligāts
value string Parametra vērtība, atbalsta makrosus.
Atbalstītie makrosi ir aprakstīti lapā Atbalstītie makrosi.

Skripta parametri

Skripta parametriem ir šādas īpašības.

Īpašība Tips Apraksts
sortorder integer Secība, kādā parametru vērtības tiks nodotas skriptam kā komandrindas argumenti, sākot ar 0 kā pirmo.

Īpašības darbība:
- obligāts
value string Parametra vērtība, atbalsta makrosus.
Atbalstītie makrosi ir aprakstīti lapā Atbalstītie makrosi.

Ziņojuma veidne

Ziņojuma veidnes objekts definē veidni, kas tiks izmantota kā noklusējuma ziņojums darbību operācijām, lai nosūtītu paziņojumu. Tam ir šādas īpašības.

Īpašība Type Apraksts
eventsource integer Notikuma avots.

Iespējamās vērtības:
0 - Trigeri;
1 - Atklāšana;
2 - Automātiskā reģistrācija;
3 - Iekšējs;
4 - Pakalpojumi.

Īpašības darbība:
- required
recovery integer Operācijas režīms.

Iespējamās vērtības:
0 - Operācijas;
1 - Atkopšanas operācijas;
2 - Atjaunināšanas operācijas.

Īpašības darbība:
- required
subject string Ziņojuma temats.
message string Ziņojuma teksts.