SQL API / Tworzenie konfiguracji

Aby usługa mogła działać poprawnie, najpierw należy utworzyć konfigurację w Panelu Klienta w zakładce "Ustawienia interfejsów -> SQL API". Formularz dodawania nowej konfiguracji zawiera następujące pola:

Pole Opis
nazwa     nazwa połączenia (opisowa)
aktywne     stan połączenia, czy tabele mają być sprawdzane
typ     lokalny/zdalny (lokalny czyli baza danych i tabele po stronie SerwerSMS, zdalny czyli baza danych i tabele po stronie Klienta)
silnik bazy np. MYSQL (lub inny, w zależności od dostepności)
host     host do połączenia
numer portu port pod którym dostępna jest usługa
login     login do bazy danych
hasło     hasło do bazy danych
baza     nazwa bazy danych
struktura tabel STANDARD/INDYWIDUALNY (STANDARD - struktura zaproponowana przez SerwerSMS, INDYWIDUALNY - struktura własna narzucona przez  Klienta)

Dla indywidualnej struktury tabeli wysyłka wiadomości (MT)

nazwa tabeli nazwa tabeli do wysyłki wiadomości
pole id pole z identyfikatorem rekordu
pole numer pole z numerem telefonu
pole nazwa nadawcy  pole z nazwą nadawcy
pole wiadomość pole z treścią wiadomości
pole data pole z ew. datą wysyłki. W momencie przekazania wiadomości do realizacji, ustawiana jest bieżąca data i godzina)
pole smsid pole z identyfikatorem wiadomości (SerwerSMS)
pole raport doręczenia pole ze stanem wiadomosci ("-1" - niewysłana, 0 - wartość domyślna, 1 - doręczono, 2 - niedoręczono)
pole data doręczenia pole z datą aktualizacji raportu
pole kod raportu doręczenia pole z numerycznym kodem opisu raportu doręczenia (więcej informacji w sekcji Kody błędów)
pole opis raportu doręczenia pole z tekstowym opisem raportu doreczenia (więcej informacji w sekcji Kody błędów)
pole flagi pole z opcjonalnymi flagami np. UTF, FLASH
pole części pole z długością wiadomości (z ilu części się składa SMS)

Dla indywidualnej struktury tabeli odbiór wiadomości (MO)

nazwa tabeli nazwa tabeli do odbioru wiadomości
pole numer numer z którego przyszła wiadomość
pole nadawca numer na który przyszła wiadomość (np. NDI)
pole wiadomość  treść odebranej wiadomości
pole data data odebrania wiadomości
pole typ typ odebranej wiadomości (ECO+, ND, NDI)

Z poziomu Panelu Klienta istnieje możliwość przetestowania poprawności połączenia klikając na ikonkę test. System sprawdzi połączenie i wyświetli informację czy dostęp do bazy jest możliwy, czy są dostępne odpowiednie pola w tabeli i czy ew. są jakieś rekordy w tabeli do wysyłki wiadomości.

Istnieje również możliwość pobrania konfiguracji zawierającej pełną informację na temat danego połączenia (dostęp do bazy, nazwy tabel i pól, przykłady połączenia i wysyłki wiadomości).