API HTTP - Modèle d'URL

Ce guide vous donne des instructions sur la façon de créer un modèle d'URL à utiliser dans les paramètres redirecturl, continueurl et reporturl de la méthode sendmessage de l'API HTTP.

Introduction

Si les paramètres redirecturl ou continueurl sont inclus dans votre requête HTTP sendmessage, le serveur SMS renverra une réponse contenant l'URL. Si l'URL spécifiée contient certains mots-clés, ces mots-clés seront remplacés par les valeurs appropriées correspondant au message soumis. En d'autres termes, un modèle d'URL est une URL qui sera traitée par la passerelle SMS avant d'être utilisée dans la réponse HTTP. Le traitement signifie que certains mots-clés seront remplacés dans l'URL.

Par exemple, si vous spécifiez l'URL suivante dans le paramètre continueurl :

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

Elle sera modifiée comme ceci lorsqu'elle sera renvoyée dans la réponse HTTP :

http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepté+pour+livraison

Notez que les mots-clés $messageid et $statusmessage ont été remplacés. L'identifiant du message soumis est substitué au mot-clé $messageid dans l'URL et le message d'état de la soumission est substitué au mot-clé $statusmessage. Ozeki 10 SMS Gateway remplace les mots-clés spécifiés dans le tableau ci-dessous.

Comment l'utiliser ?

Pour passer un modèle d'URL dans les paramètres redirecturl, continueurl ou reporturl, le modèle d'URL doit être encodé en URL. Ceci est nécessaire car sinon la syntaxe HTTP de la méthode sendmessage serait rompue. Pour encoder votre modèle d'URL, vous pouvez utiliser l'outil d'encodage en ligne (disponible à http://www.ozeki.hu/index.php?owpn=5679) ou vous pouvez effectuer l'encodage manuellement.

Le modèle d'URL utilisé dans l'exemple ci-dessus ressemble à ceci avant l'encodage :

http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage

Après l'encodage en URL, il ressemblera à ceci :

http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage

Si vous souhaitez inclure ce modèle d'URL dans votre requête de soumission, votre requête ressemblera à ceci :

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

Mots-clés

Si plusieurs messages sont soumis avec une seule requête HTTP, le modèle d'URL contiendra les valeurs correspondant au dernier message de la liste.