HTTPS XML API / Sprawdzanie stanu konta

W przypadku kont z ograniczeniami dotyczącymi ilości wysyłanych wiadomości, klient może sam sprawdzić ile wiadomości  pozostało jeszcze do wysłania. W ten sposób można kontrolować stan dostępnego kredytu do wysłania i w razie konieczności doładować wcześniej konto.

Wywołanie adresu

Aby przy pomocy zdalnej obsługi pobrać aktualną ilość dostępnych wiadomości należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:

https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=ilosc_sms&pokaz_typ_konta=1

Dostępne parametry

Parametr Typ Przykładowa wartość lub format Opis
akcja String ilosc_sms Aby sprawdzić ilość dostępnych wiadomości należy umieścić tutaj wartość „ilosc_sms”.
login String Login Login konta
haslo String Haslo Hasło konta
pokaz_typ_konta Integer 1, 0 lub brak Zwraca dodatkowe atrybuty mówiące o typie konta oraz maksymalnej długości wiadomości wychodzącej

Zwraca dodatkowe atrybuty mówiące o typie konta oraz maksymalnej długości wiadomości wychodzącej
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <SMS typ="ECO+">brak limitu</SMS>
 <SMS typ="FULL">2345</SMS>
 <SMS typ="VOICE">3356</SMS>
 <SMS typ="MMS">brak limitu</SMS>
 <SMS typ="HLR">33</SMS>
 <SMS typ="Lookup">12</SMS>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML Opis
<SMS typ="TYP" limit_znakow="160/1"> ILOSC </SMS> Parametr „TYP” określa czy podana dalej ilość SMS dotyczy wiadomości SMS ECO+ czy FULL. „ILOSC” mówi klientowi ile wiadomości danego typu można jeszcze wysłać. Jeśli klient nie posiada żadnych limitów, wtedy parametr ten przybiera wartość „brak limitu”. limit_znakow określa jaka do konta przypisana jest maksymalna długość wiadomości.
<KONTO>TYP</KONTO> Parametr „TYP” określa jakiego typu jest konto. Możliwe wartości to: PREPAID, POSTPAID lub „---” czyli konto jeszcze nieaktywne.

Zalecane ustawienia

Zalecane jest aby dostosować intensywność sprawdzania dostępnego limitu wiadomości do realizowanych wysyłek tak, aby np. nie odpytywać API o stan konta co 10 sek. w przypadku gdy przez ostatni okres Klient nic nie wysyłał. Zalecane ustawienia to aktualizacja stanu konta co np. 1 godzinę lub w momencie prowadzenia wysyłek.

Dla Klientów korzystających z opcji Prepaid, możliwe jest automatyczne informowanie o ew. kończącym się limicie (określonym poziomie ilościowym) oraz o całkowitym wyczerpaniu limitu wybranego typu wiadomości. Komunikaty te mogą być wysyłane do Klienta na SMS lub email.