HTTPS API v2 / Zarządzanie subkontami

System umożliwia zdalne listowanie oraz tworzenie subkont w systemie (na które można się również zalogować z poziomu Panelu Klienta). Aby utworzyć konto, należy najpierw zdefiniować w Panelu Klienta przynajmniej jedno subkonto które później będzie użyte jako szablon uprawnień. Wszystkie ustawienia dotyczące np. przekazywania raportów doręczeń czy też odpowiedzi na SMS ECO+ zostaną skopiowane z szablonowego subkonta na nowe subkonto.

Listowanie subkont

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wylistować aktualne dostępne subkonta, należy wywołać określony adres URL metodą POST.

subaccounts/index

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String Login Login konta.
password String Haslo Hasło konta.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "items":[{
      "id":123,
      "username":"wojtek"
   },
   {
      "id":456,
      "username":"login2"
   },
   {
      "id":789,
      "username":"testowy"
   }]
}

Wyświetlenie szczegółów subkonta

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wyświetlić dane subkonta, należy wywołać określony adres URL metodą POST.

subaccounts/view

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String Login Login konta.
password String Haslo Hasło do konta.
id Integer np. 123 Identyfikator subkonta.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "id":1194,
   "username":"wojtek",
   "name":"Wojciech",
   "phone":"+48730856000",
   "email":"wojtek@mail.com"
}

Tworzenie subkont

Wywołanie adresu

Aby przy pomocy zdalnej obsługi utworzyć nowe subkonto, należy wywołać określony adres URL metodą POST.

subaccounts/add

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String Login Login konta.
password String Haslo Hasło do konta.
subaccount_username String np. „login1” Login nowego subkonta (3-20 znaków z zakresu (a-z, A-Z, 0-9 oraz znaki: , _ @.
subaccount_password String np. „testABC” Hasło nowego subkonta (3-20 znaków).
subaccount_id Integer np. 123 Identyfikator subkonta z którego mają zostać przeniesione uprawnienia dostępu oraz widoku.
name String np. „testowe subkonto” Nazwa opisująca nowe subkonto.
phone String np. „500600700” Numer telefonu nowego subkonta.
email String np. „test@test.pl Adres email nowego subkonta.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true,
   "id":1485
}

Ustawianie limitów wiadomości dla subkonta

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wprowadzić limit wiadomości dla subkonta, należy wywołać określony adres URL metodą POST.

subaccounts/limit

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String Login Login konta.
password String Haslo Hasło do konta.
id Integer np. 123 Identyfikator subkonta.
type String eco|full|voice|mms|hlr Typ wiadomości dla których aktualizowany jest limit.
value Integer np. 100 Ilość wiadomości.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true,
   "id":1485
}

Usuwanie subkonta

Wywołanie adresu

Aby przy pomocy zdalnej obsługi usunąć subkonto, należy wywołać określony adres URL metodą POST.

subaccounts/delete

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
username String Login Login konta.
password String Haslo Hasło do konta.
id Integer np. 123 Identyfikator subkonta.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true
}