Odosielanie SMS cez SOAP
WSDL: https://api.bsms.viamobile.sk/soap?wsdl
Endpoint: https://api.bsms.viamobile.sk/soap
Metóda: SendSms
HTTP Basic Autorizácia
| HTTP hlavička | Hodnota |
|---|---|
| Authorization | Basic base64(username:password) |
POST https://api.bsms.viamobile.sk/soap HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://bsms.viamobile.sk/SendSms"
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
Error kódy
| Kód | Meno | Popis |
|---|---|---|
| 1000 | Unauthorized | Nesprávne meno alebo heslo |
| 1011 | Unknown network | Nemáte povolenie na odoslanie správy do uvedenej siete |
| 1012 | Unknown sender | Sender môže byť len z rozsahu definovaného spoločnosťou Via Mobile |
| 1013 | Message too long | Správa je dlhšia ako povolený limit |
| 1014 | ID not integer | ID správy nie je numerické |
| 2001 | SMS sending disabled | Posielanie SMS nie je povolené. Prosím, kontaktujte Via Mobile |
| 2002 | Not enough credit | Nesprávne meno alebo heslo |
1.1 Odoslanie SMS
Odoslanie SMS - request
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
/sender |
Nepovinný | String(11) | Odosielateľ správy, maximálne 11 znakov, nesmie byť iba číslo.
Default: InfoSMS |
/encoding |
Nepovinný | Enum | gsm/utf8
gsm - štandardná SMS správa (prevolené, znaky z abecedy GSM7). Text do 160 znakov je 1 SMS, text nad 160 znakov sa rozdelí do: ceil(length(text)/153) SMS utf8 - unicode SMS správa (s diakritikou, znaky z UTF8 abecedy). Text do 70 znakov je 1 SMS, text nad 70 znakov sa rozdelí do: ceil(length(text)/67) SMS Default: gsm |
/time_to_send |
Nepovinný | ISO timestamp | ISO timestamp vo formáte YYYY-MM-DD HH:mm:ss, napr. 2019-01-01T21:00:00
Default: Aktuálny dátum a čas |
/message/id |
Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
/message/msisdn |
Povinný | Int64 | Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456 |
/message/text |
Povinný | String(480) | Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding) |
POST https://api.bsms.viamobile.sk/soap HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://bsms.viamobile.sk/SendSms"
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bsms="http://bsms.viamobile.sk/">
<soapenv:Header/>
<soapenv:Body>
<bsms:messages>
<sender>InfoSMS</sender>
<encoding>gsm</encoding>
<time_to_send>2020-01-01T00:00:01</time_to_send>
<bsms:message>
<id>1</id>
<msisdn>421903123456</msisdn>
<text>Test message</text>
</bsms:message>
<bsms:message>
<id>2</id>
<msisdn>421903123456</msisdn>
<text>Veeeeeeeeeeeeeeeery long SMS. Veeeeeeeeeeeeeeeery long SMS. Veeeeeeeeeeeeeeeery long SMS.
Veeeeeeeeeeeeeeeery long SMS. Veeeeeeeeeeeeeeeery long SMS. Veeeeeeeeeeeeeeeery long SMS.
</text>
</bsms:message>
</bsms:messages>
</soapenv:Body>
</soapenv:Envelope>
Odoslanie SMS - response
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
| /messageSentStatus/id | Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
| /messageSentStatus/status | Povinný | String | Stav odoslania ku každej správe:
ok - Správa odoslaná blacklist - MSISDN je na blackliste, správa neodoslaná error - Správa neodoslaná notAllowed - Nepovolené MSISDN na testovanie, správa neodoslaná network_disabled - Cieľová sieť blokovaná, správa neodoslaná |
| /messageSentStatus/duplicate | Nepovinný | Boolean | Duplicitná správa |
| /messageSentStatus/price | Nepovinný | Decimal | Cena za jednu správu (správa môže byť rozdelená do viacerých multipart SMS).
Null, ak nie je v systéme nastavená suma za 1 SMS. |
| /messageSentStatus/parts | Povinný | Int32 | Počet SMS v správe pre multipart SMS. |
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://bsms.viamobile.sk/">
<SOAP-ENV:Body>
<ns1:messageSentStatuses>
<ns1:messageSentStatus>
<id>1</id>
<status>ok</status>
<duplicate>true</duplicate>
<price>0.05</price>
<parts>1</parts>
</ns1:messageSentStatus>
<ns1:messageSentStatus>
<id>2</id>
<status>ok</status>
<duplicate>false</duplicate>
<price>0.1</price>
<parts>2</parts>
</ns1:messageSentStatus>
</ns1:messageSentStatuses>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
1.2 Odoslanie Unicode SMS
Odoslanie Unicode SMS - request
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
/sender |
Nepovinný | String(11) | Odosielateľ správy, maximálne 11 znakov, nesmie byť iba číslo.
Default: InfoSMS |
/encoding |
Nepovinný | Enum | gsm/utf8
gsm - štandardná SMS správa (prevolené, znaky z abecedy GSM7). Text do 160 znakov je 1 SMS, text nad 160 znakov sa rozdelí do: ceil(length(text)/153) SMS utf8 - unicode SMS správa (s diakritikou, znaky z UTF8 abecedy). Text do 70 znakov je 1 SMS, text nad 70 znakov sa rozdelí do: ceil(length(text)/67) SMS Default: gsm |
/time_to_send |
Nepovinný | ISO timestamp | ISO timestamp vo formáte YYYY-MM-DD HH:mm:ss, napr. 2019-01-01T21:00:00
Default: Aktuálny dátum a čas |
/message/id |
Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
/message/msisdn |
Povinný | Int64 | Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456 |
/message/text |
Povinný | String(480) | Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding) |
POST https://api.bsms.viamobile.sk/soap HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://bsms.viamobile.sk/SendSms"
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bsms="http://bsms.viamobile.sk/">
<soapenv:Header/>
<soapenv:Body>
<bsms:messages>
<sender>InfoSMS</sender>
<encoding>utf8</encoding>
<time_to_send>2020-01-01T00:00:01</time_to_send>
<bsms:message>
<id>1</id>
<msisdn>421903123456</msisdn>
<text>Text sms - ľščťžýáíé</text>
</bsms:message>
<bsms:message>
<id>2</id>
<msisdn>421903123456</msisdn>
<text>Very long SMS with accent - ľščťžýáíé ľščťžýáíé ľščťžýáíé ľščťžýáíé ľščťžýáíé </text>
</bsms:message>
</bsms:messages>
</soapenv:Body>
</soapenv:Envelope>
Odoslanie Unicode SMS - response
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
| /messageSentStatus/id | Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
| /messageSentStatus/status | Povinný | String | Stav odoslania ku každej správe:
ok - Správa odoslaná blacklist - MSISDN je na blackliste, správa neodoslaná error - Správa neodoslaná notAllowed - Nepovolené MSISDN na testovanie, správa neodoslaná network_disabled - Cieľová sieť blokovaná, správa neodoslaná |
| /messageSentStatus/duplicate | Nepovinný | Boolean | Duplicitná správa |
| /messageSentStatus/price | Nepovinný | Decimal | Cena za jednu správu (správa môže byť rozdelená do viacerých multipart SMS).
Null, ak nie je v systéme nastavená suma za 1 SMS. |
| /messageSentStatus/parts | Povinný | Int32 | Počet SMS v správe pre multipart SMS. |
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://bsms.viamobile.sk/">
<SOAP-ENV:Body>
<ns1:messageSentStatuses>
<ns1:messageSentStatus>
<id>1</id>
<status>ok</status>
<duplicate>true</duplicate>
<price>0.05</price>
<parts>1</parts>
</ns1:messageSentStatus>
<ns1:messageSentStatus>
<id>2</id>
<status>ok</status>
<duplicate>false</duplicate>
<price>0.1</price>
<parts>2</parts>
</ns1:messageSentStatus>
</ns1:messageSentStatuses>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>