2.3 Funkcia send_message

Funkcia slúži na odoslanie sms správy. Príkaz:

https://api.smsgate.sk/xml/send_message?data=<XML>

XML s použitím tokenu:

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <token>XXXXXXXXXX</token>
    <to>XXXXXXXXXX</to>
    <text>XXXXXXXXXX</xxxx>
</request>

XML s použitím session ID:

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <session_id>XXXXXXXXXX</session_id>
    <to>XXXXXXXXXX</to>
    <text>XXXXXXXXXX</xxxx>
</request>

Parameter	Typ	Popis
token || session_id	string	API token alebo session_id vrátené pomocou metódy auth. (Povinné)
to	string	Číslo adresáta správy, Max. podpora 100 MSISDN oddelených čiarkou pre SMS s viacerými príjemcami. (Povinné)
text	string	Text SMS správy s podporou diakritiky (Povinné)
from	string	Čí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.
callback	bool	true – 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_time	string [timestamp]	Oneskorenie s ktorým má byť SMS správa odoslaná. Tvar timestamp, ale oddelený čiarkou (napr: 2014-09-09,10:45:00)
concat	integer	Hodnota 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)
priority	integer	Priorita zasielania SMS. Možné hodnoty parametra 1 (Nízka), 2 (Štandardná), 3 (Vysoká). (Predvolená hodnota – 2 (Štandardná))
validity	integer	Č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)
unicode	bool|integer	false – 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
type	string	standard – špecifikuje formát posielaného textu (Predvolená hodnota) flash – špecifikuje SMS ktorá sa zobrazí okamžite po prijatí telefónom
groupId	integer	Id kadenčnej skupiny, prostredníctvom ktorej bude SMS správa odoslaná

Odpoveď

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

<?xml version="1.0" encoding="UTF-8" ?>
<response>  
    <result>
        <status>success</status>
        <description></description>
        <code>OK</code>
    </result>
    <messages count="1">
        <message id="100427">
            <status>success</status>
            <code>OK</code>
            <description></description>
        </message>
    </messages>
</response>
                                

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

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
        <status>error</status>
        <description>Relácia nebola nájdená alebo expirovala</description>
        <code>SESSION_NOT_FOUND</code
    </result>
</response>
                                

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

<?xml version="1.0" encoding="UTF-8" ?>
<response>  
    <result>
        <status>success</status>
        <description></description>
        <code>OK</code>
    </result>
    <messages count="2">
        <message id="100427">
            <status>success</status>
            <code>OK</code>
            <description></description>
        </message>
        <message id="100428">
            <status>error</status>
            <code>SYSTEM_ERROR</code>
            <description>Vyskytla sa systémová chyba. Kontaktuje administrátora</description>
        </message>
    </messages>
</response>