HTTPS API
SerwerSMS.pl to narzędzie, które umożliwia wysyłanie powiadomień, wiadomości oraz dokonywanie innych marketingowych czynności w sposób zdalny, bez konieczności logowania się do Panelu Klienta. Komunikacja następuje z wykorzystaniem protokołu HTTPS i polega na wywołaniu określonego adresu URL, a następnie przetworzeniu otrzymanego dokumentu JSON lub XML. W tym celu stworzony został zestaw instrukcji do komunikacji z Platformą SerwerSMS.pl.
Pliki do pobrania
- Dokumentacja HTTPS API do obsługi SerwerSMS.pl
- Klienci napisani w najpopularniejszych językach programowania ułatwiający integrację, do pobrania w serwisie GitHub.
- Klasa wspomagająca tworzenie formularza dodawania numerów telefonów do Kontaktów w Panelu Klienta. Skrypt bazuje na interfejsie HTTPS XML API i napisany jest w języku PHP. Paczka zawiera dokumentację oraz gotowe przykłady, które po konfiguracji można umieścić bezpośrednio na swojej stronie internetowej.
Jeśli masz problem z odczytem powyższego pliku PDF, prosimy o pobranie i zainstalowanie najnowszej wersji programu Adobe Acrobat lub Foxit Reader.
Jeśli masz dodatkowe pytania lub wątpliwości, skontaktuj się z nami np. poprzez helpdesk.
Kilka przykładowych akcji możliwych w komunikacji zdalnej HTTPS API:
- Wysyłka standardowych wiadomości SMS (o jednakowej treści);
- Wysyłka spersonalizowanych wiadomości SMS;
- Pobranie pełnego raportu: daty, ID wiadomości oraz numer telefonu;
- Pobieranie odpowiedzi SMS z filtrowaniem według daty oraz numeru telefonu;
- Pobierania wiadomości przychodzących z usług Numer Dostępowy, Numer Dostępowy Indywidualny oraz Premium SMS;
- Sprawdzenie stanu posiadanych wiadomości
- Dodawanie listowanie oraz sprawdzanie stanu nazw nadawcy
- Dodawanie, listowanie oraz usuwanie kontaktów oraz grup
SMPP API
Platforma SerwerSMS udostępnia metodę komunikacji poprzez protokół SMPP (Short Message Peer-to-Peer). SMPP to protokół bazujący na poziomie komunikacji TCP/IP i służący do wymiany m.in. krótkich wiadomości tekstowych (SMS) pomiędzy dwoma systemami informatycznymi, najczęściej za pośrednictwem szyfrowanego kanału VPN. Połączenie to jest dedykowane dla Abonentów, którzy wysyłają duże ilości wiadomości lub dla takich, którzy już mają obecnie zintegrowane własne oprogramowanie z użyciem protokołu SMPP, np. z innym dostawcą lub Operatorem GSM.
Bezpieczeństwo
- na potrzeby połączeń SMPP, w Panelu Klienta należy utworzyć konto użytkownika SMPP
- możliwe jest zestawienie tunelu VPN pomiędzy Klientem a SerwerSMS (opcja odpłatna, dostępna dla Klientów abonamentowych)
- komunikacja odbywa się z autoryzowanych adresów IP
Kompatybilne oprogramowanie
- Kannel (www.kannel.org)
- Ozeki SMS (www.ozeki.hu)
- Wszelkie inne oprogramowanie wspierające komunikację za pośrednictwem protokołu SMPP w wersji 3.4
Pliki do pobrania
Kilka przykładowych akcji możliwych w komunikacji zdalnej SMPP API:
- Wysyłka wiadomości z wcześniej zgłoszonymi nagłówkami alfanumerycznymi oraz numerami 9-cio cyfrowymi (NDI)
- Wsparcie dla długich wiadomości powyżej 160 znaków (max 918 znaków)
- Wsparcie dla kodowania 7bit ASCII oraz UTF-8
- Obsługa wiadomości wyskakujących Flash SMS
- Szybka aktualizacja raportów doręczeń
- Obsługa wiadomości przychodzących tzw. MO
SMPP dostępne jest dla wszystkich Klientów. VPN może zostać zestawiony dla klientów abonamentowych (w zależności od oferty, może zostać naliczona opłata za utrzymanie kanału VPN)
SMS przez FTP
„SMS przez FTP” to usługa polegająca na prostym wysyłaniu wiadomości z wykorzystaniem serwera FTP po stronie Klienta.
Aby zrealizować wysyłkę SMS-ów, wystarczy przygotować plik (TXT lub CSV) zawierający dane niezbędne do przeprowadzenia dystrybucji i umieścić go na swoim serwerze FTP. SerwerSMS łącząc się cyklicznie ze wskazanym serwerem, sprawdzi, czy na serwerze pojawiły się nowe pliki do przetworzenia. System automatycznie zrealizuje wysyłkę krótkich wiadomości tekstowych w przypadku znalezienia nowych plików wiadomości na serwerze. Dzięki temu Klient oszczędza czas, ponieważ zmniejszeniu ulega Ilość wykonywanych operacji, które musi wykonać, aby zrealizować wysyłkę. Prowadzi kampanie SMS bez konieczności logowania się do Panelu Klienta, wczytywania kontaktów itp. Usługa „SMS przez FTP” , umożliwia przeprowadzenie wysyłki SMS-ów również ze stanowisk pozbawionych bezpośredniego dostępu do Internetu. Wystarczy podłączony lokalnie dysk FTP, aby jednym kliknięciem przekazać krótkie wiadomości tekstowe do wskazanych adresatów.
Bezpieczeństwo
- na potrzeby usługi SMS przez FTP należy utworzyć konfigurację w Panelu Klienta (szczegóły w dokumentacji oraz Panelu Klienta).
- komunikacja odbywa się przez protokół FTP, który nie jest standardowo szyfrowany. W celu zapewnienia poufności przekazywanych danych, zalecane jest utworzenie tunelu VPN pomiędzy systemem Klienta a SerwerSMS (szczegóły w cenniku).
- możliwe jest zastosowanie SSL przy połączeniu do FTP, czyli tzw. FTPS
- połączenie SFTP (Secure FTP) jest na chwilę obecną niedostępne
Pliki do pobrania
Kilka przykładowych akcji możliwych w usłudze SMS przez FTP:
- Wysyłka wiadomości z wcześniej zgłoszonymi nagłówkami alfanumerycznymi oraz numerami 9-cio cyfrowymi (NDI)
- Wsparcie dla długich wiadomości powyżej 160 znaków (max 918 znaków)
- Wsparcie dla kodowania 7bit ASCII oraz UTF-8 (polskie znaki diakrytyczne będą przekodowane do ich odpowiedników "bez ogonków")
SQL API
„SQL API” to usługa polegająca na wysyłaniu wiadomości SMS i VMS oraz odbieraniu wiadomości SMS z wykorzystaniem serwera SQL po stronie Klienta lub SerwerSMS
Aby zrealizować wysyłkę SMS-ów, wystarczy dopisać do jednej z tabel rekord zawierający m.in. numer odbiorcy, treść oraz opcjonalnie nazwę nadawcy i inne parametry. SerwerSMS łącząc się cyklicznie ze wskazanym serwerem, sprawdzi, czy w bazie pojawiły się nowe rekordy do przetworzenia. System automatycznie zrealizuje wysyłkę krótkich wiadomości tekstowych w przypadku znalezienia nowych rekordów w tabeli na serwerze, dzięki temu Klient oszczędza czas. Zmniejszeniu ulega liczba operacji, które musi wykonać, aby zrealizować wysyłkę. SQL API umożliwia również przeprowadzenia kampanii bez konieczności logowania się do Panelu Klienta, wczytywania kontaktów itp. Dodatkowo SQL API automatycznie zaktualizuje w tabeli raport doręczenia oraz dopisze ew. nowe odpowiedzi SMS do odpowiedniej tabeli.
Bezpieczeństwo
- Na potrzeby usługi SQL API należy utworzyć konfigurację w Panelu Klienta (szczegóły w dokumentacji oraz Panelu Klienta).
- Komunikacja odbywa się na wskazany numer portu. W celu zapewnienia poufności przekazywanych danych, zalecane jest utworzenie tunelu VPN pomiędzy systemem Klienta a SerwerSMS (szczegóły w cenniku).
Pliki do pobrania
Kilka przykładowych akcji możliwych w usłudze SQL API:
- Wysyłka wiadomości z wcześniej zgłoszonymi nagłówkami alfanumerycznymi oraz numerami 9-cio cyfrowymi (NDI)
- Wysyłka wiadomości VMS (tekstowych)
- Wsparcie dla długich wiadomości powyżej 160 znaków (max 918 znaków)
- Wsparcie dla kodowania 7bit ASCII oraz UCS2
- Odbiór wiadomości ND, SC, NDI, SCI
- Aktualizacja raportów doręczenia wysłanych wiadomości wraz ze stanem, datą aktualizacji raportu, ew. kodem błędu i opisem tekstowym
SOAP
Usługa SOAP polega na skonfigurowaniu połączenia HTTP w którym struktura danych określona jest w formacie XML.
Wiadomość ta zawiera następujące elementy (tagi):
- envelope, zawiera treść wiadomości,
- header, element opcjonaly, zawiera informacje nagłówkowe,
- body, zawiera zapytanie i odpowiedź.
Kilka przykładowych akcji możliwych w komunikacji SOAP:
- Wysyłka standardowych wiadomości SMS (o jednakowej treści);
- Wysyłka spersonalizowanych wiadomości SMS;
- Pobranie pełnego raportu: daty, ID wiadomości oraz numer telefonu;
- Pobieranie odpowiedzi SMS z filtrowaniem według daty oraz numeru telefonu;
- Pobierania wiadomości przychodzących z usług Numer Dostępowy, Numer Dostępowy Indywidualny oraz Premium SMS;
- Sprawdzenie stanu posiadanych wiadomości
- Dodawanie listowanie oraz sprawdzanie stanu nazw nadawcy
- Dodawanie, listowanie oraz usuwanie kontaktów oraz grup
Pełna dokumentacja techniczna znajduje się na dev.serwersms.pl