API HTTP - Plantilla de URL
Esta guía proporciona instrucciones sobre cómo crear una plantilla de URL para ser utilizada en los parámetros redirecturl, continueurl y reporturl del método sendmessage de la API HTTP.
Introducción
Si los parámetros redirecturl o continueurl están incluidos en tu solicitud HTTP sendmessage, el servidor SMS devolverá una respuesta que contiene la URL. Si la URL especificada contiene ciertas palabras clave, estas serán reemplazadas por los valores correspondientes al mensaje enviado. En otras palabras, una plantilla de URL es una URL que será procesada por la pasarela SMS antes de ser utilizada en la respuesta HTTP. Procesar significa que ciertas palabras clave serán reemplazadas en la URL.
Por ejemplo, si especificas la siguiente URL en el parámetro continueurl:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Se modificará así cuando se devuelva en la respuesta HTTP:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Nota que las palabras clave $messageid y $statusmessage han sido reemplazadas. El ID del mensaje enviado se sustituye por la palabra clave $messageid en la URL, y el mensaje de estado del envío se sustituye por la palabra clave $statusmessage. Ozeki 10 SMS Gateway reemplaza las palabras clave especificadas en la tabla a continuación.
¿Cómo usarlo?
Para pasar una plantilla de URL en los parámetros redirecturl, continueurl o reporturl, la plantilla de URL debe estar codificada en URL. Esto es necesario porque, de lo contrario, la sintaxis HTTP del método sendmessage se rompería. Para codificar tu plantilla de URL, puedes usar la herramienta de codificación en línea (disponible en http://www.ozeki.hu/index.php?owpn=5679) o puedes hacer la codificación manualmente.
La plantilla de URL que usamos en el ejemplo anterior se ve así antes de la codificación:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Después de codificarla, se verá así:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Si deseas incluir esta plantilla de URL en tu solicitud de envío, tu solicitud se vería así:
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
Palabras clave
Las plantillas de URL pueden contener las siguientes palabras clave| Reemplazado por | Se puede usar en el siguiente parámetro del método sendmessage de la API HTTP | |
| statuscode | El código de resultado del envío del mensaje | redirecturl continueurl reporturl |
| statusmessage | El mensaje de estado del envío del mensaje. (Explicación del statuscode.) | redirecturl continueurl reporturl |
| messageid | El ID del mensaje enviado | redirecturl continueurl reporturl |
| recipient | El número de teléfono del destinatario del mensaje enviado | redirecturl continueurl reporturl |
| originator | El nombre del remitente o número de teléfono del remitente del mensaje enviado | redirecturl continueurl reporturl |
| messagetype | El tipo de mensaje del mensaje enviado | redirecturl continueurl reporturl |
| messagedata | Los datos del mensaje enviado | redirecturl continueurl reporturl |
| submitdate | La fecha y hora del evento de envío del mensaje. El formato de fecha es AAAA-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | La fecha y hora del evento de entrega del mensaje a la red. El formato de fecha es AAAA-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | La fecha y hora del evento de entrega del mensaje al dispositivo. El formato de fecha es AAAA-MM-DD hh:mm:ss. | reporturl |
| status | El estado actual del mensaje enviado.
Valores posibles:
deliveredtonetwork deliveredtohandset deliveryfailed Si la entrega falla, los parámetros statuscode y statusmessage contienen el código de error y el mensaje de error devuelto por el proveedor de servicios. | reporturl |
Si se envían varios mensajes con una sola solicitud HTTP, la plantilla de URL contendrá los valores correspondientes al último mensaje de la lista.
More information