HTTP-API - Aktion 'receivemessage'

Diese Aktion kann verwendet werden, um SMS-Nachrichten vom SMS-Gateway mittels HTTP-Polling zu empfangen. HTTP-Polling bedeutet, dass Sie SMS-Nachrichten aus dem Posteingang des Gateways herunterladen, ähnlich wie Sie eine Webseite herunterladen würden. In diesem Abschnitt erhalten Sie Informationen darüber, wie Sie die Aktion receivemessage nutzen können, welche Parameter erforderlich sind, und es wird ein Beispiel für eine HTTP-Anfrage zum Herunterladen eingehender Nachrichten gezeigt.

Beschreibung

Um eingehende Textnachrichten herunterzuladen, verwenden Sie das folgende URL-Format:

https://127.0.0.1:9508/api?action=receivemessage&username=UUUUU&password=PPPPP&
folder=inbox&limit=2&afterdownload=delete

Für 127.0.0.1 sollten Sie den Hostnamen oder die IP-Adresse des Computers einsetzen, auf dem Ihr SMS-Gateway installiert ist. Die Portnummer 9508 ist der Standard-HTTP-Port des Ozeki SMS-Gateways. Die Portnummer kann in der Benutzeroberfläche des Ozeki 10 SMS-Gateways konfiguriert werden, indem Sie auf die Schaltfläche "Erweitert" in der Symbolleiste klicken.

Der Benutzername und das Passwort sollten anstelle von "UUUUU" und "PPPPP" eingesetzt werden. Der Benutzername und das Passwort identifizieren den Benutzer, den Sie im SMS-Gateway erstellt haben. Wenn Sie die receivemessage-Aktion aufrufen, indem Sie die URL aufrufen, werden Nachrichten aus dem Posteingang des Benutzers heruntergeladen, der in der Abfrage mit dem Benutzernamen und dem Passwort angegeben ist.

Der Parameter folder der Nachricht sollte auf inbox gesetzt werden.

Der Parameter limit gibt die Anzahl der Nachrichten an, die heruntergeladen werden. Es wird empfohlen, weniger als 1000 Nachrichten in einer einzelnen Anfrage herunterzuladen. Die verbleibenden Nachrichten können in nachfolgenden Anfragen heruntergeladen werden.

Der Parameter afterdownload kann verwendet werden, um Nachrichten aus dem SMS-Gateway zu entfernen, sobald sie erfolgreich heruntergeladen wurden.

Beispiel-URL-Anfrage

https://127.0.0.1:9508/api?action=receivemessage&username=admin&password=abc123&
folder=inbox&limit=2&afterdownload=delete

Beispielantwort

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 824

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/response.xml">
<response>
   <action>receivemessage</action>
   <data>
   <message>
   <messageid>ERFAV23D</messageid>
   <originator>06301234567</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Hallo Welt</messagedata>
         <senttime>2008-01-16 10:04:00</senttime>
         <receivedtime>2008-01-18 20:58:04</receivedtime>
      </message>
      <message>
         <messageid>GYT4455D</messageid>
         <originator>06209994444</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Zweite Nachricht</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Anfrageparameter

Parameter	Beschreibung	Mögliche Werte	Beispiel	M/O*
action	Gibt den HTTP-API-Befehl an	receivemessage	action=receivemessage	M
username	Gibt den Benutzernamen an. Der Benutzername und das Passwort werden zur Authentifizierung des Benutzers verwendet. Nach der Authentifizierung werden Nachrichten aus seinem Posteingang heruntergeladen. Der Wert muss URL-kodiert sein.	Zeichenkette, maximale Länge 16 Zeichen	username=admin	M
password	Gibt das Passwort an. Der Benutzername und das Passwort werden zur Authentifizierung des Benutzers verwendet. Nach der Authentifizierung werden Nachrichten aus seinem Posteingang heruntergeladen. Der Wert muss URL-kodiert sein.	Zeichenkette, maximale Länge 16 Zeichen	password=abc123	M
folder	Gibt den Namen des Ordners an. Standardmäßig werden Nachrichten aus dem Posteingang heruntergeladen. Sie können die receivemessage-Aktion auch verwenden, um Nachrichten aus anderen Ordnern herunterzuladen.	inbox (Standard) outbox deliveredtonetwork deliveredtohandset deliveryfailed	folder=inbox	O
limit	Gibt die maximale Anzahl der Nachrichten an, die innerhalb der Anfrage vom Server heruntergeladen werden sollen. Die verbleibenden Nachrichten können in nachfolgenden Anfragen heruntergeladen werden.	Ganzzahl, Standardlimit ist 1000	limit=10	O
afterdownload	Gibt an, wie mit Nachrichten nach einem erfolgreichen Download verfahren werden soll. Nachrichten können aus dem SMS-Gateway gelöscht werden; sie können als heruntergeladen markiert werden oder unverändert bleiben. Wenn sie unverändert bleiben, werden sie beim nächsten Download erneut heruntergeladen.	delete (Standard) mark untouch	afterdownload=delete	O
responseformat	Sie können das Format der eingehenden Nachrichten des Benutzers angeben.	xml, html, url-encoded	responseformat=xml	O

* M = Pflichtparameter, O = Optionaler Parameter

Antwortparameter
(XML-Antwortformat)

Parameter	Beschreibung	Mögliche Werte	Beispiel
message	Enthält eine einzelne Nachricht. Der Datenabschnitt kann viele Nachrichten enthalten. Die Anzahl der Nachrichten in den Nachrichtendaten ist kleiner oder gleich dem Wert des Limit-Parameters.		<message> <messageid>ERFAV23D</messageid> <originator>06301234567</originator> <recipient>06201112222</recipient> <messagetype>SMS:TEXT</messagetype> <messagedata>Hallo Welt</messagedata> <senttime>2028-01-16 10:04:00</senttime> <receivedtime>2028-01-18 20:58:04</receivedtime> </message>
message.messageid	Enthält eine Nachrichtenreferenz, die zur Verfolgung der Nachricht im SMS-Gateway verwendet werden kann. Diese Nachrichtenreferenz wird auch verwendet, um Berichte über die Zustellung an das Netzwerk oder das Endgerät zu identifizieren oder um Informationen über die Nachricht abzufragen.	Zeichenkette, maximale Länge 16 Zeichen	<messageid>ERFAV23D</messageid>
message.originator	Enthält die Absendertelefonnummer. Dies ist die Telefonnummer des Mobiltelefons, das die Nachricht gesendet hat.	Zeichenkette, maximale Länge 16 Zeichen	<recipient>06301234567</recipient>
message.recipient	Enthält die Empfängeradresse. Dies ist die Telefonnummer, an die die Nachricht gesendet wurde.	Zeichenkette, maximale Länge 16 Zeichen	<recipient>06201112222</recipient>
message.messagetype	Enthält den Nachrichtentyp-Bezeichner, der in der Mobile Message Type Specification spezifiziert ist. In den meisten Fällen wird dies SMS:TEXT sein.	Zeichenkette, maximale Länge 1024 Zeichen	<recipient>SMS:TEXT</recipient>
message.messagedata	Enthält die Nachrichtendaten. Für Textnachrichten ist dies der Text der SMS-Nachricht. Für andere Nachrichtentypen ist dies eine XML-Struktur, die in der Mobile Message Type Specification spezifiziert ist. Die Nachrichtendaten sind als UTF8 kodiert.	Zeichenkette	<messagedata>Hallo Welt</messagedata>
message.senttime	Enthält den Zeitstempel, der angibt, wann die Nachricht vom Absendertelefon gesendet wurde.	Datum- und Zeitwert im folgenden Format: JJJJ-MM-TT hh:mm:ss	<senttime>2028-01-16 10:04:00</senttime>
message.receivedtime	Enthält den Zeitstempel, der angibt, wann die Nachricht vom SMS-Gateway empfangen wurde.	Datum- und Zeitwert im folgenden Format: JJJJ-MM-TT hh:mm:ss	<senttime>2028-01-18 20:58:04</senttime>

Zusammenfassung

In diesem Artikel haben Sie alle notwendigen Informationen gefunden, um die Aktion ‚receivemessage‘ mit unserer HTTP-SMS-API zu nutzen.

Mit dieser Lösung können Sie die Vorteile des HTTP-Pollings nutzen, um eingehende Textnachrichten zu empfangen. Wir haben unser Bestes gegeben, um es einfach zu gestalten und Sie so schmerzlos wie möglich durch alle Details zu führen. Wenn Sie die Schritte bereits abgeschlossen haben, haben Sie die Vorteile unserer HTTP-SMS-API gesehen. Wenn Sie noch nicht begonnen haben, Ihr SMS-System mit der API zu vervollständigen, verschwenden Sie keine Zeit. Fangen Sie jetzt an!

Wenn Sie mehr über die Vorteile anderer ähnlicher SMS-Lösungen erfahren möchten, besuchen Sie bitte die Seite über das Versenden von Nachrichten mit demselben System.

Ich hoffe, diese Seite wird für alle Leser und besonders für Anfänger nützlich sein.