Funkcje dodatkowe. Wersja 1.2.1

Podobne dokumenty
Funkcje dodatkowe. Wersja 1.2.1

Baza numerów Wersja 1.1

DOKUMENTACJA TECHNICZNA SMS API MT

Dokumentacja smsapi wersja 1.4

Specyfikacja HTTP API. Wersja 1.6

Instrukcja korzystania z usługi 2SMS. Wersja 2.0 [12 stycznia 2014] bramka@gsmservice.pl

Interfejs HTTP/S API. Wersja 2.34

Dokumentacja SMS przez FTP

SMS Kod Automatyczny

Dokumentacja interfejsu HTTPD. Platforma BSMS.PL Instrukcja podłączenia po przez http

Specyfikacja instalacji usługi SMS Premium w Przelewy24.pl

,Aplikacja Okazje SMS

Aktualizacja SMSFall v Data publikacji:

Internetowy serwis Era mail Aplikacja sieci Web

Integracja z pocztą Gmail. Integracja Poczta Google. Wersja 1.0 SPIS TREŚCI

Dokumentacja interfejsu Webservices API. Wersja 2.0 [12 stycznia 2014]

Przewodnik użytkownika systemu e-faktur

Instrukcja składania wniosku o dofinansowanie w systemie informatycznym IP na potrzeby konkursu nr 1/1.1.1/2015

Dokumentacja techniczna API systemu SimPay.pl

Interfejs HTTP/S API Wersja 2.32

Dokumentacja interfejsu API

Dokumentacja interfejsu MySQL. Platforma BSMS.PL Instrukcja podłączenia po przez mysql

Dokumentacja interfejsu SMS HTTP API. Wersja 3.0 [15 styczeń 2008]

Dokumentacja interfejsu SMS HTTP API. Wersja 3.1 [18 marzec 2008]

API przekazy masowe - Dokumentacja. v 1.1, czerwiec 2014 KIP S.A. ul. Św. Marcin 73/ Poznań.

Instrukcja Integracja z istore. Wersja z 07/02/2015. Copyright Zakupteraz.pl

Instrukcja rejestracji i obsługi konta użytkownika oraz głosowania na projekty obywatelskie w systemie.

Dokumentacja 2SMS

Specyfikacja Płatności CashBill. Instrukcja podłączenia płatności elektronicznych do typowych zastosowań.

Specyfikacja techniczna. mprofi Interfejs API

Wszystkie dane powinny być przekazane za pomocą metody POST, zakodowane za pomocą funkcji urlencode().

DOKUMENTACJA INTERFEJSU API - HTTPS

API transakcyjne BitMarket.pl

1. INFORMACJE O DOKUMENCIE 2. WPROWADZENIE 3. FILTROWANIE ADRESÓW IP

Dokumentacja Techniczna SMS MO

Instrukcja składania wniosku o dofinansowanie w systemie informatycznym IP na potrzeby konkursu nr 1/1.1.1/2015

FedEx efaktura Instrukcja Użytkownika

Dokumentacja REST API v 3.0

System epon Dokumentacja użytkownika

Dokumentacja API Stacja z Paczką ver. 2.09


Aplikacja WWW Booster. praktyczny poradnik uzupełnienia newslettera wysyłką SMS. FreshMail

Podręcznik Integracji

PANEL ADMINISTRACYJNY SPRZEDAWCY SZYBKI START

Dokumentacja API Stacja z Paczką ver. 2.14

OPIEKUN DORADCY: KONTO FIRMY DODAWANIE KLIENTÓW

Komunikator podręcznik użytkownika podręcznik użytkownika

Dokumentacja techniczna SMS MO

DOKUMENTACJA IMPLEMENTACJI MECHANIZMÓW OBSŁUGI AHMES SMS (soap)

Konfiguracja programu MS Outlook 2007 dla poczty w hostingu Sprint Data Center

INSTRUKCJA OBSŁUGI APLIKACJI WEBFAX DLA

DOKUMENTACJA INTERFEJSU MY MYSQL. Platforma SMeSKom instrukcja podłączenia poprzez mysql Protokół w wersji 2.0

Sms. v Strona 1 z 17. FUTURE-SOFT SP. Z O.O. ul. Gosławicka2/ , Opole tel sales@future-soft.pl NIP:


Dokumentacja SMPP API

Aplikacja WWW Booster. praktyczny poradnik uzupełnienia newslettera wysyłką SMS

SPIS TREŚCI Instrukcja samodzielnej aktywacji usługi e-faktura

MODUŁ INTEGRUJĄCY ELEKTRONICZNEGO NADAWCĘ Z WF-MAG SPIS TREŚCI

E-book: Automatyzacja powiadomień SMS. CASE STUDY

Dokumentacja API. SOAP - webservice v

Świadczenie usługi hurtowej wysyłki wiadomości SMS dla Urzędu Miasta Torunia w latach

Dokumentacja REST API v 3.0

Dokumentacja techniczna SMS MO

INSTRUKCJA UŻYTKOWANIA USŁUGI mobile e-bank EBS

Instrukcja Integracja z Shoper. Wersja z 18/01/2015. Copyright Zakupteraz.pl

Benutzerhandbuch, November 2009 Seite 2. Wstęp Dostęp Rejestracja Logowanie Wyszukiwanie przesyłki...

TRX API opis funkcji interfejsu

Instrukcja obsługi dla Wnioskodawcy

InPost dla WooCommerce. kompatybliny z wersjami: 2.3.x, 2.4.x, 2.5.x. Instrukcja obsługi

Platforma dla Pośredników instrukcja dla Użytkownika Pożyczka gotówkowa

Spis treści. Strona: 1/26

Instrukcja składania wniosku o dofinansowanie w systemie informatycznym IP na potrzeby konkursu nr 1/4.1.4/2015

Przewodnik... Budowanie listy Odbiorców

SZKOLNE KONTA POCZTOWE

Instrukcja sprawdzenia danych konta dyrektora ośrodka egzaminacyjnego (OE) oraz wyboru metod komunikacji

SZYBKI START. Tworzenie nowego połączenia w celu zaszyfrowania/odszyfrowania danych lub tekstu 2. Szyfrowanie/odszyfrowanie danych 4

Budowanie listy Odbiorców

INSTRUKCJA PIERWSZEGO LOGOWANIA DO PORTALU INFORMACYJNEGO RESORTU OBRONY NARODOWEJ

IIIIIIIIIIIIIIIMMIMMIII

Pierwsze kroki Statusy transakcji Zwrot płatności przelewem lub kartą Odbiór wpłat Czas realizacji płatności...

Definiowanie filtrów IP

Gatesms.eu Mobilne Rozwiązania dla biznesu

OPIS TECHNICZNY SYSTEM HOSTED SMS

1. Pobieranie i instalacja FotoSendera

INSTRUKCJA REJESTRACJI ORGANIZACJI W GENERATORZE WNIOSKÓW APLIKACYJNYCH SI NAWIKUS

DOKUMENTACJA INTERFEJSU MY MYSQL. Platforma SMeSKom instrukcja podłączenia poprzez mysql Protokół w wersji 3.1

INSTRUKCJA OBSŁUGI SERWISU ALLPAY.PL. 1. Płatności internetowe

PORTAL PACJENTA CONCIERGE

Rejestratory i kamery HQ. Instrukcja konfiguracji dostępu zdalnego przez chmurę w aplikacji HQ-Connect

Instrukcja obsługi programu

Integracja Allegro Menadż er Sprżedaż y DHL ecas

PODRĘCZNIK OBSŁUGI BUSINESSNET

Spis treści INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHNICZNA 1

ENTERPRISE PARK System rezerwacji rowerów

Instrukcja dodawania danych pojedynczej osoby, dla której ośrodek egzaminacyjny jest organizatorem egzaminu potwierdzającego kwalifikacje w zawodzie

Atrybuty SMS. Nazwa Twojej firmy lub produktu w SMS-ie podniesie prestiż Twojej wiadomości

Korporacja Kurierska

Instrukcja Inetgracja z Clickshop. Wersja z 29/10/2014. Copyright Zakupteraz.pl

Kolejność działań przy zakładaniu dziennika powinna być następująca. pokaż nauczycieli - wyświetla listę wszystkich nauczycieli w bazie

DOKUMENTACJA SOAP API. ver 2.0

Transkrypt:

Funkcje dodatkowe

SPIS TREŚCI 1.Wprowadzenie 1.1 Adresy URL do połączenia z aplikacją dla funkcji zarządzania kontem 1.2 Adresy URL do połączenia z aplikacją dla funkcji zarządzania polami nadawcy I. ZARZĄDZANIE KONTEM UŻYTKOWNIKA 2. Dodawanie użytkownika 3. Edycja użytkownika 4. Pobieranie danych użytkownika 5. Sprawdzanie liczby punktów na koncie 6. Pobieranie listy użytkowników II. ZARZĄDZANIE POLAMI NADAWCY 7. Dodawanie pola nadawcy 8. Sprawdzanie statusu pola nadawcy 9. Usuwanie pola nadawcy 10. Sprawdzanie listy dostępnych pól nadawcy 11. Ustawianie domyślnego pola nadawcy Dodatek Kody błędów Historia zmian Strona nr: 2/15 idź do spisu treści

1.Wprowadzenie Interfejs API do obsługi funkcji dodatkowych skupia dwie grupy funkcji zarządzania kontem w serwisie SMSAPI: Zarządzanie kontem użytkownika (w tym kontami użytkowników) Zarządzanie polami nadawców 1.1 Adresy URL do połączenia z aplikacją dla funkcji zarządzania kontem Adresy URL do połączenia z aplikacją zwane dalej Adresem połączenia : - https://api.smsapi.pl/user.do - dla połączeń szyfrowanych SSL - https://api2.smsapi.pl/user.do - backup dla połączeń szyfrowanych SSL - http://api.smsapi.pl/user.do - dla połączeń standardowych (Niezalecane!) - http://api2.smsapi.pl/user.do - backup dla połączeń standardowych (Niezalecane!) - 1.2 Adresy URL do połączenia z aplikacją dla funkcji zarządzania polami nadawcy Adresy URL do połączenia z aplikacją zwane dalej Adresem połączenia : - https://api.smsapi.pl/sender.do - dla połączeń szyfrowanych SSL - https://api2.smsapi.pl/sender.do - backup dla połączeń szyfrowanych SSL - http://api.smsapi.pl/sender.do - dla połączeń standardowych (Niezalecane!) - http://api2.smsapi.pl/sender.do - backup dla połączeń standardowych (Niezalecane!) Strona nr: 3/15 idź do spisu treści

2. Dodawanie użytkownika W celu dodania nowego konta użytkownika należy w odwołaniu umieścić parametr &add_user=poduzytkownik oraz parametry określające właściwości dodawanego konta. Zarządzanie kontem odbywa się przez wysłanie metodą GET POST danych do adresu połączenia odpowiednich parametrów: add_user * pass * pass_api limit month_limit senders Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 Nazwa dodawanego użytkownika bez prefiksu użytkownika głównego Hasło do panelu klienta SMSAPI dodawanego użytkownika zakodowane w md5 Hasło do interfejsu API dla użytkownika zakodowane w md5, brak tego parametru spowoduje ustawienie jako hasła do API kopii hasła do panelu klienta Limit punktów przydzielony użytkownikowi Ilość punktów która będzie przypisana do konta użytkownika każdego pierwszego dnia Udostępnienie pól nadawców konta głównego (dostępne wartości: 1 udostępniaj, 0 nie udostępniaj, domyślnie wartość równa 0) phonebook Udostępnienie grup książki telefonicznej konta głównego (dostępne wartości: 1 udostępniaj, 0 nie udostępniaj, domyślnie wartość równa 0). Po udostępnieniu książki użytkownik będzie mógł wysyłać do grup wiadomości nie będzie jednak widział poszczególnych kontaktów w książce telefonicznej. active info without_prefix Aktywowanie konta użytkownika (dostępne wartości: 1 aktywne, 0 nieaktywne, domyślnie wartość równa 0) Dodatkowy opis użytkownika Dla &=json powoduje, że zwrotka z API wysyłana jest w formacie JSON, w zwrotce oprócz potwierdzenia, zawierająca następujące parametry: limit, limit_month, senders, phonebook, active, info. Ustawienie tego parametru pozwala na dodanie użytkownika bez prefixu użytkownika głównego (poduzytkownik zamiast uzytkownik_poduzutkownik) - pole obowiązkowe https://api.smsapi.pl/user.do? username=uzytkownik&password=haslo_w_md5&add_user=poduzytko wnik&pass=haslo_poduzytkownika_w_md5 OK:<SUB_NAME> w razie błędu <SUB_NAME> nazwa użytkownika wraz z prefiksem użytkownika głównego <ERR> Przykład: kod błędu (zobacz dodatek kody błędów) OK:uzytkownik_poduzytkownik ERROR:1001 Strona nr: 4/15 idź do spisu treści

2 "username":"uzytkownik_poduzytkownik", //pełna nazwa użytkownika 3 "limit":0, // limit punktów 4 "month_limit":0, // miesięczny, odnawialny limit 5 "senders":0, // udostępnienie pól nadawców użytkownika głównego 6 "phonebook":0, // udostępnienie bazy numerów użytkownika głównego 7 "active":false, // aktywny (true) nieaktywny (false 8 "info":"unknown" // dodatkowy opis 9 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/ 3. Edycja użytkownika W celu edycji parametrów istniejącego konta użytkownika należy w odwołaniu umieścić parametr &set_user=uzytkownik oraz parametr odpowiadający właściwości, która ma zostać zmieniona. Zarządzanie kontem odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: set_user * pass pass_api limit month_limit senders Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 (konto główne) Nazwa edytowanego użytkownika bez prefiksu użytkownika głównego Nowe hasło do panelu klienta SMSAPI użytkownika zakodowane w md5 Hasło do interfejsu API dla użytkownika zakodowane w md5, Limit punktów przydzielony użytkownikowi Miesięczny, odnawialny limit punktów przydzielony użytkownikowi Udostępnienie pól nadawców konta głównego (dostępne wartości: 1 udostępniaj, 0 nie udostępniaj) phonebook Udostępnienie grup książki telefonicznej konta głównego (dostępne wartości: 1 udostępniaj, 0 nie udostępniaj) active info without_prefix Aktywowanie konta użytkownika (dostępne wartości: 1 aktywne, 0 nieaktywne) Dodatkowy opis użytkownika Dla &=json powoduje, że zwrotka z API wysyłana jest w formacie JSON, w zwrotce oprócz potwierdzenia, zawierająca następujące parametry: limit, limit_month, senders, phonebook, active, info. Ustawienie tego parametru jest konieczne jeżeli nazwa użytkownika nie posiada prefiksu użytkownika głównego, w przeciwnym razie zostanie zwrócony bład 1032. - pole obowiązkowe https://api.smsapi.pl/user.do? username=uzytkownik&password=haslo_w_md5&set_user=pouzytkowni k&pass=nowe_haslo_dla_poduzytkownika_w_md5&active=1 Strona nr: 5/15 idź do spisu treści

OK:<SUB_NAME> w razie błędu <SUB_NAME> nazwa użytkownika wraz z prefiksem użytkownika głównego <ERR> kod błędu (zobacz dodatek kody błędów) Przykład: OK:użytkownik_użytkownik ERROR:1001 2 "username":"uzytkownik_poduzytkownik", //pełna nazwa użytkownika 3 "limit":0, // limit punktów 4 "month_limit":0, // miesięczny, odnawialny limit 5 "senders":0, // udostępnienie pól nadawców użytkownika głównego 6 "phonebook":0, // udostępnienie bazy numerów użytkownika głównego 7 "active":active, // aktywny (true) nieaktywny (false 8 "info":"unknown" // dodatkowy opis 9 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. 4. Pobieranie danych użytkownika W celu pobrania informacji dotyczących istniejącego konta użytkownika należy w odwołaniu umieścić parametr &get_user=1. Zarządzanie kontem odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: get_user * without_prefix Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 (konto główne) Nazwa użytkownika bez prefiksu użytkownika głównego &=json powoduje zwrócenie wyniku obiektu w formacie JSON zawierającego następujące parametry: limit, limit_month, senders, phonebook, active, info. Nie podanie parametru spowoduje wyświetlenie informacji w postaci: OK:limit:month_limit:senders:phonebook:active:info Ustawienie tego parametru jest konieczne jeżeli nazwa użytkownika nie posiada prefiksu użytkownika głównego, w przeciwnym razie zostanie zwrócony bład 1032. - pole obowiązkowe Strona nr: 6/15 idź do spisu treści

https://api.smsapi.pl/user.do? username=uzytkownik&password=haslo&get_user=poduzytkownik OK:<LIMIT>:<MONTH_LIMIT>:<SENDERS>:<PHONEBOOK>:<ACTIVE>:<INFO> w razie błędu <LIMIT> <MONTH_LIMIT> <SENDERS> <PHONEBOOK> <ACTIVE> <ERR> Limit punktów przydzielony użytkownikowi Miesięczny, odnawialny limit punktów przydzielony użytkownikowi Udostępnienie pól nadawców konta głównego (dostępne wartości: 1 udostępnione, 0 nie udostępnione). Udostępnienie grup książki telefonicznej konta głównego (dostępne wartości: 1 udostępnione, 0 nie udostępnione) Stan konta (dostępne wartości: 1 - konto aktywne, 0 - konto nieaktywne) kod błędu (zobacz dodatek kody błędów) Przykład: OK:10:10:1:1:1:opis użytkownika ERROR:1001 2 "username":"uzytkownik_poduzytkownik", //pełna nazwa użytkownika 3 "limit":"10.0000", // limit punktów 4 "month_limit":"0.0000", // miesięczny, odnawialny limit 5 "senders":"0", // udostępnienie pól nadawców użytkownika głównego 6 "phonebook":"0", // udostępnienie bazy numerów użytkownika głównego 7 "active":"1", // aktywny (true) nieaktywny (false 8 "info":"unknown" // dodatkowy opis 9 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. Strona nr: 7/15 idź do spisu treści

5. Sprawdzanie liczby punktów na koncie W celu sprawdzenia ilości środków pozostałych na koncie dla istniejącego użytkownika należy w odwołaniu umieścić parametr &credits=1. Dodatkowo umieszczenie w odwołaniu parametru &details=1 powoduje oprócz ilości środków na koncie również zwrócenie ilości wiadomości dostępnych do wysłania. Zarządzanie kontem odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: credits* details Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 &credits=1 &details=1 powoduje dodatkowo zwrócenie ilości SMS, MMS, VMS (PRO, ECO, MMS, VMS_gsm, VMS_land) Dla &=json powoduje, że zwrotka z API wysyłana jest w formacie JSON. without_prefix Ustawienie tego parametru jest konieczne jeżeli nazwa użytkownika nie posiada prefiksu użytkownika głównego, w przeciwnym razie zostanie zwrócony bład 1032. - pole obowiązkowe https://api.smsapi.pl/user.do? username=uzytkownik&password=haslo_w_md5&credits=1&details=1 Points: <POINTS>;<PRO>;<ECO>;<MMS>;<VMS_gsm>;<VMS_land> w razie błędu <POINTS> <PRO> <ECO> <MMS> <VMS_gsm> <VMS_land> <ERR> liczba punktów dostępnych dla danego użytkownika liczba wiadomości PRO liczba wiadomości ECO liczba wiadomości MMS liczba wiadomości VMS do numerów komórkowych liczba wiadomości VMS do numerów stacjonarnych kod błędu (zobacz dodatek kody błędów) Przykład: Points: 100;606;1428;333;476;714 ERROR:1001 2 "points":6225.4875, // stan konta 3 "procount":"41503", // liczba wiadomości PRO 4 "ecocount":"95776", // liczba wiadomości ECO 5 "mmscount":"20751", // Liczba wiadomości MMS 6 "vmsgsmcount":"31127", // liczba wiadomośći VMS do numerów GSM 7 "vmslandcount":"47888" // liczba wiadomości VMS do numerów stacjonarnych 8 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/ Strona nr: 8/15 idź do spisu treści

6. Pobieranie listy użytkowników W celu pobrania listy użytkowników należy w odwołaniu umieścić parametr &list=1. Dodatkowo po dodaniu parametru &=json w odpowiedzi zwracana jest tablica obiektów w formacie JSON zawierająca dane o kontach użytkowników jak dla parametru &get_user=1. Zarządzanie kontem odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: list* Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 &list=1 zwraca listę użytkowników dla danego konta głównego &=json powoduje zwrócenie w wyniku tablicy obiektów w formacie JSON zawierającego następujące parametry: username, limit, limit_month, senders, phonebook, active, info * - pole obowiązkowe https://api.smsapi.pl/user.do? username=uzytkownik&password=haslo&list=1 OK: uzytkownik_poduzytkownik1: uzytkownik_poduzytkownik2 <ERR> kod błędu (zobacz dodatek kody błędów) 1 [{ 2 "username":"uzytkownik_poduzytkownik", //pełna nazwa użytkownika 3 "limit":"10.0000", // limit punktów 4 "month_limit":"0.0000", // miesięczny, odnawialny limit 5 "senders":"0", // udostępnienie pól nadawców użytkownika głównego 6 "phonebook":"0", // udostępnienie bazy numerów użytkownika głównego 7 "active":"1", // aktywny (true) nieaktywny (false 8 "info":"unknown" // dodatkowy opis 9 }, 10 "username":"uzytkownik_poduzytkownik2", //pełna nazwa użytkownika 11 "limit":"0.0000", // limit punktów 12 "month_limit":"0.0000", // miesięczny, odnawialny limit 13 "senders":"0", // udostępnienie pól nadawców użytkownika głównego 14 "phonebook":"0", // udostępnienie bazy numerów użytkownika głównego 15 "active":"0", // aktywny (true) nieaktywny (false 16 "info":"unknown" // dodatkowy opis 17 }] w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. Strona nr: 9/15 idź do spisu treści

7. Dodawanie pola nadawcy Funkcja dodawania pól nadawcy wymaga dodatkowej aktywacji. Aby aktywować funkcję prosimy o kontakt z Biurem Obsługi Klienta. 8. Sprawdzanie statusu pola nadawcy W celu sprawdzenia statusu dowolnego pola nadawcy należy w odwołaniu umieścić parametr &status=nazwa, gdzie nazwa jest nazwą pola nadawcy, którego status ma być sprawdzony. Zarządzanie polami nadawcy odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: status* Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 Nazwa pola nadawcy, którego status ma być sprawdzony &=json powoduje zwrócenie wyniku obiektu w formacie JSON zawierającego następujące parametry: nazwa_nadawcy, status oraz informację czy nazwa jest nazwą domyślną. * - pole obowiązkowe https://api.smsapi.pl/sender.do? username=uzytkownik&password=haslo&status=nazwa OK:<STATUS> w razie błędu <STATUS> status pola nadawcy, dostępne wartości: INACTIVE pole nadawcy nieaktywne, czeka na weryfikacje PENDING pole nadawcy zweryfikowane, nie aktywowane, aktywacja nastąpi po przesłaniu oświadczenia ACTIVE pole nadawcy aktywne, możliwa jest wysyłka wiadomości z tym polem nadawcy <ERR> Przykład: kod błędu (zobacz dodatek kody błędów) OK:ACTIVE ERROR:2001 2 "name":"smsapi", // pole nadawcy 3 "status":"active", // status 4 "default":true // domyślne pole nadawcy 5 } w razie błędu: Strona nr: 10/15 idź do spisu treści

powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/ 9. Usuwanie pola nadawcy W celu usunięcia dowolnego pola nadawcy należy w odwołaniu umieścić parametr &delete=nazwa, gdzie nazwa jest nazwą pola nadawcy, które ma być usunięte. Zarządzanie polami nadawcy odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: delete* Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 Nazwa pola nadawcy, którego status ma być sprawdzony Dla &=json powoduje, że zwrotka z API wysyłana jest w formacie JSON,. * - pole obowiązkowe https://api.smsapi.pl/sender.do? username=uzytkownik&password=haslo&delete=nazwa OK:<NAZWA_NADAWCY> w razie błędu <NAZWA_NADAWCY>nazwa pola nadawcy, które zostało usunięte <ERR> kod błędu (zobacz dodatek kody błędów) Przykład: OK:nazwa ERROR:2001 2 "count": 1 3 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. Strona nr: 11/15 idź do spisu treści

10. Sprawdzanie listy dostępnych pól nadawcy W celu sprawdzenia listy dostępnych pól nadawcy, wraz z ich statusami, należy w odwołaniu umieścić parametr &list=1. Zarządzanie polami nadawcy odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: list* with_nat_names Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 &list=1 powoduje zwrócenie dostępnych pól nadawcy wraz z ich statusami &=json powoduje zwrócenie w wyniku tablicy obiektów w formacie JSON zawierającego następujące parametry: nazwa_nadawcy, status oraz informację czy dana nazwa jest nazwą domyślną Ustawienie tego parametru powoduje wyświetlenie na liście również nazw udostępnionych przez użytkownika głównego (dla użytkowników) * - pole obowiązkowe https://api.smsapi.pl/sender.do? username=uzytkownik&password=haslo&list=1 OK:<NAZWA_1>,<STATUS_1>:<NAZWA_2>:<STATUS_2>...,...:...,...:...,... w razie błędu <NAZWA_nr> <STATUS_nr> <ERR> Przykład: kolejne nazwy pól nadawcy statusy kolejnych nazw pola nadawcy kod błędu (zobacz dodatek kody błędów) OK:nazwa_1,ACTIVE:nazwa_2,PENDING:nazwa_3:INACTIVE ERROR:2001 1 [{ 2 "sender":"smsapi", // pole nadawcy 3 "status":"active", // status 4 "default":true // domyślne pole nadawcy 5 }, 6 { 7 "sender":"smsapi.pl", // pole nadawcy 8 "status":"inactive", // status 9 "default":false // domyślne pole nadawcy 10 }, 1 12 "sender":"sms", // pole nadawcy 13 "status":"active", // status 14 "default":false // domyślne pole nadawcy 15 }] Strona nr: 12/15 idź do spisu treści

w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. 11. Ustawianie domyślnego pola nadawcy Domyślne pole nadawcy jest to nazwa, z która zostanie wysłana wiadomość w przypadku przesłania parametru &from gdy parametr ten jest pusty. Pole nadawcy ustawiane jako domyślne musi być aktywne. W przypadku braku domyślnego pola nadawcy wiadomości takie wysyłane są z nazwą SMSAPI. W celu ustawienia nazwy jako domyślne pole nadawcy należy umieścić parametr &default=nazwa, gdzie nazwa jest nazwą pola nadawcy, które ma być domyślnym. Zarządzanie polami nadawcy odbywa się przez wysłanie metodą GET POST danych do adresu połączenia: default* Nazwa użytkownika adres e-mail przypisany do konta w serwisie SMSAPI Hasło do Twojego konta w serwisie SMSAPI zaszyfrowane w MD5 Nazwa, która ma być ustawiona jako domyślna Dla &=json powoduje, że zwrotka z API wysyłana jest w formacie JSON. * - pole obowiązkowe https://api.smsapi.pl/sender.do? username=uzytkownik&password=haslo&default=domyslna_nazwa OK w razie błędu Przykład: OK ERROR:2062 2 "count": 1 3 } w razie błędu: powyżej) można wykorzystać adres URL backup https://api2.smsapi.pl/. Strona nr: 13/15 idź do spisu treści

Dodatek Kody błędów Tabela kodów błędu: ERROR 8 Błąd w odwołaniu (Prosimy zgłosić) 101 Niepoprawne brak danych autoryzacji 102 Nieprawidłowy login hasło 105 Błędny adres IP (włączony filtr IP dla interfejsu API) 999 Wewnętrzny błąd systemu (prosimy zgłosić) 1000 Akcja dostępna tylko dla użytkownika głównego 1001 Nieprawidłowa akcja (oczekiwane jedna z add_user, set_user, get_user, credits) 1010 Błąd dodawania użytkownika 1020 Błąd edycji konta użytkownika 1021 Brak danych do edycji, przynajmniej jeden parametr musi być edytowany 1030 Błąd pobierania danych użytkownika 1032 Nie istnieje użytkownik o podanej nazwie dla danego użytkownika głównego 1100 Błąd danych użytkownika 1110 Błędna nazwa tworzonego użytkownika 1111 Nie podano nazwy tworzonego konta użytkownika 1112 Nazwa konta użytkownika za krótka (minimum 3 znaki) 1113 Nazwa konta użytkownika za długa, łączna długość nazwy użytkownika wraz z prefiksem użytkownika głównego może mieć maksymalnie 32 znaki 1114 W nazwie użytkownika pojawiły się nidozwolone znaki, dozwolone są litery [A Z], cyfry [0 9] oraz znaki @, -, _ i. 1115 Istnieje już użytkownik o podanej nazwie 1120 Błąd hasła dla tworzonego konta użytkownika 1121 Hasło dla tworzonego konta użytkownika za krótkie 1122 Hasło dla tworzonego konta użytkownika za długie 1123 Hasło powinno być zakodowane w MD5 1130 Błąd limitu punktów przydzielanego użytkownikowi 1131 limit powinno zawierać wartość numeryczną 1140 Błąd limitu miesięcznego punktów przydzielanego użytkownikowi 1141 month_limit powinno zawierać wartość numeryczną 1150 Błędna wartość parametru senders, dopuszczalne wartości dla tego parametru to 0 1 1160 Błędna wartość parametru phonebook, dopuszczalne wartości dla tego parametru to 0 1 1170 Błędna wartość parametru active, dopuszczalne wartości dla tego Strona nr: 14/15 idź do spisu treści

parametru to 0 1 1180 Błąd parametru info 1183 Zawartość parametru info jest za długa 1190 Błąd hasła do interfejsu API dla konta użytkownika 1192 Błędna długość hasła do interfejsu API dla konta użytkownika (hasło zakodowane w md5 powinno mieć 32 znaki) 1193 Hasło do interfejsu powinno zostać podane w formie zakodowanej w md5 2001 Nieprawidłowa akcja (oczekiwane jedna z add, status, delete, list) 2010 Błąd dodawania pola nadawcy 2030 Błąd sprawdzania statusu pola nadawcy 2031 Nie istnieje pole nadawcy o podanej nazwie 2060 Błąd dodawania domyślnego pola nadawcy 2061 Pole nadawcy musi być aktywne, żeby ustawić je jako domyślne 2062 Pole nadawcy już jest ustawione jako domyślne 2100 Błąd przesyłanych danych 2110 Błąd nazwy pola nadawcy 2111 Brak nazwy dodawanego pola nadawcy (parametr &add jest pusty) 2112 Niepoprawna nazwa pola nadawcy (np. numer telefonu, zawierająca polskie i/ specjalne znaki za długie), pole nadawcy może mieć maksymalnie 11 znaków, dopuszczalne znaki: a-z A-Z 0-9 -. [spacja] 2115 Pole o podanej nazwie już istnieje Historia zmian Wersja Data Zmiany Wersja 1.2.2 22.11.2016r 1. Aktualizacja dostępnych funkcji dla sender.do 07.08.2013r 1. Dodana rozszerzona zwrotka dla pobierania stanu kunta w formacie JSON 2. Dodany parametr without_prefix dla akcji user.do Wersja 1.2.0 16.07.2013 1. Dodano mozliwość pobierania odpowiedzi z API w formacie JSON dla wszystkich akcji. Wersja 1.1.0 12.06.2013r 1. Dodano parametr with_nat_names dla funkcji sprawdzania listy dostępnych pól nadawców Wersja 1.0 04.01.2012r 1. funkcji pozwalających na zarządzanie użytkownikami 2. funkcji pozwalających na zarządzanie polami nadawcy UWAGA! Najnowsza specyfikacja techniczna SMSAPI znajduje się w zakładce POMOC na stronie https://www.smsapi.pl/ Strona nr: 15/15 idź do spisu treści