smsSendJSON
Popis
Odoslanie SMS pomocou metódy POST.
Funkčnosť
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.
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 http://text421.naimar.sk/api/v6/rest/sms/json/
1.1 MSISDN má uvedené ID správy
{
"username": "test",
"password": "test",
"message":
{
"text": "Test SMS",
"sender": "Info",
"delivery": "2012-11-05 16:01:22"
},
"recipients":
[
{"msisdn": 421901727051, "id": "12345678901234"},
{"msisdn": 421905537914, "id": "abcdefghijklab"}
]
}
1.2 MSISDN nemá uvedené ID správy
{
"username": "test",
"password": "test",
"message":
{
"text": "Test SMS",
"sender": "Info",
"delivery": "2012-11-05 16:01:22"
},
"recipients":
{"msisdn":
[
"421901727051",
"421905537914"
]
}
}
1.3 SMS s diakritikou
{
"username": "test",
"password": "test",
"message":
{
"text": "Příliš žluťoučký kůň pěl ďábelské ódy. Mäso v tôni.",
"type": "utf8"
},
"recipients":
[
{"msisdn": 421901727051, "id": "12345678901234"}
]
}
1.4 Správa s textom uvedeným pri MSISDN
{
"username": "test",
"password": "test",
"message":
{
"text": "Test SMS",
"sender": "Info",
"delivery": "2012-11-05 16:01:22"
},
"recipients":
[
{"msisdn": 421901727051, "id": "456123", "text": "Custom text for SMS ID 456123"},
{"msisdn": 421905537914, "id": "abcdefghijklab"}
]
}
| Parameter | Required | Type | Description |
|---|---|---|---|
username |
required | Varchar (16) | prihlasovacie meno užívateľa |
password |
required | Varchar (16) | heslo užívateľa |
| Message | |||
text |
required | text | Text SMS správy. Štandardná textová správa - 160 znakov, binárna správa - 280 znakov, správa s diakritikou - 70 znakov. |
type |
optional | binary, utf8 | binary - binárna správa, utf8 - správa s diakritikou |
dcs |
optional | integer | ak nie je DCS uvedené a správa je binárna, použije sa štandardné DCS 245 |
esm |
optional | integer | ak nie je ESM uvedené a správa je binárna, použije sa štandardné ESM 64 |
sender |
optional | varchar(11) | z akého mena bude doručená SMS, max. 11 aflanumerických alebo 15 numerických znakov Povolené znaky: a-zA-Z0-9/+!_*&%@$.# |
delivery |
optional | timestamp | nepovinný parameter, čas kedy najskôr sa SMS odošle (napríklad: 2012-11-05 16:01:22) |
| Recipients | |||
msisdn |
required | integer | čislo na ktoré sa má odoslať SMS |
id |
optional | varchar (14) | unikátne ID zaslanej SMS |
text |
optional | text | unikátny text pre MSISDN |
Response
{
"response":
{
"status": 200,
"recipients": 2
}
}
| Parameter | Typ | Popis |
|---|---|---|
| status | integer | response serveru (200 ak API prijalo správu, 4xx v prípade chyby) |
| description | varchar (300) | bližší popis chyby |
| recipients | integer | počet prijatých MSISDN |
Error response
{
"response":
{
"status": 400,
"description": "missing parameter",
"recipients": 0,
"recipients_error": 0
}
}
Chybové návratové hodnoty
| ID chyby | Description | Vysvetlenie |
|---|---|---|
| 400 | unknown prefix xxx | neznámy prefix, použite mobilné prefixy mobilných operátorov |
| 400 | unknwon network xxx | nemáte povolenie na odoslanie SMS do uvedenej siete |
| 400 | missing parameter text | chýba povinný parameter text |
| 400 | missing parameter recipients | nie je uvedený žiadny príjemca |
| 400 | sender must have 11 characters or less | sender môže mať maximálne 11 znakov |
| 400 | unknown sender | sender môže byť len z definovaného rozsahu |
| 400 | unknown type | type môže byť len binary alebo utf8 |
| 401 | unknown username/password | nesprávne meno alebo heslo |
| 500 | unknown error | neznáma chyba, bližší popis je zaslaný v response |
Revízia
| Verzia | Dátum | Popis |
|---|---|---|
| 3.0 | 14.8.2013 | obmedzenie na známe prefixy operátorov, obmedzenie na odosielanie do sietí mimo SR |
| 2.0 | 9.1.2013 | doplnená možnosť zaslať unikátny text pri každom MSISDN |
| 1.5 | 30.10.2012 | opravená drobná chyba v implementácii XML, zmena XML formátovania pri Error response |
| 1.4 | 24.9.2012 | zmena parametru v GET volani, miesto message=Text spravy sa pouziva text=Text spravy |
| 1.3 | 13.9.2012 | sender môže byť len z definovaného rozsahu |
| 1.2 | 10.9.2012 | doplnená možnosť zaslania správ s diakritikou a binárnych správ |
| 1.1 | 9.9.2012 | doplnená možnosť zaslania správ s textovým senderom |
| 1.0 | 24.8.2012 | prvá verzia |