HTTP-API - URL-Vorlage
Diese Anleitung gibt Ihnen Hinweise, wie Sie eine URL-Vorlage erstellen, die in den Parametern redirecturl, continueurl und reporturl der HTTP-API-Methode sendmessage verwendet werden kann.
Einführung
Wenn die Parameter redirecturl oder continueurl in Ihrer sendmessage-HTTP-Anfrage enthalten sind, gibt der SMS-Server eine Antwort mit der URL zurück. Wenn die angegebene URL bestimmte Schlüsselwörter enthält, werden diese durch die entsprechenden Werte der übermittelten Nachricht ersetzt. Mit anderen Worten ist eine URL-Vorlage eine URL, die vom SMS-Gateway verarbeitet wird, bevor sie in der HTTP-Antwort verwendet wird. Verarbeitung bedeutet, dass bestimmte Schlüsselwörter in der URL ersetzt werden.
Wenn Sie beispielsweise die folgende URL im Parameter continueurl angeben:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Wird sie bei der Rückgabe in der HTTP-Antwort wie folgt modifiziert:
http://www.myserver.com/index.asp?msgid=AC32DEF&statusmsg=Message+accepted+for+delivery
Beachten Sie, dass die Schlüsselwörter $messageid und $statusmessage ersetzt wurden. Die Nachrichten-ID der übermittelten Nachricht wird für das Schlüsselwort $messageid in der URL ersetzt und die Statusmeldung der Übermittlung wird für das Schlüsselwort $statusmessage ersetzt. Ozeki 10 SMS Gateway ersetzt die in der folgenden Tabelle angegebenen Schlüsselwörter.
Wie wird es verwendet?
Um eine URL-Vorlage in den Parametern redirecturl, continueurl oder reporturl zu übergeben, muss die URL-Vorlage urlcodiert sein. Dies ist notwendig, da sonst die HTTP-Syntax der sendmessage-Methode unterbrochen würde. Um Ihre URL-Vorlage zu urlcodieren, können Sie das Online-URL-Codierungstool verwenden (verfügbar unter http://www.ozeki.hu/index.php?owpn=5679) oder Sie können die Codierung manuell durchführen.
Die URL-Vorlage, die wir im obigen Beispiel verwendet haben, sieht vor der Codierung wie folgt aus:
http://www.myserver.com/index.asp?msgid=$messageid&statusmsg=$statusmessage
Nach der URL-Codierung sieht sie so aus:
http%3A%2F%2Fwww.myserver.com%2Findex.asp%3Fmsgid%3D%24messageid%26statusmsg%3D%24
statusmessage
Wenn Sie diese URL-Vorlage in Ihre Übermittlungsanfrage aufnehmen möchten, würde Ihre Anfrage wie folgt aussehen:
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
Schlüsselwörter
URL-Vorlagen können die folgenden Schlüsselwörter enthalten| Ersetzt durch | Kann in den folgenden Parametern der HTTP-API-Methode sendmessage verwendet werden | |
| statuscode | Der Ergebniscode der Nachrichtenübermittlung | redirecturl continueurl reporturl |
| statusmessage | Die Statusmeldung der Nachrichtenübermittlung. (Der statuscode erklärt.) | redirecturl continueurl reporturl |
| messageid | Die ID der übermittelten Nachricht | redirecturl continueurl reporturl |
| recipient | Die Empfängertelefonnummer der übermittelten Nachricht | redirecturl continueurl reporturl |
| originator | Der Absendername oder die Absendertelefonnummer der übermittelten Nachricht | redirecturl continueurl reporturl |
| messagetype | Der Nachrichtentyp der übermittelten Nachricht | redirecturl continueurl reporturl |
| messagedata | Die Nachrichtendaten der übermittelten Nachricht | redirecturl continueurl reporturl |
| submitdate | Das Datum und die Uhrzeit des Nachrichtenübermittlungsereignisses. Das Datumsformat ist YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtonetworkdate | Das Datum und die Uhrzeit des Ereignisses, bei dem die Nachricht an das Netzwerk übermittelt wurde. Das Datumsformat ist YYYY-MM-DD hh:mm:ss. | reporturl |
| deliveredtohandsetdate | Das Datum und die Uhrzeit des Ereignisses, bei dem die Nachricht an das Handgerät übermittelt wurde. Das Datumsformat ist YYYY-MM-DD hh:mm:ss. | reporturl |
| status | Der aktuelle Status der übermittelten Nachricht.
Mögliche Werte:
deliveredtonetwork deliveredtohandset deliveryfailed Wenn die Zustellung fehlschlägt, enthalten die Parameter statuscode und statusmessage den Fehlercode und die Fehlermeldung des Dienstanbieters | reporturl |
Wenn mehr als eine Nachricht mit einer einzelnen HTTP-Anfrage übermittelt wird, enthält die URL-Vorlage die Werte, die der letzten Nachricht in der Liste entsprechen.
More information