1. Home
  2. Docs
  3. SMS API popis
  4. 1. JSON
  5. 1.3 Funkcia send_message

1.3 Funkcia send_message

Funkcia slúži na odoslanie sms správy. Príkaz s použitím tokenu:

https://api.smsgate.sk/json/send_message?token=XXXXXXXXXXX&to=XXXXXXXXXX&text=xxxx

Príkaz s použitím session:

https://api.smsgate.sk/json/send_message?session_id=XXXXXXXXXXXXXX&to=XXXXXXXXXX&text=xxxx
ParameterTypPopis
token || session_idstringAPI token alebo session_id vrátené pomocou metódy auth. (Povinné)
tostringČíslo adresáta správy, Max. podpora 100 MSISDN oddelených čiarkou pre SMS s viacerými príjemcami. (Povinné)
textstringText SMS správy s podporou diakritiky (Povinné)
fromstringČíslo odosielateľa SMS správy. Ak nebude definovaný, správa sa odošle z čísla, ktoré je priradené k účtu.
Použitie špeciálnych parametrov: {{random}} – odošle správu s náhodným číslom odosielateľa zo zoznamu povolených textových identifikátorov
{{unique}} – odošle správu s unikátnym číslom odosielateľa zo zoznamu povolených textových identifikátorov. V prípade, že na dané číslo boli už odoslané správy zo všetkých textových identifikátorov, začína sa proces od začiatku nastavením čísla odosielateľa, z ktorého bola odoslaná najstaršia správa.
callbackbooltrue – bude volať v používateľských nastaveniach definovanú url pre callback na poslanie delivery statusu SMS správy cez rozhranie, prostredníctvom ktorého bola správa odoslaná – (Predvolená hodnota)
false – nebude volať v používateľských nastaveniach definovanú url pre callback

Akákoľvek zadaná hodnota okrem false, 0, „0“ alebo „“ bude považovaná za true
delivery_timestring [timestamp]Oneskorenie s ktorým má byť SMS správa odoslaná. Tvar timestamp, ale oddelený čiarkou (napr: 2014-09-09,10:45:00)
concatintegerHodnota parametra 1,2,3. Umožní rozdeliť text SMS na zadaný počet SMS v prípade že text je dlhší ako je možné štandardne poslať. (Predvolená hodnota – 1)
priorityintegerPriorita zasielania SMS. Možné hodnoty parametra 1 (Nízka), 2 (Štandardná), 3 (Vysoká). (Predvolená hodnota – 2 (Štandardná))
validityintegerČas platnosti SMS. Ak SMS nebude odoslaná do SMSC do tohto časového limitu bude z queue vymazaná. Hodnota je uvádzaná v minútach. Možné hodnoty 1-1440.(Predvolená hodnota – 1440 minút)
unicodebool|integerfalse – pošle ako štandardnú správu GSM 7bit. Ak správa obsahuje diakritiku, tá bude z textu odstránená. V prípade, že text správy obashuje znaky, ktoré nie je možné prekonvertovať do znakovej sady GSM 7bit, odošle sa správa ako UNICODE.
true – pošle ako unicode[UTF-16]

V prípade, že tento parameter nie je definovaný, aplikácia odošle správu na základe automatickej detekcie kódovania.

Akákoľvek zadaná hodnota okrem false, 0, „0“ alebo „“ bude považovaná za true
typestringstandard – špecifikuje formát posielaného textu (Predvolená hodnota)
flash – špecifikuje SMS ktorá sa zobrazí okamžite po prijatí telefónom
groupIdintegerId kadenčnej skupiny, prostredníctvom ktorej bude SMS správa odoslaná

Odpoveď

V prípade, že správa bola odoslaná úspešne:

{
    "result": {
        "status": "success",
        "description": "",
        "code": "OK"
    },
    "message_count": 1,
    "messages": [{
            "status": "success",
            "code": "OK",
            "description": "",
            "message_id": 100427
        }]
}

V prípade chyby (príklad s konkrétnou chybou):

{
    "result": {
        "status": "error",
        "description": "Relácia nebola nájdená alebo expirovala",
        "code": "SESSION_NOT_FOUND"
    }
}

V prípade, že požiadavka bola prijatá úspešne, ale niektorú správu nebolo možné odoslať (príklad s konkrétnou chybou):

{
    "result": {
        "status": "success",
        "description": "",
        "code": "OK"
    },
    "message_count": 2,
    "messages": [{
            "status": "success",
            "code": "OK",
            "description": "",
            "message_id": 100427
        },
        {
            "status": "error",
            "code": "SYSTEM_ERROR",
            "description": "Vyskytla sa systémová chyba. Kontaktuje administrátora",
            "message_id": ''
        }]
}
}