HTTPS XML API / Zarządzanie numerami nadawcy VOICE
Wiadomości typu VOICE pozwalają na użycie w połączeniu przychodzącym zdefiniowanego numeru (dostępnego na platformie SerwerSMS.pl). Możliwe jest użycie numeru ukrytego (domyślnie, pusta wartość), numerów predefiniowanych, numerów NDI oraz numerów własnych (po ich wcześniejszym dopisaniu i autoryzowaniu w Panelu Klienta).
Dodawanie numerów nadawcy VOICE
W chwili obecnej dodawanie numerów nadawcy dla wiadomości VOICE należy dokonywać poprzez Panel Klienta.
Listowanie numerów nadawcy VOICE oraz ich statusów
Wywołanie adresu
Aby przy pomocy zdalnej obsługi wylistować dostępne numery nadawcy VOICE 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=numer_nadawcy&operacja=lista
Dostępne parametry
Parametr | Typ | Przykładowa wartość lub format | Opis |
---|---|---|---|
akcja | String | numer_nadawcy | Aby zgłosić nowy numer do weryfikacji należy umieścić tutaj wartość „numer_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 numery nadawcy |
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 numer="+48123988904" typ="predefiniowany">Autoryzowano</NADAWCA>
<NADAWCA numer="+48500600700" typ="NDI"">Autoryzowano</NADAWCA>
<NADAWCA numer="+48555666777" typ="wlasny">Autoryzowano</NADAWCA>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
Znacznik XML | Opis |
---|---|
<NADAWCA>INFO</NADAWCA> | W tagu NADAWCA znajduje się informacja na temat statusu numeru nadawcy VOICE. Dostępne statusy to: Autoryzowano, Oczekuje na autoryzacje |
numer="NUM" | Atrybut numer, zawiera informację na temat numeru nadawcy VOICE. Dla numeru zastrzeżonego przyjmuje wartość pustą. |
typ="TYP" | Atrybut typ, określa typ numeru. Mozliwe wartości to: predefiniowany, NDI, wlasny. |
Zalecane ustawienia
Aby można było użyć numer nadawcy VOICE przy wysyłce, należy upewnić się, że posiada status Autoryzowano. W przeciwnym razie, numer nadawcy zostanie pominięty i wiadomość zostanie wysłana z numeru ukrytego/zastrzeżonego. Dodawanie własnych numerów odbywa się z poziomu Panelu Klienta.