HTTPS XML API / Zarządzanie nazwami nadawcy

Wiadomości typu FULL SMS pozwalają na użycie w nagłówku SMSa własnego tekstu lub numeru (zainstalowanego na platformie SerwerSMS.pl). Ze względu na zmiany prawne, użycie własnej nazwy nadawcy jako tekst (np. nazwa firmy) wymaga dodatkowej autoryzacji. W każdym momencie można wylistować dodane do systemu nazwy nadawcy i sprawdzić ich status autoryzacji.

Dodawanie nazw nadawcy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi zgłosić nową nazwę do autoryzacji 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=nazwa_nadawcy&operacja=dodanie&nazwa=SerwerSMS.pl

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	nazwa_nadawcy	Aby zgłosić nowy numer do weryfikacji należy umieścić tutaj wartość „nazwa_nadawcy”.
login	String	Login	Login konta
haslo	String	Haslo	Hasło konta
operacja	String	dodanie	Wartość taka powinna zostać użyta aby dodać nową nazwę nadawcy do weryfikacji
nazwa	String	Konkurs, SerwerSMS.pl itp.	Alfanumeryczna nazwa nadawcy (max 11 znaków).

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">
 <NADAWCA nazwa="SerwerSMS.pl">Dopisano</NADAWCA>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NADAWCA nazwa="NAZWA">INFO</NADAWCA>	Parametr „NAZWA” określa jaka nazwa jest przetwarzana natomiast parametr „INFO” określa komunikat zwrotny. Jeśli wystąpi jakiś błąd, w parametrze INFO pojawi się odpowiedni komunikat.

Listowanie nazw nadawcy oraz ich statusów

Wywołanie adresu

Aby przy pomocy zdalnej obsługi zweryfikować przesłany wcześniej nowy numer nadawcy 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=nazwa_nadawcy&operacja=lista

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	nazwa_nadawcy	Aby zgłosić nowy numer do weryfikacji należy umieścić tutaj wartość „nazwa_nadawcy”.
login	String	Login	Login konta
haslo	String	Haslo	Hasło do konta
operacja	String	Lista	Wartość taka powinna zostać użyta aby wyświetlić zapisane w systemie nazwy nadawcy
predefiniowane	Integer	1, 0 lub brak	Parametr opcjonalny umożliwiający wyświetlenie predefiniowanych w systemie nazw nadawcy gotowych do użycia w wysyłce SMS.

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">
 <NADAWCA nazwa="Testowa">Oczekuje na autoryzacje</NADAWCA>
 <NADAWCA nazwa="SerwerSMS.pl">Autoryzowano</NADAWCA>
 <NADAWCA nazwa="+48783820099">Autoryzowano</NADAWCA>
 <NADAWCA nazwa="Era">Odrzucono: Uzywanie nazw wlasnych Operatorow GSM jest zabronione</NADAWCA>
</SerwerSMS> 

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<NADAWCA nazwa="NAZWA">INFO</NADAWCA>	Parametr „NAZWA” określa jaka nazwa lub numer jest przetwarzany natomiast parametr „INFO” określa komunikat zwrotny. Jeśli wystąpi jakiś błąd, w parametrze INFO pojawi się odpowiedni komunikat.

Zalecane ustawienia

Istnieje możliwość otrzymywania automatycznych informacji na temat zatwierdzenia nazwy nadawcy lub ew. innym zmianie stanu nazwy metodą Push. Ustawienia te należy określić w Panelu Klienta → Ustawienia wiadomości → Nazwy nadawcy → Ustawienia dodatkowe.

Samo pomyślne dodanie nazwy nadawcy do systemu SerwerSMS.pl nie świadczy o tym, że można już jej użyć podczas wysyłki wiadomości. Każda nazwa nadawcy musi zostać zweryfikowana przez administratora SerwerSMS.pl i dopiero po akceptacji nazwy i zmianie jej statusu możliwe jest prowadzenie wysyłki z jej użyciem. W określonych przypadkach nazwa może zostać odrzucona przez administratora jako niepoprawna lub zastrzeżona. Istnieje możliwość wstrzymania aktywacji nazwy nadawcy do momentu przesłania zgody na jej użycie przez Klienta.