Documentation
Table of Contents
> Media type object
Poniższe obiekty są bezpośrednio powiązane z interfejsem API mediatype.
Media type
Obiekt Media type posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| mediatypeid | string | (tylko do odczytu) ID typu mediów. |
| name (wymagane) |
string | Nazwa typu mediów. |
| type (wymagane) |
integer | Transport używany przez typ mediów. Możliwe wartości: 0 - email; 1 - skrypt; 2 - SMS; 4 - Webhook. |
| exec_path | string | Dla typów mediów opartych na skrypcie exec_path zawiera nazwę wykonywanego skryptu.Wymagane dla typów mediów opartych na skrypcie. |
| gsm_modem | string | Nazwa urządzenia szeregowego modemu GSM. Wymagane dla typów mediów SMS. |
| passwd | string | Hasło autoryzacji. Używane dla typów mediów email. |
| smtp_email | string | Adres e-mail, z którego będą wysyłane powiadomienia. Wymagane dla typów mediów email. |
| smtp_helo | string | SMTP HELO. Wymagane dla typów mediów email. |
| smtp_server | string | Serwer SMTP. Wymagane dla typów mediów email. |
| smtp_port | integer | Port serwera SMTP, do którego będzie nawiązane połączenie. |
| smtp_security | integer | Poziom zabezpieczeń połączenia SMTP do użycia. Możliwe wartości: 0 - Brak; 1 - STARTTLS; 2 - SSL/TLS. |
| smtp_verify_host | integer | Weryfikacja hosta SSL dla SMTP. Możliwe wartości: 0 - Nie; 1 - Tak. |
| smtp_verify_peer | integer | Weryfikacja podmiotu SSL dla SMTP. Możliwe wartości: 0 - Nie; 1 - Tak. |
| smtp_authentication | integer | Metoda autentykacji SMTP do użycia. Możliwe wartości: 0 - Brak; 1 - Zwykłe hasło. |
| status | integer | Czy typ mediów jest włączony. Możliwe wartości: 0 - (domyślnie) włączony; 1 - wyłączony. |
| username | string | Nazwa użytkownika. Używane dla typów mediów email. |
| exec_params | string | Parametry skryptu. Każdy parametr kończy się nową linią. |
| maxsessions | integer | Maksymalna liczba alertów, które mogą być przetwarzane równolegle. Możliwe wartości dla SMS: 1 - (domyślnie) Możliwe wartości dla innych typów mediów: 0-100 |
| maxattempts | integer | Maksymalna liczba prób wysłania alertu. Możliwe wartości: 1-100 Domyślna wartość: 3 |
| attempt_interval | string | Interwał między próbami ponownego wysłania. Akceptuje sekundy i jednostkę czasu z sufiksem. Możliwe wartości: 0-1h Domyślna wartość: 10s |
| content_type | integer | Format wiadomości. Możliwe wartości: 0 - zwykły tekst; 1 - (domyślnie) html. |
| script | string | Treść skryptu webhook. |
| timeout | string | Limit czasu wykonania skryptu webhook. Akceptuje sekundy i jednostkę czasu z sufiksem. Możliwe wartości: 1-60s Domyślna wartość: 30s |
| process_tags | integer | Definiuje, czy odpowiedź skryptu webhook powinna być interpretowana jako znaczniki, a te tagi powinny być dodane do powiązanego zdarzenia. Możliwe wartości: 0 - (domyślnie) Ignoruj odpowiedź skryptu webhook. 1 - Przetwarzaj odpowiedź skryptu webhook jako znaczniki. |
| show_event_menu | integer | Pokaż wpis typu mediów w problem.get i event.get właściwość urls.Możliwe wartości: 0 - (domyślnie) Nie dodawaj wpisu urls.1 - Dodaj typ mediów do właściwości urls. |
| event_menu_url | string | Zdefiniuj właściwość url wpisu typu mediów w właściwości urls problem.get i event.get. |
| event_menu_name | string | Zdefiniuj właściwość name wpisu typu mediów w właściwości urls problem.get i event.get. |
| parameters | array | Tablica parametrów wejściowych webhooka. |
| description | string | Opis typu mediów. |
Zauważ, że dla niektórych metod (update, delete) kombinacja wymaganych/opcjonalnych parametrów jest różna.
Webhook parameters
Parametry przekazywane do skryptu webhooka podczas jego wywołania; posiadają następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| name (wymagane) |
string | Nazwa parametru. |
| value | string | Wartość parametru, obsługuje makra. Obsługiwane makra są opisane na stronie Obsługiwane makra. |
Message template
Obiekt message template definiuje szablon, który będzie używany jako domyślna wiadomość dla operacji akcji w celu wysłania powiadomienia. Ma on następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| eventsource (wymagane) |
integer | Źródło zdarzenia. Możliwe wartości: 0 - wyzwalacze; 1 - wykrywanie; 2 - autorejestracja; 3 - wewnętrzne; 4 - usługi. |
| recovery (wymagane) |
integer | Tryb operacji. Możliwe wartości: 0 - operacje; 1 - operacje odzyskiwania; 2 - operacje aktualizacji. |
| subject | string | Temat wiadomości. |
| message | string | Treść wiadomości. |