SMS von Ruby aus senden

Der einfachste Weg, SMS von Ruby aus zu versenden, ist die Verwendung der integrierten HTTP/Rest-SMS-API von Ozeki SMS Gateway. Wenn Sie diese API verwenden, senden Sie SMS-Nachrichten, indem Sie eine HTTP-Post-Anfrage an das SMS-Gateway stellen. Die HTTP-Post-Anfrage enthält eine Nachricht im JSON-Format. Das SMS-Gateway sendet diese SMS an das Mobiltelefon des Empfängers und gibt eine HTTP-200-OK-Antwort auf Ihre Anfrage zurück.

SMS von Ruby aus senden
Abbildung 1 - SMS von Ruby aus senden

Ruby-Code zum Senden von SMS an Mobiltelefone

Das folgende Ruby-SMS-Codebeispiel zeigt, wie Sie SMS mit der HTTP-Rest-SMS-API von Ozeki SMS Gateway unter Verwendung des Ruby-Gems ozeki_libs_rest senden können. Diese Bibliothek wird Ihnen kostenlos zur Verfügung gestellt, und Sie können sie in Ihren Projekten verwenden und nach Belieben modifizieren.

SendSms.rb 
require 'ozeki_libs_rest'

configuration = Configuration.new(
    "http_user",
    "qwe123",
    "http://127.0.0.1:9509/api"
);

msg = Message.new
msg.to_address = "+36201111111"
msg.text = "Hallo Welt!"

api = MessageApi.new(configuration)

result = api.send(msg)

print(result)

Code 1 - SendSms.rb

So verwenden Sie das Ruby-SMS-Beispiel:

Dieses Ruby-SMS-Beispiel kann in jeder Ruby-Anwendung verwendet werden. Um es zu nutzen, müssen Sie das ozeki_libs_rest-Gem herunterladen. Nach dem Herunterladen müssen Sie in Ihrem Ruby-Quellcode eine Referenz darauf hinzufügen. Dadurch können Sie die Klassen des ozeki_libs_rest-Gems verwenden. Mit der Message-Klasse können Sie die SMS erstellen. Mit der MessageApi-Klasse können Sie die SMS an das SMS-Gateway senden. Das SMS-Gateway leitet Ihre Nachricht entweder über eine drahtlose Verbindung oder über das Internet an das Mobilfunknetz weiter.

SendSms.rb herunterladen

Der in diesem Artikel erklärte Quellcode kann kostenlos heruntergeladen, verwendet und modifiziert werden.
Download: SendSms.rb.zip (316B)

Was befindet sich in der SendSms.rb.zip-Datei?

In der SendSms.rb.zip finden Sie die Datei SendSms.rb, die den Beispielcode enthält, der Ihnen zeigt, wie Sie eine SMS senden können. Dieser Beispielcode ist unten aufgeführt.

Abbildung 2 - Inhalt von SendSms.rb.zip

So installieren Sie das ozeki_libs_rest-Gem mit der Windows-Shell

gem install ozeki_libs_rest

Code 2 - Befehl zur Installation des ozeki_libs_rest-Gems

Video 1 - So installieren Sie das ozeki_libs_rest-Gem (Video-Tutorial)

SMS von Ruby aus senden (Einfache Anleitung)

So senden Sie SMS von Ruby aus:

  1. Installieren Sie einen HTTP-API-Benutzer
  2. Aktivieren Sie "Log communication events" auf der Registerkarte "Advanced"
  3. Richten Sie Visual Studio ein
  4. Laden Sie die Datei SendSms.rb.zip herunter und entpacken Sie sie
  5. Starten Sie die Ozeki SMS Gateway-App
  6. Führen Sie den Ruby-Code SendSend.rb über die Eingabeaufforderung aus
  7. Überprüfen Sie die Protokolle, um zu sehen, ob die SMS gesendet wurde

Ozeki SMS Gateway installieren und einen HTTP-API-Benutzer erstellen

Um SMS von Ruby aus senden zu können, müssen Sie zunächst Ozeki SMS Gateway installieren. Das SMS-Gateway kann auf demselben Computer installiert werden, auf dem Sie Ihren Ruby-Code in einem beliebigen Texteditor wie Windows Notepad entwickeln. Nach der Installation besteht der nächste Schritt darin, Ozeki SMS Gateway mit dem Mobilfunknetz zu verbinden. Sie können eine Test-SMS über die Ozeki-GUI senden, um zu überprüfen, ob Ihre Mobilfunknetzverbindung funktioniert. Der letzte Schritt zur Vorbereitung Ihrer Umgebung besteht darin, einen HTTP-SMS-API-Benutzer zu erstellen. Erstellen Sie einen Benutzer mit dem Benutzernamen "http_user" und dem Passwort "qwe123", damit das Beispiel ohne Änderungen funktioniert.

Nachdem die Umgebung eingerichtet ist, können Sie Ihren Ruby-Code ausführen.

HTTP-API-URL zum Senden von SMS von Ruby aus

Um SMS von Ruby aus zu senden, muss Ihre Ruby-Anwendung eine HTTP-Anfrage an das SMS-Gateway stellen. Die API-URL wird unten angezeigt. Beachten Sie, dass die IP-Adresse (127.0.0.1) durch die IP-Adresse Ihres SMS-Gateways ersetzt werden sollte. Wenn Ozeki SMS Gateway auf demselben Computer installiert ist, auf dem die Ruby-SMS-Anwendung läuft, kann dies 127.0.0.1 sein. Wenn es auf einem anderen Computer installiert ist, sollte es die IP-Adresse dieses Computers sein. 

http://127.0.0.1:9509/api?action=rest

HTTP-Authentifizierung zum Senden von SMS von Ruby aus

Um den Ruby-SMS-Client zu authentifizieren, müssen Sie den Benutzernamen und das Passwort in einer base64-kodierten Zeichenkette in einer HTTP-Anfrage an den Server senden. Das verwendete Format lautet: base64(Benutzername+":"+Passwort). In Ruby können Sie den folgenden Code verwenden, um diese Kodierung durchzuführen: 

username_password = username + ':' + password
username_password_encoded = Base64.encode64(username_password)
'Basic ' + username_password_encoded

Wenn Sie beispielsweise den Benutzernamen 'http_user' und das Passwort 'qwe123' kodieren, erhalten Sie die folgende base64-kodierte Zeichenkette: aHR0cF91c2VyOnF3ZTEyMw==. Zum Senden

HTTP-Anforderungsheader zum Senden von SMS aus Ruby

Um die SMS-Nachrichten zu senden, müssen Sie die folgenden Zeilen als Header in die HTTP-Anforderung einfügen. Beachten Sie, dass wir einen Content-Type und einen Authorization-Header einbeziehen. 

Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

HTTP-Anforderung zum Senden von SMS aus Ruby

Um die SMS zu übermitteln, sendet Ihre Ruby-Anwendung eine HTTP-Anforderung ähnlich der untenstehenden. Beachten Sie, dass diese Anforderung einen HTTP-Header-Teil und einen HTTP-Body-Teil enthält. Der HTTP-Body ist eine JSON-kodierte Datenzeichenfolge. Er enthält die Nummer des Empfängers und den Text der Nachricht. 

POST /api?action=sendmsg HTTP/1.1
Content-Length: 339
Content-Type: application/json
Accept: application/json
Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 127.0.0.1:9509
User-Agent: Faraday v1.5.0

{
	"messages":	[
		{
			"message_id":	"2861551f-fddd-4b8e-9b06-eab9e1a0d179",
			"to_address":	"+36201111111",
			"text":	"Hello world!",
			"create_date":	"2021-07-06T09:09:44",
			"valid_until":	"2021-07-13T09:09:44",
			"time_to_send":	"2021-07-06T09:09:44",
			"is_submit_report_requested":	true,
			"is_delivery_report_requested":	true,
			"is_view_report_requested":	true,
			"tags":	[]
		}
	]
}

HTTP-Antwort, die vom Ruby-SMS-Beispiel empfangen wurde

Sobald das SMS-Gateway diese Anforderung erhält, wird es eine HTTP-Antwort generieren. Die HTTP-Antwort enthält einen Statuscode, der angibt, ob die SMS-Übermittlungsanforderung erfolgreich war oder nicht. Sie gibt auch eine JSON-kodierte Struktur zurück, die Ihnen nützliche Details über die Übermittlung der Nachricht liefert. 

HTTP/1.1 200 OK
User-Agent: OZEKI 10.3.123 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Tue, 06 Jul 2021 08:52:02 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "Messages queued for delivery.",
	"data": {
	  "total_count": 1,
	  "success_count": 1,
	  "failed_count": 0,
	  "messages": [
	    {
	      "message_id": "2861551f-fddd-4b8e-9b06-eab9e1a0d179",
	      "from_station": "%",
	      "to_address": "+36201111111",
	      "to_station": "%",
	      "text": "Hello world!",
	      "create_date": "2021-07-06 09:09:44",
	      "valid_until": "2021-07-13 09:09:44",
	      "time_to_send": "2021-07-06 09:09:44",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ],
	      "status": "SUCCESS"
	    }
	  ]
	}
}

Verbinden Sie Ihr SMS-Gateway mit dem Mobilfunknetz und erstellen Sie ein HTTP-API Benutzerkonto

Wir gehen davon aus, dass Sie bereits Ozeki SMS Gateway installiert haben und es mit dem Mobilfunknetz verbunden haben. Um SMS von Ruby an ein Mobiltelefon senden zu können, müssen Sie ein HTTP-API-Benutzerkonto in Ozeki SMS Gateway einrichten.

Video 2 - Wie Sie ein HTTP-API-Benutzerkonto einrichten (Video-Tutorial)

Wie Sie SMS aus Ruby mit der Ruby-SMS-API senden (Video-Tutorial)

Dieses Video zeigt Ihnen, wie Sie die Datei SendSms.rb.zip von dieser Seite herunterladen. Wenn Sie das Video ansehen, werden Sie feststellen, dass die Inhalte der SendSms.rb-Zip auf den Windows-Desktop platziert werden. Sie werden auch sehen, dass wir die Eingabeaufforderung verwenden, um die SMS zu senden.

Ruby-SMS-Beispiel: SendSms.rb

Der Beispielcode unten ist Teil der SendSms.rb.

Abbildung 3 - SendSms.rb-Datei

Wie Sie überprüfen, ob die SMS vom HTTP-Benutzer akzeptiert wurde

Nachdem die SMS übermittelt wurde, ist es eine gute Idee, Ihr SMS-Gateway zu überprüfen, um zu sehen, was es empfangen hat. Sie können das Protokoll überprüfen, indem Sie die Details des HTTP-Benutzers aus der Ozeki SMS Gateway-Verwaltungskonsole öffnen. Das folgende Video zeigt Ihnen, worauf Sie achten müssen.

Video 4 - Wie Sie SMS mit dem obigen Ruby-Code senden (Video-Tutorial)

Wie Sie überprüfen, ob die SMS an das Mobilfunknetz gesendet wurde

Der letzte Schritt zur Überprüfung des Verfahrens besteht darin, sich die Protokolle der Mobilfunknetzverbindung anzusehen. Möglicherweise müssen Sie die Protokollierung in der Konfiguration der Verbindung aktivieren, bevor Sie die Nachricht senden, um die Protokolleinträge zu sehen. Wenn die Protokollierung aktiviert ist, sehen Sie die Telefonnummer und den Text der Nachricht, die Sie gesendet haben.

Video 5 - Wie Sie testen, ob die Anfrage vom SMPP-Client akzeptiert wurde (Video-Tutorial)

Wie das Empfangen einer Nachricht auf Android aussieht (Video-Tutorial)

In diesem Video sehen Sie den Prozess des Empfangens einer Nachricht auf Android, wenn die Nachricht mit dem Ozeki SMS Gateway gesendet wurde. Das Video beginnt mit einem gewöhnlichen Android-Hauptbildschirm und zeigt die Benachrichtigung, die Sie bei einer eingehenden SMS erhalten, sowie die geöffnete Nachrichten-App mit der SMS "Hello World". Das Video ist nur 18 Sekunden lang, zeigt aber den gesamten Prozess.

Video 6 - Wie das Empfangen einer Nachricht auf Android aussieht (Video-Tutorial)

Fazit

Das Hauptziel dieses Artikels war es, die Schritte der SMS-Übermittlung in Ruby mit Hilfe des Ozeki SMS Gateways zu zeigen. Mit dieser Innovation können Sie Nachrichten an Ihre Kunden senden, während Sie hinter einem Computer sitzen, indem Sie nur das Ozeki SMS Gateway und einen Ruby-Code verwenden. Diese Lösung ist ein gutes Beispiel dafür, wie einfach das Ozeki SMS Gateway mit Ruby-Codes zu steuern ist. Es sollte auch erwähnt werden, dass das Ozeki SMS Gateway in jedem Land funktioniert und SMS über verschiedene Mobilfunkverbindungen senden und empfangen kann.

Lesen Sie weiter auf der Tutorial-Seite von Ozeki, wo Sie mehr Informationen zu Themen wie SMS-Planung in Ruby finden.

Das Einzige, was Sie jetzt tun müssen, ist, das Ozeki SMS Gateway herunterzuladen und die Arbeit zu beginnen!

More information