Zał nr 2 do SIWZ Siren Collection

Siren Communication Specyfikacja SMS - API
SOAP web service
Wersja: 1.1.22, aktualizacja: 27.12.2013
1
Spis treści
1 Wstęp............................................................................................................................... 3
2 API SMS .......................................................................................................................... 3
2.1 Adresy URL .............................................................................................................. 3
2.2 Opis metod ............................................................................................................... 3
2.2.1 Stan konta ......................................................................................................... 3
2.2.2 Wysyłanie wiadomości ...................................................................................... 4
2.2.3 Sprawdzanie statusów....................................................................................... 5
3 Kontakt............................................................................................................................. 6
1
Wstęp
API to zestaw funkcji umożliwiających integrację z portalem [nazwa dostawy].
Udostępniane API jest w postaci usług internetowych (web service). Wykorzystywane są
następujące standardy: WSDL, SOAP, XML, XSD.
2
API SMS
2.1
Adresy URL
WSDL: http://[nazwa dostawcy] /ws/sms.wsdl
SOAP web service: http://[nazwa dostawcy ]/ws/SMSService/
Istnieje również możliwość wykorzystania szyfrowanego połączenia z usługą. Dostępna
jest ona wtedy pod adresem: https://[nazwa]/ws/SMSService/
2.2
Opis metod
2.2.1 Stan konta
Metoda balance służy do pobrania aktualnego stanu konta.
Parametry wejściowe
•
username – nazwa użytkownika
•
password – hasło
Wynik
•
status – status operacji, 1 = sukces, w innym wypadku kod błędu
•
val – ilość dostępnych SMSów
Przykładowa wiadomość SOAP:
2
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:c="http://namespace/">
<soapenv:Header/>
<soapenv:Body>
<c:BalanceRequest>
<c:username>?</c:username>
<c:password>?</c:password>
</c:BalanceRequest>
</soapenv:Body>
</soapenv:Envelope>
Przykładowa odpowiedź SOAP:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:BalanceResponse xmlns:ns2="http:// namespace /" xmlns:ns4="http://namespace/">
<ns2:return>
<ns2:status>?</ns2:status>
<ns2:val>?</ns2:val>
</ns2:return>
</ns2:BalanceResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
2.2.2 Wysyłanie wiadomości
Do wysłania wiadomości SMS służy metoda SMSSendObject. Metoda pozwala na
wysłanie więcej niż jednej wiadomości SMS. Ze względów wydajnościowych zaleca się
przekazywanie do kilkuset wiadomości w jednym wywołaniu.
Parametry wejściowe
•
username – nazwa użytkownika
•
password – hasło
•
from – nadawca SMS, maksymalnie 11 znaków
•
to – numer odbiorcy w formacie +48xxxxxxxxx
•
txt – treść wiadomości
Wynik
•
status – status operacji, 1 = sukces, w innym wypadku kod błędu
•
description – opcjonalny opis błędu
•
refid – ID wiadomości
Przykładowa wiadomość SOAP:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:c="http://namespace/">
<soapenv:Header/>
<soapenv:Body>
<c:SMSSendObjectRequest>
<c:username>?</c:username>
<c:password>?</c:password>
<c:from>?</c:from>
3
<!--1 or more repetitions:-->
<c:sms>
<c:to>?</c:to>
<c:txt>?</c:txt>
</c:sms>
</c:SMSSendObjectRequest>
</soapenv:Body>
</soapenv:Envelope>
Przykładowa odpowiedź SOAP:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns2:SMSSendObjectResponse xmlns:ns2="http:// namespace /" xmlns:ns4="http://namespace/">
<ns2:return>
<ns2:status>?</ns2:status>
<ns2:description>?</ns2:description>
<ns2:refid>?</ns2:refid>
</ns2:return>
</ns2:SMSSendObjectResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
2.2.3 Powiadomienie o zmienia statusu
System dostawcy wysyła powiadomienia przez http na wskazany adres callback, o
zmianie statusów SMSów. Przykładowy ‘querystring’ adresu:
http://www.adrescallback.com/callback?REFID=12345678&STATUS=2&REASON=&TIME
STAMP=20120501120202
4