HTTPS API v2 / Zarządzanie szablonami
System umożliwia zdalne listowanie, dodawanie, edytowanie oraz usuwanie szablonów wiadomości.
Listowanie szablonów
Wywołanie adresu
Aby przy pomocy zdalnej obsługi wylistować szablony, należy wywołać określony adres URL metodą POST.
templates/index
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
username | String | Login | Login użytkownika API. |
password | String | Haslo | Hasło użytkownika API. |
sort | String | name | Parametr opcjonalny umożliwiający sortowanie danych według nazwy szablonu. |
order | String | asc|desc | Parametr opcjonalny umożliwiający zmianę kolejności sortowania. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
{
"items":[{
"id":8416,
"name":"Tytuł szablonu 1",
"text":"Treść wiadomości"
},
{
"id":8415,
"name":"Tytuł szablonu 2",
"text":"Wiadomość testowa"
}]
}
Wyświetlanie pojedynczego szablonu
Wywołanie adresu
Aby przy pomocy zdalnej obsługi wyświetlić szablon, należy wywołać określony adres URL metodą POST.
templates/view
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
username | String | Login | Login użytkownika API. |
password | String | Haslo | Hasło użytkownika API. |
id | Integer | np. 4886 | Identyfikator szablonu. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
{
"id":8416,
"name":"Tytuł szablonu 1",
"text":"Treść wiadomości"
}
Dodawanie nowego szablonu
Wywołanie adresu
Aby przy pomocy zdalnej obsługi utworzyć nowy szablon, należy wywołać określony adres URL metodą POST.
templates/add
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
username | String | Login | Login użytkownika API. |
password | String | Haslo | Hasło użytkownika API. |
name | String | nazwa szablonu | Nazwa szablonu. |
text | String | tekst | Treść wiadomości. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
{
"success":true,
"id":12354
}
Edycja szablonu
Wywołanie adresu
Aby przy pomocy zdalnej obsługi edytować szablon, należy wywołać określony adres URL metodą POST.
templates/edit
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
username | String | Login | Login użytkownika API. |
password | String | Haslo | Hasło użytkownika API. |
id | Integer | np. 8465 | Identyfikator szablonu. |
name | String | nazwa szablonu | Nazwa szablonu. |
text | String | tekst | Treść wiadomości. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
{
"success":true,
"id":12354
}
Usuwanie szablonu
Wywołanie adresu
Aby przy pomocy zdalnej obsługi usunąć szablon, należy wywołać określony adres URL metodą POST.
templates/delete
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
username | String | Login | Login użytkownika API. |
password | String | Haslo | Hasło użytkownika API. |
id | String | np. 7584 | Identyfikator szablonu. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
{
"success":true
}