HTTP API - Șablon URL
Acest ghid vă oferă instrucțiuni despre cum să creați un șablon URL pentru a fi utilizat în parametrii redirecturl, continueurl și reporturl ai metodei sendmessage din HTTP API.
Introducere
Dacă parametrii redirecturl sau continueurl sunt incluși în cererea HTTP sendmessage, serverul SMS va returna un răspuns care conține URL-ul. Dacă URL-ul specificat conține anumite cuvinte cheie, acestea vor fi înlocuite cu valorile corespunzătoare mesajului trimis. Cu alte cuvinte, un șablon URL este un URL care va fi procesat de gateway-ul SMS înainte de a fi utilizat în răspunsul HTTP. Procesarea înseamnă că anumite cuvinte cheie vor fi înlocuite în URL.
De exemplu, dacă specificați următorul URL în parametrul continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Acesta va fi modificat astfel când este returnat în răspunsul HTTP:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Rețineți că cuvintele cheie $messageid și $statusmessage au fost înlocuite. ID-ul mesajului trimis este înlocuit pentru cuvântul cheie $messageid în URL, iar mesajul de stare al trimiterii este înlocuit pentru cuvântul cheie $statusmessage. Ozeki 10 SMS Gateway înlocuiește cuvintele cheie specificate în tabelul de mai jos.
Cum se utilizează?
Pentru a transmite un șablon URL în parametrii redirecturl, continueurl sau reporturl, șablonul URL trebuie să fie codificat URL. Acest lucru este necesar, deoarece altfel sintaxa HTTP a metodei sendmessage s-ar întrerupe. Pentru a codifica URL-ul șablonului, puteți utiliza instrumentul online de codificare URL (disponibil la http://www.ozeki.hu/index.php?owpn=5679) sau puteți face codificarea manual.
Șablonul URL pe care l-am folosit în exemplul de mai sus arată astfel înainte de codificare:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
După codificarea URL, va arăta astfel:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Dacă doriți să includeți acest șablon URL în cererea de trimitere, cererea dvs. ar arăta astfel:
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
Cuvinte cheie
Șabloanele URL pot conține următoarele cuvinte cheie| Înlocuit cu | Poate fi utilizat în următorul parametru al metodei HTTP API sendmessage | |
| statuscode | Codul de rezultat al trimiterii mesajului | redirecturl continueurl reporturl |
| statusmessage | Mesajul de stare al trimiterii mesajului. (Explicarea statuscode.) | redirecturl continueurl reporturl |
| messageid | ID-ul mesajului trimis | redirecturl continueurl reporturl |
| recipient | Numărul de telefon al destinatarului mesajului trimis | redirecturl continueurl reporturl |
| originator | Numele expeditorului sau numărul de telefon al expeditorului mesajului trimis | redirecturl continueurl reporturl |
| messagetype | Tipul mesajului trimis | redirecturl continueurl reporturl |
| messagedata | Datele mesajului trimis | redirecturl continueurl reporturl |
| submitdate | Data și ora evenimentului de trimitere a mesajului. Formatul datei este YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Data și ora evenimentului de livrare a mesajului la rețea. Formatul datei este YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Data și ora evenimentului de livrare a mesajului la dispozitiv. Formatul datei este YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Starea curentă a mesajului trimis.
Valori posibile:
deliveredtonetwork deliveredtohandset deliveryfailed Dacă livrarea eșuează, parametrii statuscode și statusmessage conțin codul de eroare și mesajul de eroare returnat de furnizorul de servicii | reporturl |
Dacă mai multe mesaje sunt trimise cu o singură cerere HTTP, șablonul URL va conține valorile corespunzătoare ultimului mesaj din listă.
More information