HTTP API - akcia 'sendmessage'

Tento príkaz HTTP API možno použiť na odoslanie SMS správy cez SMS bránu. Príkaz možno použiť na odoslanie textových SMS správ alebo iných typov správ, ako sú binárne SMS správy, logá operátorov, zvonenia, WAP PUSH atď... Pri použití tohto príkazu musíte použiť HTTP API užívateľské meno a heslo, musíte zadať telefónne číslo príjemcu a text správy.

Popis

Na odoslanie SMS použite nasledujúci formát URL:

https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD


127.0.0.1 je lokálna IP adresa, preto ju nahraďte IP adresou alebo názvom hostiteľa počítača s nainštalovanou Ozeki SMS bránou. (Poznámka: 127.0.0.1 je lokálna loopback adresa, ktorú možno použiť, keď sa pripájate k SMS bráne z toho istého počítača.) 9508 je predvolený port HTTP API Ozeki SMS brány. Toto číslo portu je možné zobraziť a upraviť v používateľskom rozhraní Ozeki 10 SMS brány, kliknutím na tlačidlo Pokročilé na paneli nástrojov.

"UUUUU" a "PPPPP" by mali byť nahradené používateľským menom a heslom užívateľa, ktorého ste vytvorili v SMS bráne.

Nahraďte "NNNNN" telefónnym číslom, na ktoré chcete odoslať SMS správu. Môžete použiť miestny formát telefónneho čísla, ako aj medzinárodný formát telefónnych čísel (telefónne čísla formátované podľa medzinárodného formátu vždy začínajú znakom '+'). Ak sa používa medzinárodný formát telefónneho čísla, uvážte, že znak '+' musíte nahradiť reťazcom '%2B' kvôli pravidlám kódovania URL.

Nahraďte "MMMMM" typom správy. Pre textové správy by sa mal použiť typ správy "SMS:TEXT".

Údaje správy obsahujú správu, ktorú chcete odoslať. Umiestnite údaje správy namiesto "DDDDD". Údaje správy by mali byť písané pomocou UTF-8 znakov a mali by byť URL kódované.

K požiadavke je možné pridať aj ďalšie parametre.
Pre úplný zoznam dostupných parametrov si pozrite tabuľku 'Parametre požiadavky' nižšie:

Príklad URL požiadavky

https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World

Príklad odpovede
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 246

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml">
<response>
   <action>sendmessage</action>
   <data>
      <acceptreport>
         <statuscode>0</statuscode>
         <statusmessage>Správa prijatá na odoslanie</statusmessage>
         <messageid>ERFAV23D</messageid>
         <recipient>06203105366</recipient>
      </acceptreport>
   </data>
</response>

Parametre HTTP požiadavky

Parameter Popis Možné hodnoty Príklad M/O*
action Určuje príkaz HTTP API sendmessage action=sendmessage M
username Určuje používateľské meno. Parametre username a password sa používajú na autentifikáciu používateľa. Pri odosielaní správy bude správa odoslaná v mene autentifikovaného používateľa. Hodnota musí byť url-encoded. reťazcová hodnota, maximálna dĺžka je 16 znakov username=admin M
password Určuje heslo. Parametre username a password sa používajú na autentifikáciu používateľa. Pri odosielaní správy bude správa odoslaná v mene autentifikovaného používateľa. Hodnota musí byť url-encoded. reťazcová hodnota, maximálna dĺžka je 16 znakov password=abc123 M
originator Určuje adresu odosielateľa. Táto informácia sa zobrazí na mobilnom telefóne, ktorý prijme správu. Toto je adresa odosielateľa. Môže to byť telefónne číslo, krátky kód alebo alfanumerická adresa odosielateľa. Telefónne číslo môže byť formátované v lokálnom formáte (napr.06201234567) alebo v medzinárodnom formáte (napr.+36201234567). Ak používate alfanumerickú adresu odosielateľa (napr.ozeki), znaky musia byť zakódované v UTF8 a hodnota musí byť url-encoded. reťazcová hodnota, maximálna dĺžka je 16 znakov originator=%2B36201112222 O
recipient Určuje telefónne číslo príjemcu. Správa bude odoslaná na toto telefónne číslo. Telefónne číslo môže byť špecifikované v lokálnom formáte (napr.06201234567), alebo v medzinárodnom formáte (napr.+36201234567).
Viacero adries príjemcov môže byť oddelených dvojbodkou (napr.: +36201234567,+36202222222) alebo bodkočiarkou.
Hodnota musí byť url-encoded.
reťazcová hodnota, maximálna dĺžka je 16 znakov recipient=%2B36201234567 M
messagetype Určuje typ správy. Typ dát SMS správy podľa Mobile Message Type Specification. Pre textové správy budú dáta správy čistý text, pre iné typy správ to bude XML dokument.
SMS:TEXT
SMS:WAPPUSH
...
Možné hodnoty nájdete v Mobil Message Type Specification
messagetype=SMS:TEXT O
messagedata Určuje text alebo dáta SMS správy. Hodnota musí byť zakódovaná v UTF8 a musí byť url-encoded. reťazcová hodnota, maximálna dĺžka je 32768 znakov messagedata=Hello+World M
_charset_ Určuje znakovú sadu zakódovaných dát (ak nie je špecifikovaná, predpokladá sa utf-8). Novšie prehliadače by mali nastaviť hodnotu _charset_ automaticky. Ak váš prehliadač túto funkciu nepodporuje, môžete ju nastaviť manuálne na:
utf-8
windows-1250
iso-8859-1
iso-8859-2
...
(Podporované hodnoty znakových sád)
_charset_=iso-8859-2 O
serviceprovider Určuje názov GSM Modemu alebo IP SMS poskytovateľa spojenia, ktoré sa má použiť na odoslanie správy. Viac informácií o výbere spojenia poskytovateľa služieb je k dispozícii v HTTP SMS API - SMS routing guide.

Hodnota sa musí zhodovať s reťazcom špecifikovaným v konfiguračnom formulári spojenia poskytovateľa služieb.
reťazcová hodnota, maximálna dĺžka je 16 znakov serviceprovider=Vodafone O
sendondate Určuje dátum a čas, kedy má byť správa odoslaná.

Hodnota musí používať nasledujúci formát dátumu: YYYY-MM-DD hh:mm:ss. Hodnota musí byť url-encoded
dátumová hodnota vo formáte YYYY-MM-DD hh:mm:ss sendondate=2018-12-12+10%3A07%3A05 O
responseformat Po odoslaní SMS správy bránou, brána vráti webovú stránku oznamujúcu, že správa bola úspešne odoslaná. Obsah webovej stránky je formátovaný podľa parametra responseformat. Môžete mať html textovú odpoveď, aby bola ľahko čitateľná pre ľudí, alebo môžete mať xml formát, aby bolo ľahké spracovať odpoveď softvérom. xml (predvolené)
html
urlencoded
responseformat=xml O
continueurl Po odoslaní SMS správy bránou, brána vráti webovú stránku oznamujúcu, že správa bola úspešne odoslaná. Obsah webovej stránky je formátovaný podľa parametra responseformat. Ak je parameter responseformat nastavený na html, webová stránka môže obsahovať odkaz "Pokračovať". Ak zadáte URL v tomto parametri, zobrazí sa odkaz na pokračovanie a bude odkazovať na zadanú URL. Hodnota URL musí byť url-encoded.

URL, ktoré zadáte, môže obsahovať kľúčové slová, ktoré budú nahradené informáciami o stave zodpovedajúcimi odoslanej správe. Viac informácií o možných kľúčových slovách nájdete v "Submit URL keywords" guide.
reťazcová hodnota, maximálna dĺžka je 1024 znakov continueurl=192.168.1.23

alebo

continueurl=http%3A%2F%2Fwww.ozekisms.
com%2Findex.php%3Fowpn%3D159

Poznámka: druhý príklad obsahuje urlencoded URL.
O
redirecturl Po odoslaní SMS správy bránou, predvolene brána vráti webovú stránku oznamujúcu, že správa bola úspešne odoslaná. Voliteľne môžete požiadať bránu, aby automaticky presmerovala prehliadač na URL, ktoré zadáte. Ak zadáte URL v parametri redirect, HTTP odpoveď vrátená SMS bránou bude obsahovať presmerovaciu URL v HTTP hlavičke. Toto inštruuje webový prehliadač, aby nasledoval odkaz, ktorý ste zadali. Hodnota URL musí byť url-encoded.

URL, ktoré zadáte, môže obsahovať kľúčové slová, ktoré budú nahradené informáciami o stave zodpovedajúcimi odoslanej správe. Viac informácií o možných kľúčových slovách nájdete v "Submit URL keywords" guide.
reťazcová hodnota, maximálna dĺžka je 1024 znakov redirecturl=192.168.1.23

alebo

redirecturl=http%3A%2F%2F192.168.1.23
%2Findex.php%3Fowpn%3D159

Poznámka: druhý príklad obsahuje urlencoded URL.
O
reporturl Môžete nastaviť webovú stránku na spracovanie informácií o udalostiach "doručené do siete" a "doručené do telefónu". Ak zadáte URL v parametri reporturl, vaša webová stránka bude volaná, keď sa tieto udalosti vyskytnú. Hodnota URL, ktorú zadáte v parametri reporturl, musí byť URL encoded.

URL, ktoré zadáte, môže obsahovať kľúčové slová, ktoré budú nahradené informáciami o stave zodpovedajúcimi odoslanej správe.

Dobrý príklad, ako použiť možnosť report URL, nájdete v how to send a scheduled sms and use the reporturl functionality guide.
reťazcová hodnota, maximálna dĺžka je 1024 znakov reporturl=http%3A%2F%2Fwww.ozekisms.
com%2Fproc.php%3Freporttype%3D%24reporttype
%26messageid%3D%24messageid

Poznámka: toto je urlencoded verzia nasledujúcej URL. Predtým, ako túto URL zavolá SMS brána, parametre $reporttype a $messageid budú nahradené príslušnými hodnotami:

http://192.168.1.23/proc.php?reporttype=$reporttype&
messageid=$messageid

bude volané ako:
http://192.168.1.23/proc.php?reporttype=deliveredtonetwork& messageid=ERFAV23D

Zoznam kľúčových slov, ktoré môžete použiť v reporturl:
$reporttype
$messageid
$statuscode
$statusmessage
$fromstation
$fromconnection
$fromaddress
$tostation
$toconnection
$toaddress
$text
$createdate
$submitdate
$receiveddate
O
messagecount Určuje presný počet správ, ktoré chcete odoslať. Ak je nastavený, je potrebné indexovanie pre parametre 'recipient', 'messagetype' a 'messagedata'. Podrobný 'messagecount' tutorial nájdete tu. číslo
(predvolená hodnota:
1)
messagecount=6 O
maxresponse Toto číslo určuje maximum správ, o ktorých dostanete spätnú väzbu. Ak prekročíte toto číslo, vaše správy budú odoslané, ale nedostanete o nich spätnú väzbu. Predvolene je tento parameter nastavený na 500 správ. číslo maxresponse=1000 O
vp Určuje validity period pre vašu správu.

Hodnota musí používať nasledujúci formát dátumu: YYYY.MM.DD hh:mm:ss. Hodnota musí byť url-encoded.
Pre viac informácií si prečítajte tento tutoriál.
dátumová hodnota vo formáte YYYY.MM.DD hh:mm:ss vp=2019.01.28.+10%3A07%3A05 O

* M = Povinný parameter, O = Voliteľný parameter

Parametre odpovede
(formát xml odpovede)

Parameter Popis Možné hodnoty Príklad
acceptreport Obsahuje odpoveď na žiadosť o odoslanie pre jednu príjemcovskú adresu. Ak bolo zadaných viac príjemcov, v odpovedi bude pre každého príjemcu zahrnutý acceptreport. Poradie acceptreportov bude zodpovedať poradiu príjemcovských adries.  
<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Správa prijatá
   na doručenie</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>
acceptreport.statuscode Obsahuje celočíselnú hodnotu na indikáciu úspechu alebo zlyhania. Ak je hodnota 0, znamená to, že správa bola prijatá na doručenie. Ak je hodnota väčšia ako 0, znamená to chybu, správa nebola prijatá na doručenie. Celočíselná hodnota, väčšia alebo rovná 0. Menšia ako 32768. <statuscode>0</statuscode>
acceptreport.statusmessage Obsahuje textovú reprezentáciu stavového kódu. Ak bola správa prijatá, hodnota bude "Správa prijatá na doručenie". Ak správa nebola prijatá na doručenie, v tomto poli nájdete chybovú správu. reťazcová hodnota, maximálna dĺžka je 1024 znakov <statusmessage>Správa prijatá na doručenie</statusmessage>
acceptreport.messageid Obsahuje referenciu správy, ktorá môže byť použitá na sledovanie správy v SMS bráne. Táto referencia správy sa tiež používa na identifikáciu správ doručených do siete a doručených do ruky alebo na vyhľadanie informácií o správe. reťazcová hodnota, maximálna dĺžka je 16 znakov <messageid>ERFAV23D</messageid>
acceptreport.recipient Obsahuje adresu príjemcu. reťazcová hodnota, maximálna dĺžka je 16 znakov <recipient>06203105366</recipient>
Zhrnutie

Tento článok bol o HTTP API akcii ‘sendmessage’. S touto akciou môžete odosielať textové SMS správy a mnoho ďalších typov správ akýmkoľvek príjemcom cez Ozeki SMS bránu. Videli ste príklady odpovedí a niekoľko ďalších HTTP požiadaviek s popisom, možnými hodnotami a príkladmi.

Ak by ste sa chceli dozvedieť viac o stave doručenia vašich správ, neváhajte kliknúť na stránku o stavoch doručenia SMS. Ak by ste chceli získať URL šablónu, navštívte príslušnú stránku.

Ak by ste chceli použiť toto riešenie v reálnych situáciách, stiahnite si Ozeki SMS bránu a začnite ju používať ešte dnes!

More information