HTTPS API v2 / Obsługa czarnej listy

System umożliwia zdalne listowanie, dodawanie oraz usuwanie numerów z czarnej listy.

Listowanie numerów z czarnej listy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wylistować numery zapisane na czarnej liście, należy wywołać określony adres URL metodą POST.

blacklist/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.
phone	String	np. +48500600700	Wartość opcjonalna, pozwalająca zawęzić przeszukiwany obszar do konkretnego numeru.

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

Zwrot odpowiedzi

{
   "items":[{
      "phone":"+48500600702",
      "added":"2014-10-22 12:25:10"
   },
   {
      "phone":"+48500600701",
      "added":"2014-10-22 15:52:03"
   }]
}

Dopisywanie numeru do czarnej listy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi dopisać numer do czarnej listy, należy wywołać określony adres URL metodą POST.

blacklist/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.
phone	String	np. +48500600700	Numer do dopisania do czarnej listy, najlepiej z międzynarodowym prefiksem poprzedzonym znakiem „+”.

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

Zwrot odpowiedzi

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

Usuwanie numeru z czarnej listy

Wywołanie adresu

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

blacklist/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.
phone	String	np. +48500600700	Numer do dopisania do czarnej listy, najlepiej z międzynarodowym prefiksem poprzedzonym znakiem „+”.

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

Zwrot odpowiedzi

{
   "success":true
}

Sprawdzanie czy numer znajduje się na czarnej liście

Wywołanie adresu

Aby przy pomocy zdalnej obsługi sprawdzić, czy numer istnieje na czarnej liście, należy wywołać określony adres URL metodą POST.

blacklist/check

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.
phone	String	np. +48500600700	Numer do sprawdzenia, najlepiej z międzynarodowym prefiksem poprzedzonym znakiem „+”.

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

Zwrot odpowiedzi

{
   "exists":true
}