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. |