Publiczne API do BramaSMS.pl

Co to jest API?

Jeśli nie wiesz co to jest to najprawdopodobniej go nie potrzebujesz. API to skryptowy dostęp do wysyłania Premium SMS.

Informacje ogólne

API dostępne jest pod adresem: http://www.bramasms.pl/api.php

Wszystkie komunikaty od API kodowane są ISO-8859-2. Wszystkie polecenia do API powinny być wysyłane kodowaniem ISO-8859-2.

Polecenie składa się z adresu API, znaku '?' oraz parametrów w postaci nazwa=wartość połączonych znakiem '&'.
UWAGA: wartości parametrów powinny być zakodowane do postaci URL (php: urlencode, javascript: encodeURIComponent)

Przykładowe polecenie wylistowania zawartości książki adresowej powinno wyglądać tak:
http://www.bramasms.pl/api.php?login=twójLogin&password=twojeHasło&act=bookList

Wszystkie polecenia (jeśli nie opisano inaczej) zwracają tekst '+OK' w przypadku poprawnego wykonania lub '-ERR[spacja][komunikat błędu]' gdy wystąpił błąd.

Kiedykolwiek mowa o numerze telefonu to należy przyjąć format międzynarodowy zgodny z Rekomendacją ITU-T E.123 z kropką po kodzie kraju i pozbawiony wszelkich innych separatorów. Przykład: +1234.123456789012. Kod kraju powinien składać się z 1-4 cyfr. Numer lokalny może zawierać od 8 do 12 cyfr.

Komendy

• wysłanie wiadomości
  parametry:
  • act=send
  • login - login
  • password - hasło
  • from - ksywka
  • to - numer telefonu
  • body - treść wiadomości
• pobranie listy dostępnych prefiksów
  parametry:
  • act=prefixes
  zwracana jest lista prefiksów w formacie "[prefix]:[nazwa kraju]"
• pobranie książki adresowej
  parametry:
  • act=bookList
  • login - login
  • password - hasło
  zwracana jest książka adresowa w formacie "[numer]:[opis]"
• dodanie wpisu do książki adresowej
  parametry:
  • act=bookAdd
  • login - login
  • password - hasło
  • number - numer telefonu
  • desc - opis numeru
• usuwanie wpisu z książki adresowej
  parametry:
  • act=bookDel
  • login - login
  • password - hasło
  • number - numer telefonu
• pobranie liczby punktów na koncie użytkownika
  parametry:
  • act=getTokens
  • login - login
  • password - hasło

Dostęp do API

Musisz być zalogowany!