Odosielanie SMS cez GET
GET https://api.bsms.viamobile.sk/get/send - Odoslanie SMS
HTTP Basic Autorizácia
| HTTP hlavička | Hodnota |
|---|---|
| Authorization | Basic base64(username:password) |
GET https://api.bsms.viamobile.sk/get/send?id=1&msisdn=421903123456&text=testsms HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
JSON Web Token (JWT) Autorizácia
Vyžiadanie JWT platného 24 hodín.
Pozri aj jwt.io
Pozri aj jwt.io
GET https://api.bsms.viamobile.sk/token/create?username=test&password=test HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Host: api.bsms.viamobile.sk
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
| /response/status | Povinný | Int32 | HTTP status (200 ok, 4xx chyba) |
| /response/jwt | Povinný | String | JSON Web Token |
{
"response":
{
"status": 200,
"jwt" : "xxx.yyy.zzz"
}
}
Error kódy
| Kód | 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 |
type |
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 |
id |
Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
msisdn |
Povinný | Int64 | Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456 |
text |
Povinný | String(480) | Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding) |
jwt |
Nepovinný | String | JSON Web Token |
GET https://api.bsms.viamobile.sk/get/send?id=123&msisdn=421903123456&text=testsms HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
GET https://api.bsms.viamobile.sk/get/send?id=123&msisdn=421903123456&text=testsms&jwt=xxx.yyy.zzz HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Host: api.bsms.viamobile.sk
Response
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
| /response/status | Povinný | Int32 | HTTP status (200 ok, 4xx chyba) |
| /response/recipients/id | Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
| /response/recipients/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á |
| /response/recipients/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. |
| /response/recipients/parts | Povinný | Int32 | Počet SMS v správe pre multipart SMS. |
| /response/recipients/duplicate | Nepovinný | Boolean | Duplicitná správa |
jwt |
Nepovinný | String | JSON Web Token |
{
"response":
{
"status": 200,
"recipients": [
{"id":"123","status":"ok", "parts":1, "price": 0.03}
]
}
}
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 |
id |
Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
msisdn |
Povinný | Int64 | Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456 |
text |
Povinný | String(480) | Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding) |
jwt |
Nepovinný | String | JSON Web Token |
GET https://api.bsms.viamobile.sk/get/send?id=123&msisdn=421903123456&text=testsms%20%C4%BE%C5%A1%C4%8D%C5%A5%C5%BE%C3%BD%C3%A1%C3%AD%C3%A9 HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Authorization: Basic dGVzdDp0ZXN0
Host: api.bsms.viamobile.sk
GET https://api.bsms.viamobile.sk/get/send?id=123&msisdn=421903123456&text=testsms%20%C4%BE%C5%A1%C4%8D%C5%A5%C5%BE%C3%BD%C3%A1%C3%AD%C3%A9&jwt=xxx.yyy.zzz HTTP/1.1
Content-Type: text/xml;charset=UTF-8
Host: api.bsms.viamobile.sk
Odoslanie Unicode SMS - response
| Parameter | Povinný | Typ | Popis |
|---|---|---|---|
| /response/status | Povinný | Int32 | HTTP status (200 ok, 4xx chyba) |
| /response/recipients/id | Povinný | Int64 | Unikátne ID odoslanej správy zo systému klienta |
| /response/recipients/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á |
| /response/recipients/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. |
| /response/recipients/parts | Nepovinný | Int32 | Počet SMS v správe pre multipart SMS. |
| /response/recipients/duplicate | Nepovinný | Boolean | Duplicitná správa |
{
"response":
{
"status": 200,
"recipients": [
{"id":"123","status":"ok", "parts":1, "price": 0.03},
]
}
}