HTTPS XML API / Usuwanie zaplanowanych na określony termin wysyłek
W przypadku skorzystania z wysyłki w określonym terminie (parametr data_wysylki przy zgłaszaniu wysyłania wiadomości) istnieje możliwość usunięcia takich powiadomień odwołując się do określonego SMSID/USMSID.
Wywołanie adresu
Aby przy pomocy zdalnej obsługi pobrać odpowiedzi na 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=usun_zaplanowane&smsid=89df6g875sf
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
akcja | String | usun_zaplanowane | Aby sprawdzić stan wiadomości należy umieścić tutaj wartość „sprawdz_odpowiedzi”. |
login | String | Login | Login kotna używany do wysyłki |
haslo | String | Haslo | Hasło do konta |
smsid | String | 111065e43c | Identyfikatory SMSID wybranych wiadomości |
usmsid | String | 87f5gs5f56 | Identyfikator własny Klienta |
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">
<ZAPLANOWANE smsid="025701861e">OK</ZAPLANOWANE>
<ZAPLANOWANE smsid="SD8F7G7DSF">OK</ZAPLANOWANE>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
Znacznik XML | Opis |
---|---|
<ZAPLANOWANE smsid="SMSID">STAN</ZAPLANOWANE> | Zawiera identyfikator wiadomości SMSID oraz stan usuwania. Stan to w zależności od wyniku OK jeśli wszystko przebiegło poprawnie, ERR jeśli nie znaleziono wybranego znacznika SMSID. |
Zalecane ustawienia
Podczas usuwania zaplanowanych wysyłek należy wziąć pod uwagę ew. różnicę czasów pomiędzy lokalnym serwerem a SerwerSMS.pl. Usunięcie wiadomości z identyfikatorem USMSID powoduje całkowite usunięcie również samego identyfikatora USMSID po stronie SerwerSMS.pl. Można zatem użyć go ponownie bez obawy o duplikat (opcja nie dotyczy klientów z włączoną kontrolą duplikatów USMSID).