HTTP API - URL sablon
Ez az útmutató útmutatást ad arról, hogyan készítsünk egy URL sablont, amelyet a redirecturl, a continueurl és a reporturl paraméterekben használhatunk a HTTP API sendmessage metódusában.
Bevezetés
Ha a redirecturl vagy a continueurl paraméterek szerepelnek a sendmessage HTTP kérésben, az SMS szerver egy választ küld vissza, amely tartalmazza az URL-t. Ha az URL bizonyos kulcsszavakat tartalmaz, ezeket a kulcsszavakat a megfelelő értékekre cseréli a beküldött üzenetnek megfelelően. Más szóval, egy URL sablon egy olyan URL, amelyet az SMS átjáró feldolgoz, mielőtt azt a HTTP válaszban használná. A feldolgozás azt jelenti, hogy bizonyos kulcsszavakat lecserél az URL-ben.
Például, ha a következő URL-t adja meg a continueurl paraméterben:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
A következőre módosul, amikor a HTTP válaszban visszaküldik:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Figyelje meg, hogy a $messageid és $statusmessage kulcsszavakat lecserélték. A beküldött üzenet azonosítója helyettesíti a $messageid kulcsszót az URL-ben, és az elküldés állapotüzenete helyettesíti a $statusmessage kulcsszót. Az Ozeki 10 SMS Gateway az alábbi táblázatban megadott kulcsszavakat cseréli le.
Hogyan használjuk?
Ahhoz, hogy egy URL sablont átadjunk a redirecturl, a continueurl vagy a reporturl paraméterben, az URL sablont URL-kódolni kell. Ez szükséges, mert különben a sendmessage metódus HTTP szintaxisa megsérülne. Az URL sablon URL-kódolásához használhatja az online URL kódoló eszközt (elérhető itt: http://www.ozeki.hu/index.php?owpn=5679) vagy manuálisan is elvégezheti a kódolást.
A fenti példában használt URL sablon a kódolás előtt így néz ki:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Az URL-kódolás után így fog kinézni:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Ha ezt az URL sablont szeretné belefoglalni a beküldési kérésébe, a kérése így fog kinézni:
http://127.0.0.1:9501/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World&redirecturl=
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Kulcsszavak
Az URL sablonok a következő kulcsszavakat tartalmazhatják| Helyettesítve erre | A következő paraméterben használható a HTTP API sendmessage metódusában | |
| statuscode | Az üzenet beküldésének eredménykódja | redirecturl continueurl reporturl |
| statusmessage | Az üzenet beküldésének állapotüzenete. (A statuscode magyarázata.) | redirecturl continueurl reporturl |
| messageid | A beküldött üzenet azonosítója | redirecturl continueurl reporturl |
| recipient | A beküldött üzenet címzettjének telefonszáma | redirecturl continueurl reporturl |
| originator | A beküldött üzenet küldőjének neve vagy telefonszáma | redirecturl continueurl reporturl |
| messagetype | A beküldött üzenet típusa | redirecturl continueurl reporturl |
| messagedata | A beküldött üzenet tartalma | redirecturl continueurl reporturl |
| submitdate | Az üzenet beküldésének dátum és időértéke. A dátum formátuma: ÉÉÉÉ-HH-NN óó:pp:mm. | reporturl |
| deliveredtonetworkdate | Az üzenet hálózatnak történő kézbesítésének dátum és időértéke. A dátum formátuma: ÉÉÉÉ-HH-NN óó:pp:mm. | reporturl |
| deliveredtohandsetdate | Az üzenet készüléknek történő kézbesítésének dátum és időértéke. A dátum formátuma: ÉÉÉÉ-HH-NN óó:pp:mm. | reporturl |
| status | A beküldött üzenet aktuális állapota.
Lehetséges értékek:
deliveredtonetwork deliveredtohandset deliveryfailed Ha a kézbesítés sikertelen, a statuscode és statusmessage paraméterek tartalmazzák a szolgáltató által visszaadott hibakódot és hibaüzenetet | reporturl |
Ha egynél több üzenetet küldenek el egyetlen HTTP kéréssel, az URL sablon a listában szereplő utolsó üzenetnek megfelelő értékeket fogja tartalmazni.
More information