Send SMS JSON

Popis
Odoslanie SMS pomocou metódy POST.
Použitie
Všetky requesty sa zasielajú na URL uvedené nižšie. Formát tela správy je nutné dodržať pre úspešné odoslanie správy.
V prípade úspešného odoslania je vrátený HTTP response 200 a v body je uvedená odpoveď. V prípade chyby je vrátený chybový HTTP response s uvedením chyby.
Request
POST https://api.bsms.viamobile.sk/json/send - Odoslanie SMS
POST https://api.bsms.viamobile.sk/json/validate - Simulácia odoslania SMS / validácia
1.1 Správy bez diakritiky so spoločným textom

Request

Parameter Povinný Typ Popis
/username
Povinný String(32) Prihlasovacie meno
/password
Povinný String(32) Heslo
/message/text
Povinný String(480) Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding)
/message/sender
Povinný String(11) Odosielateľ správy, maximálne 11 znakov, nesmie byť iba číslo.
Default: InfoSMS
/message/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
/message/time_to_send
Nepovinný ISO datetime ISO timestamp vo formáte YYYY-MM-DD HH:mm:ss, napr. 2019-01-01T21:00:00
Default: Aktuálny dátum a čas
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
/recipients/id
Nepovinný Int64 Unikátne ID odoslanej správy zo systému klienta
{ "username": "test", "password": "test", "message": { "text": "Text sms", "sender": "InfoSMS", "type": "gsm", "time_to_send": "2019-01-01 21:00:00" }, "recipients": [ {"msisdn": 421903123456}, {"msisdn": 421903123457, "id": 124}, {"msisdn": 421903123458, "id": 125}, {"msisdn": 421903123459, "id": 126}, ] }

Response

Parameter Povinný Typ Popis
/response/status Povinný Int32 HTTP status (200 ok, 4xx chyba)
/response/recipients/id Nepovinný 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
/response/recipients/bsmsId Povinný Int64 Unikátne ID správy v systéme BSMS
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
{ "response": { "status": 200, "recipients": [ {"id":null,"status":"ok", "parts":1, "price": 0.03, "msisdn": 421903123456, "bsmsId": 9991}, {"id":"124","status":"blacklist", "msisdn": 421903123457, "bsmsId": 9992}, {"id":"125","status":"ok", "parts":1, "price": 0.03, "duplicate":true, "msisdn": 421903123458, "bsmsId": 9993}, {"id":"126","status":"network_disabled", "msisdn": 421903123459, "bsmsId": 9994} ] } }
1.2 Správy s diakritikou so spoločným textom

Request

Parameter Povinný Typ Popis
/username
Povinný String(32) Prihlasovacie meno
/password
Povinný String(32) Heslo
/message/text
Povinný String(480) Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding)
/message/sender
Povinný String(11) Odosielateľ správy, maximálne 11 znakov, nesmie byť iba číslo.
Default: InfoSMS
/message/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
/message/time_to_send
Nepovinný ISO datetime ISO timestamp vo formáte YYYY-MM-DD HH:mm:ss, napr. 2019-01-01T21:00:00
Default: Aktuálny dátum a čas
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
/recipients/id
Nepovinný Int64 Unikátne ID odoslanej správy zo systému klienta
{ "username": "test", "password": "test", "message": { "text": "Text sms - ľščťžýáíé", "sender": "InfoSMS", "type": "utf8", "time_to_send": "2019-01-01 21:00:00" }, "recipients": [ {"msisdn": 421903123456}, {"msisdn": 421903123457, "id": 124}, {"msisdn": 421903123458, "id": 125}, {"msisdn": 421903123459, "id": 126} ] }

Response

Parameter Povinný Typ Popis
/response/status Povinný Int32 HTTP status (200 ok, 4xx chyba)
/response/recipients/id Nepovinný 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
/response/recipients/bsmsId Povinný Int64 Unikátne ID správy v systéme BSMS
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
{ "response": { "status": 200, "recipients": [ {"id":null,"status":"ok", "parts":1, "price": 0.03, "msisdn": 421903123456, "bsmsId": 9991}, {"id":"124","status":"blacklist", "msisdn": 421903123457, "bsmsId": 9992}, {"id":"125","status":"ok", "parts":1, "price": 0.03, "duplicate":true, "msisdn": 421903123458, "bsmsId": 9993}, {"id":"126","status":"network_disabled", "msisdn": 421903123459, "bsmsId": 9994} ] } }
1.3 Správy s rozličným textom

Request

Parameter Povinný Typ Popis
/username
Povinný String(32) Prihlasovacie meno
/password
Povinný String(32) Heslo
/message/text
Povinný String(480) Text správy. Kódovanie ASCII/UTF8 (podľa type/encoding)
/message/sender
Povinný String(11) Odosielateľ správy, maximálne 11 znakov, nesmie byť iba číslo.
Default: InfoSMS
/message/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
/message/time_to_send
Nepovinný ISO datetime ISO timestamp vo formáte YYYY-MM-DD HH:mm:ss, napr. 2019-01-01T21:00:00
Default: Aktuálny dátum a čas
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
/recipients/id
Nepovinný Int64 Unikátne ID odoslanej správy zo systému klienta
{ "username": "test", "password": "test", "message": { "text": "Text sms", "sender": "InfoSMS", "type": "gsm", "time_to_send": "2019-01-01 21:00:00" }, "recipients": [ {"msisdn": 421903123456, "text": "Custom text for SMS"}, {"msisdn": 421904123457, "id": 124}, {"msisdn": 421904123458, "id": 125}, {"msisdn": 421904123459, "id": 126}, ] }

Response

Parameter Povinný Typ Popis
/response/status Povinný Int32 HTTP status (200 ok, 4xx chyba)
/response/recipients/id Nepovinný 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
/response/recipients/bsmsId Povinný Int64 Unikátne ID správy v systéme BSMS
/recipients/msisdn
Povinný Int64 Číslo v medzinárodnom formáte bez + a 00 na začiatku. Napr. 421903123456
{ "response": { "status": 200, "recipients": [ {"id":null,"status":"ok", "parts":1, "price": 0.03, "msisdn": 421903123456, "bsmsId": 9991}, {"id":"124","status":"blacklist", "msisdn": 421903123457, "bsmsId": 9991}, {"id":"125","status":"ok", "parts":1, "price": 0.03, "duplicate":true, "msisdn": 421903123458, "bsmsId": 9991}, {"id":"126","status":"network_disabled", "msisdn": 421903123459, "bsmsId": 9991} ] } }
2. Chybové návratové hodnoty

Chybové návratové hodnoty

HTTP kód Kód Popis Vysvetlenie
401 1000 Unauthorized Nesprávne meno alebo heslo
400 1010 Unknown prefix Neznámy prefix, použite mobilné prefixy mobilných operátorov
400 1011 Unknown network Nemáte povolenie na odoslanie SMS do uvedenej siete
400 1012 Unknown sender Sender môže byť len z rozsahu definovaného spoločnosťou Viamobile
400 1013 Message too long Správa je dlhšia ako povolený limit
400 1014 ID not integer ID správy nie je numerické
400 2001 Sms sending disabled Posielanie SMS nie je povolené. Prosím, kontaktuje Viamobile
400 2002 Not enough credit Nedostatok kreditu
500 Unknown error neznáma chyba, request je potrebné zopakovať/kontaktovať Viamobile
{ "response": { "status": 401, "code": 1000, "description": "Unauthorized" } }