Logowanie do SMSCenterAPI
Release: 15:51 04-08-2021
DOKUMENTACJA TECHNICZNA SMS API MT
Ten dokument zawiera szczegółowe informacje odnośnie sposobu przesyłania requestów do serwerów Mobitex z wykorzystaniem protokołu HTTP lub HTTPS.
Mobitex udostępnia poniższy serwer w celu wysyłki wiadomości sms:
- https://api.mobitex.pl/sms.php
Aby Klient był w stanie wysyłać wiadomości sms poniższe warunki muszą być spełnione:
- konto na serwerze Mobitex
- dodatnie saldo na koncie w trybie prepaid
- dostępny limit na koncie w trybie w postpaid
Serwery Mobitex akceptują poprawnie treści wiadomości przekazane w następujących kodowaniach: windows-1250, utf-8, iso-8859-2. W przypadku innych kodowań Mobitex nie gwarantuje poprawności konwersji treści wiadomości do alfabetu gsm.
Poniższe tabele zawierają nazwy parametrów wraz z objaśnieniami, które są niezbędne do wykonywania requestów metodą POST lub GET.
Tabela 1. Podstawowe parametry
Parametry
Objaśnienie
user
pass
login użytkownika serwisu
hasło użytkownika serwisu w formacie md5
type
typ wiadomości:
- sms – sms tekstowy
- concat – długi sms
- sms_flash – sms klasy „0”
- wap_push – wiadomość sieciowa •
- binary – sms binarny
- unicode – sms ze znakami specjalnymi (np. ą, ś, ó)
- unicode_concat – długi sms ze znakami specjalnymi
number
numer odbiorcy wiadomości; format międzynarodowy bez + czy spacji np. 48600123456
text
treść wiadomości:
- max 160 znaków dla sms i sms_flash
- max 70 znaków dla unicode
- max 459 znaków dla concat 161 – 306 znaków – 2 smsy 307 – 459 znaków – 3 smsy • max 201 znaków dla unicode_concat 71 – 134 znaków – 2 smsy 135 – 201 znaków – 3 smsy •
- max 225 znaków dla wap push; format „tytuł|url”; adres musi zawierać koniecznie http://; np. „Link| http://www.mobitex.pl
- max 280 znaków dla binary (140 octetów)
znaki [ ] ~ ^ { } | \ liczone są podwójnie
from
nadawca wiadomości:
- format numeryczny do 16 cyfr, np. 48600123456
- format alfanumeryczny do 11 znaków, np. Mobitex
ext_id
identyfikator klienta:
- dopuszczalne znaki a-zA-Z0-9!@#$%^&*()_+-={}|:<>
- max 50 znaków
Po każdym przesłaniu requestu serwery Mobitex odpowiadają wg poniższego schematu:
Status:(spacja)status,(spacja)Id:(spacja)identyfikator,(spacja)Number:(spacja)numer
np.
Status: 002, Id: 03a72a49fb9595f3737bc4a2519ff283, Number: 4860X123456
W celu otrzymywania statusów doręczeń konieczne jest ustawienie parametru URL MT w profilu konta. Przy każdej zmianie statusu wiadomości sms na URL MT będą wysyłane requesty metodą POST z poniższymi parametrami:
- sms_id – identyfikator sms
- status – aktualny status wiadomości sms
- err – wyjaśnienie statusu
- number – odbiorca wiadomości sms
- price – cena wiadomości sms
- ext_id – identyfikator klienta
Tabela 2. Kody statusów
Kody status
Objaśnienie kodu
Statusy 1 zwracane niezwłocznie podczas próby wysyłki SMS do Serwisu
001
Brak autoryzacji, błędny login lub hasło
002
Wiadomość SMS została prawidłowo odebrana przez Serwis
103
Brak pola text w wiadomości lub pole text niepełne (wap push)
104
Błędnie wypełnione lub brak pola nadawcy
105
Pole text jest za długie
106
Błędny lub brak pola numer
107
Błędny parametr type
110
Typ wiadomości nie obsługiwany
113
Pole text jest za długie
114
Nieautoryzowany nadawca
201
Błąd systemu, natychmiastowy kontakt z administratorem systemu
202
Brak środków na koncie
204
Konto nieaktywne
205
Sieć docelowa zablokowana
206
Brak autoryzacji dla użytego adresu IP
207
Błędna zawartość „ext_id”
208
Przekroczony limit miesięczny
209
Przekroczony limit dzienny
210
Nieautoryzowany url w treści
211
Przekroczony limit godzinowy
212
Przekroczony limit per numer
213
Treść wg zworca NASK
214
Nadpis zastrzeżony w NASK
301
Brak lub błędny identyfikator wiadomości
Statusy 2 wysyłane na podstawie danych przesłanych od Dostawców
003
Wiadomość została wysłana do smsc
004
Wiadomość odebrana przez odbiorcę (potwierdzenie odbioru)
005
Status pośredni, wyjaśnienie w parametrze „err” Tabela 3
007
Błąd doręczenia, wyjaśnienie w parametrze „err” Tabela 3
010
Wiadomość wygasła z powodu niemożliwości jej dostarczenia do odbiorcy
Tabela 3. Kody błędów
Kody err
Objaśnienie kodu
1
Numer MSISDN nie istnieje
2
Telefon wyłączony lub poza zasięgiem
3
Numer MSISDN zablokowany na przyjmowanie wiadomości sms
4
Karta sim pełna
5
Upłynął limit czasu na dostarczenie wiadomości sms
6
Błąd sieci GSM
7
Błąd MSC
50
Inny
Mobitex udostępnia poniższy serwer w celu sprawdzenia salda konta:
- https://api.mobitex.pl/balance.php
Tabela 4. Parametry salda konta
Parametry
Objaśnienie
user
login użytkownika serwisu
pass
hasło użytkownika serwisu w formacie MD5
w przypadku wykrycia błędów serwer Mobitex przekaże odpowiedź:
ERROR 001
w przypadku braku błędów serwer Mobitex przekaże odpowiedź:
OK XXX
gdzie XXX to saldo konta
DOKUMENTACJA TECHNICZNA SMS API MO
Ten dokument zawiera szczegółowe informacje odnośnie sposobu przesyłania requestów do serwerów Klienta z wykorzystaniem protokołu HTTP lub HTTPS.
Aby Klient był w stanie odbierać wiadomości sms muszą być spełnione poniższe warunki:
- konto na serwerze Mobitex
- wykupiona usługa „sms api“ dostęp S1, Premium sms, Sim host, Virtual sim host lub krótki numer non-premium.
W celu otrzymywania smsów przychodzących konieczne jest ustawienie Adresu URL w profilu usługi na koncie klienta.
Poniższa tabela zawieraja nazwy parametrów wraz z wyjaśnieniami, które będą wysyłane na serwer Klienta metodą POST.
Tabela 1. Podstawowe parametry
Parametry
Objaśnienie
number
numer odbiorcy wiadomości; numer karty sim, numer premium lub non-premium
- format międzynarodowy, np. 48600123456
- format lokalny, np. 70120, 4112
sender
nadawca wiadomości
- format międzynarodowy, np. 48600123456
text
treść wiadomości
sms_id
identyfikator wiadomości
- format aflanumeryczny 32 znaki np. aa30cfcc92bbe2a920f35aa8628462ac
smsc (opcja)
numer sms centrum
- format międzynarodowy np.48602951111
time
znacznik czasowy
- format unix np. 1191964672
time
dodatkowy identyfikator
- w wykupionej usłudze „sms api dostęp S1” zawiera identyfikator wcześniej wysłanej wiadomości pod numer z parametru „sender”
Serwer Mobitex oczekuje odpowiedzi serwera Klienta HTTP 200. Jeśli została zwrócona inna, request ponawiany jest co 3 min aż do skutku.
Requesty ze strony Mobitex będą wykonywane wyłącznie z 3 adresów IP: 213.5.10.19, 213.5.10.22, 91.236.125.71