delivery SMS JSON - PULL
Popis
Zistenie stavu doručenia SMS.
Funkčnosť
Všetky requesty sa zasielajú na URL uvedené nižšie. Formát tela správy je nutné dodržať pre úspešné zistenie delivery reportu.
V body sa vracia informácia o doručení. V prípade chyby je vrátený chybový HTTP response s popisom chyby.
V body sa vracia informácia o doručení. V prípade chyby je vrátený chybový HTTP response s popisom chyby.
Request
POST https://api.bsms.viamobile.sk/json/delivery
Request body
{
"username": "test",
"password": "test",
"deliveries":
[
{"id": 123},
{"id": 124},
{"bsmsId": 9993}
]
}
Parameter | Required | Type | Description |
---|---|---|---|
username |
Povinný | String(32) | Prihlasovacie meno |
password |
Povinný | String(32) | Heslo |
id |
Nepovinný | int64 | Unikátne ID zaslanej SMS zo systému klienta. Jeden z parametrov "id" alebo "bsmsId" je povinný. |
bsmsId |
Nepovinný | int64 | Unikátne ID SMS v systéme BSMS. Jeden z parametrov "id" alebo "bsmsId" je povinný. |
Response
{
"response":
{
"status": 200,
"delivery":
[
{
"id": 123,
"received": "2014-02-01 22:59:00",
"status": "delivered",
"operator": 23101,
"price": 0.03,
"parts": 1,
"bsmsId": 9991
},
{
"id": 124,
"received": "2014-02-01 22:59:00",
"status": "undeliverable",
"operator": 0,
"price": null,
"parts": 1,
"bsmsId": 9992
},
{
"id": null,
"received": "2014-02-01 22:59:00",
"status": "waiting",
"operator": 23102,
"price": 0.06,
"parts": 2,
"bsmsId": 9993
}
]
}
}
Parameter | Typ | Popis |
---|---|---|
id |
int64 | Unikátne ID zaslanej SMS zo systému klienta |
received | timestamp | Dátum prijatia delivery reportu od operátora alebo v prípade waiting dátum poslednej kontroly |
status | string(50) | delivered - správa doručená, undeliverable - správa nedoručená, waiting - neznámy stav, expired - správa bol nedoručená |
operator | int32 | Kód operátora - 23101 Orange SK, 23102 Telekom SK, 23103 4rka SK, 23106 O2 SK, 23000 CZ, 0 ostatne |
price | 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. |
parts | int32 | Počet SMS v správe pre multipart SMS. |
bsmsId |
int64 | Unikátne ID SMS zo systému BSMS |
Error response
{
"response":
{
"status": 401,
"code": 1000,
"description": "Unauthorized"
}
}
Chybové návratové hodnoty
HTTP kód | Kód | Popis | Vysvetlenie |
---|---|---|---|
401 | 1000 | Unknown username/password | Nesprávne meno alebo heslo |
500 | Unknown error | Neznáma chyba, request je potrebné zopakovať/kontaktovať Viamobile |