HTTPS API v2 / Zarządzanie nazwami nadawcy

Wiadomości typu FULL SMS pozwalają na użycie w nagłówku SMS-a 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.

senders/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.
name	String	Konkurs, SerwerSMSpl itp.	Alfanumeryczna nazwa nadawcy (max 11 znaków).

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

Zwrot odpowiedzi

{
   "success":true
}

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. 

senders/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.
predefined	Boolean	true, false lub brak	Parametr opcjonalny umożliwiający wyświetlenie predefiniowanych w systemie nazw nadawcy gotowych do użycia w wysyłce SMS.
type	String	ndi|mms	Parametr opcjonalny wyświetlający listę nadawców NDI lub MMS.
sort	String	name	Parametr opcjonalny umożliwiający sortowanie danych według nazwy nadawcy.
order	String	asc|desc	Parametr opcjonalny umożliwiający zmianę kolejności sortowania.

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

Zwrot odpowiedzi

{
   "items":[{
      "name":"Testowa",
      "agreement":"not_required",
      "status":"pending_authorization"
   },
   {
      "name":"SerwerSMSpl",
      "agreement":"delivered",
      "status":"authorized"
   },
   {
      "name":"+48783820099",
      "agreement":"not_required",
      "status":"authorized"
   },
   {
      "name":"T-mobile",
      "agreement":"required",
      "status":"rejected",
      "note":"Używanie nazw własnych Operatorow GSM jest zabronione"
   }]
}

Objaśnienie poszczególnych parametrów zwrotnych

Parametr	Opis
name	Określa jaka nazwa lub numer jest przetwarzany.
agreement	Informuje, czy dana nazwa wymaga specjalnej zgody na posługiwanie się nią. Przyjmowane wartości: delivered, required, not_required.
status	Informacja czy nazwa jest zatwierdzona i gotowa do wysyłki. Wartości: pending_authorization, authorized, rejected, deactivated.
note	Komunikat w przypadku wystąpienia błędu.
networks	Atrybut dostępny dla listy nadawców MMS. Określa, dla których operatorów nadpis jest aktywny.

Zalecane ustawienia

Istnieje możliwość otrzymywania automatycznych informacji na temat zatwierdzenia nazwy nadawcy lub ewentualnie 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.