Comment recevoir des SMS depuis Ruby

La manière la plus simple de recevoir des messages SMS depuis Ruby est d'utiliser l'API SMS HTTP/Rest intégrée d'Ozeki SMS Gateway. Lorsque vous utilisez cette API, vous enverrez des messages SMS en effectuant une requête HTTP Post vers la passerelle SMS. La requête HTTP Post contiendra un message formaté en JSON. La passerelle SMS enverra ce SMS au téléphone du destinataire, et elle renverra une réponse HTTP 200 OK à votre requête.

Code Ruby pour recevoir des messages SMS

L'exemple de code Ruby pour les SMS ci-dessous montre comment envoyer un SMS programmé en utilisant l'API SMS HTTP REST d'Ozeki SMS Gateway avec la gem ozeki_libs_rest. Cette bibliothèque vous est fournie gratuitement, et vous pouvez l'utiliser et la modifier dans tous vos projets.

ReceiveSms.rb

require 'ozeki_libs_rest'

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

api = MessageApi.new(configuration)

result = api.download_incoming()

print(result, "\n")
result.messages.each do |message|
    print(message, "\n")
end

Comment utiliser l'exemple Ruby pour les SMS :

Cet exemple Ruby pour les SMS peut être utilisé dans n'importe quelle application Ruby. Pour l'utiliser, vous devez télécharger la gem ozeki_libs_rest. Après avoir téléchargé la gem, vous devez ajouter une référence à celle-ci dans votre code source Ruby. Cela vous permettra d'utiliser les classes fournies par la gem ozeki_libs_rest. Vous pouvez utiliser la classe Message pour créer le SMS. Vous pouvez utiliser la classe MessageApi pour envoyer le SMS à la passerelle SMS. La passerelle SMS transmettra votre message au réseau mobile soit via une connexion sans fil soit via Internet.

Télécharger ReceiveSms.rb

Le code source expliqué dans cet article peut être téléchargé, utilisé et modifié gratuitement.
Téléchargement : ReceiveSms.rb.zip (319B)

Que contient le fichier ReceiveSms.rb.zip ?

Le fichier ReceiveSms.rb.zip contient le fichier ReceiveSms.rb, qui contient le code exemple pour vous montrer comment envoyer un SMS. Ce code exemple est listé ci-dessous.

Comment envoyer un SMS programmé depuis Ruby (étapes rapides)

Pour envoyer un SMS programmé depuis Ruby :

Téléchargez le fichier ReceiveSms.rb.zip
Extrayez le fichier .zip du dossier Téléchargements
Ouvrez le fichier ReceiveSms.rb dans un éditeur de texte comme Bloc-notes
Lancez Ozeki SMS Gateway
Créez un utilisateur API HTTP dans Ozeki
Exécutez le code Ruby ReceiveSms.rb depuis l'invite de commande
Vérifiez la boîte Envoyés dans Ozeki SMS Gateway

Installer Ozeki SMS Gateway et créer un utilisateur API HTTP

Pour pouvoir envoyer des SMS depuis Ruby, vous devez d'abord installer Ozeki SMS Gateway. La passerelle SMS peut être installée sur le même ordinateur où vous développez votre code Ruby dans Visual Studio. Après l'installation, l'étape suivante consiste à connecter Ozeki SMS Gateway au réseau mobile. Vous pouvez envoyer un SMS test depuis l'interface Ozeki pour vérifier que votre connexion au réseau mobile fonctionne. La dernière étape pour préparer votre environnement est de créer un utilisateur API SMS HTTP. Créez un utilisateur avec le nom d'utilisateur "http_user" et le mot de passe "qwe123" pour que l'exemple fonctionne sans modification.

Une fois l'environnement configuré, vous pouvez exécuter votre code Ruby.

URL de l'API HTTP pour envoyer des SMS depuis Ruby

Pour envoyer des SMS depuis Ruby, votre application Ruby devra effectuer une requête HTTP vers la passerelle SMS. L'URL de l'API est indiquée ci-dessous. Notez que l'adresse IP (127.0.0.1) doit être remplacée par l'adresse IP de votre passerelle SMS. Si Ozeki SMS Gateway est installé sur le même ordinateur que celui où l'application Ruby SMS est exécutée, cela peut être 127.0.0.1. S'il est installé sur un autre ordinateur, cela doit être l'adresse IP de cet ordinateur.

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

Authentification HTTP pour envoyer des SMS depuis Ruby

Pour authentifier le client SMS Ruby, vous devez envoyer le nom d'utilisateur et le mot de passe dans une chaîne encodée en base64 au serveur dans une requête HTTP. Le format utilisé est : base64(nom_utilisateur+":"+mot_de_passe). En Ruby, vous pouvez utiliser le code suivant pour effectuer cet encodage :

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

Par exemple, si vous encodez le nom d'utilisateur 'http_user' et le mot de passe 'qwe123', vous obtiendrez la chaîne encodée en base64 suivante : aHR0cF91c2VyOnF3ZTEyMw==. Pour envoyer

En-tête de requête HTTP pour envoyer des SMS depuis Ruby

Pour envoyer les messages SMS, vous devez inclure les lignes suivantes comme en-têtes dans la requête HTTP. Notez que nous incluons un en-tête Content-Type et un en-tête Authorization.

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

Requête HTTP pour envoyer des SMS depuis Ruby

Pour demander vos messages SMS entrants, votre application Ruby enverra une requête HTTP similaire à celle ci-dessous. Notez que cette requête contient uniquement une partie d'en-tête HTTP.

GET /api?action=receivemsg&folder=inbox HTTP/1.1
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

Réponse HTTP reçue par l'exemple Ruby SMS

Une fois que la passerelle SMS reçoit cette requête, elle générera une réponse HTTP. La réponse HTTP contiendra un code de statut pour indiquer si la soumission du SMS a réussi ou non. Elle renverra également une structure encodée en JSON pour vous fournir des détails utiles sur les messages.

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 14:49:32 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "",
	"data": {
	  "folder": "inbox",
	  "limit": "1000",
	  "data": [
	    {
	      "message_id": "4524cd1f-f048-4b78-99ec-37bd906e676d",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36203333333",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 3",
	      "create_date": "2021-07-06 14:47:37",
	      "valid_until": "2021-07-13 14:47:37",
	      "time_to_send": "2021-07-06 14:47:37",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "e3125586-3d66-4f91-ac4e-66747653fe24",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36202222222",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 2",
	      "create_date": "2021-07-06 14:47:37",
	      "valid_until": "2021-07-13 14:47:37",
	      "time_to_send": "2021-07-06 14:47:37",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "98895df5-4972-4941-8bf3-5fb0302d1fa8",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36201111111",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 1",
	      "create_date": "2021-07-06 14:47:37",
	      "valid_until": "2021-07-13 14:47:37",
	      "time_to_send": "2021-07-06 14:47:37",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    }
	  ]
	}
}

Exemple Ruby SMS : ReceiveSms.rb

Dans cette vidéo, vous verrez le processus de téléchargement de ReceiveSMS.rb depuis cette page de tutoriel. Elle commencera avec la page ouverte et se terminera avec le projet ouvert. La vidéo ne dure que 30 secondes, mais elle contient toutes les informations dont vous avez besoin pour télécharger le projet exemple. Elle est facile à comprendre et détaillée. Vous n'aurez aucun problème avec les étapes.

Vidéo 1 - Comment télécharger et ouvrir le fichier ci-dessus (Tutoriel vidéo)

Exemple de code

L'exemple de code ci-dessous fait partie du fichier ReceiveSms.rb. Si vous êtes familier avec le langage de programmation Ruby, n'hésitez pas à modifier le projet exemple selon vos préférences et envoyez votre premier message test.

Comment utiliser le projet exemple

Dans la vidéo suivante, vous verrez comment vous pouvez envoyer un message en utilisant le projet exemple. Elle commencera avec un Bloc-notes ouvert contenant le code source. À la fin de la vidéo, vous verrez les messages reçus. La vidéo ne dure qu'une minute, mais vous apprendrez toutes les étapes nécessaires pour terminer le processus. La vidéo est très détaillée, vous n'aurez donc aucun problème à suivre les étapes.

Vidéo 2 - Comment utiliser le fichier ReceiveSms.rb (Tutoriel vidéo)

Résumé

L'objectif de ce guide était d'expliquer les étapes de réception de SMS en Ruby avec l'aide d'Ozeki SMS Gateway. Avec quelques étapes simples, vous pouvez transférer les messages du dossier de réception vers un programme Ruby. Cette solution est importante si vous souhaitez collecter ces messages dans un endroit séparé. Ozeki SMS Gateway vous permet de gérer les coûts des SMS et de suivre le trafic SMS.

Assurez-vous de continuer la lecture sur la page de tutoriel d'Ozeki où vous trouverez plus d'informations sur des sujets similaires, comme l'envoi de plusieurs SMS en Ruby.

La seule chose à faire maintenant est de télécharger Ozeki SMS Gateway et que le travail commence !