Comment envoyer un SMS depuis Ruby

La méthode la plus simple pour envoyer un 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 renverra une réponse HTTP 200 OK à votre requête.

comment envoyer un sms depuis ruby
Figure 1 - Comment envoyer un SMS depuis Ruby

Code Ruby pour envoyer un SMS vers un mobile

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

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 = "Hello world!"

api = MessageApi.new(configuration)

result = api.send(msg)

print(result)

Code 1 - SendSms.rb

Comment utiliser l'exemple Ruby pour SMS :

Cet exemple Ruby pour SMS peut être utilisé dans n'importe quelle application Ruby. Pour l'utiliser, vous devez télécharger la gemme ozeki_libs_rest. Après avoir téléchargé la gemme, vous devez ajouter une référence à celle-ci dans votre code source Ruby. Cela vous permettra d'utiliser les classes fournies par la gemme 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 SendSms.rb

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

Que contient le fichier SendSms.rb.zip ?

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

Figure 2 - Contenu de SendSms.rb.zip

Comment installer la gemme ozeki_libs_rest en utilisant le terminal Linux

gem install ozeki_libs_rest

Code 2 - Commande pour installer la gemme ozeki_libs_rest

Vidéo 1 - Comment installer la gemme ozeki_libs_rest (Tutoriel vidéo)

Comment envoyer un SMS depuis Ruby (Instructions simples)

Pour envoyer un SMS depuis Ruby :

  1. Installer un utilisateur HTTP API
  2. Activer "Log communication events" dans l'onglet Advanced
  3. Configurer Visual Studio
  4. Télécharger puis extraire le fichier SendSms.rb.zip
  5. Lancer l'application Ozeki SMS Gateway
  6. Exécuter le code Ruby SendSend.rb en utilisant l'invite de commande
  7. Vérifier les logs pour voir si le SMS a été envoyé

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

Pour pouvoir envoyer un 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 n'importe quel éditeur de texte, comme le Bloc-notes Windows. 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 HTTP SMS API. 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 un SMS depuis Ruby

Pour envoyer un SMS depuis Ruby, votre code 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 un 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 un 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 un SMS depuis Ruby

Pour soumettre le SMS, votre application Ruby enverra une requête HTTP similaire à celle ci-dessous. Notez que cette requête contient une partie en-tête HTTP et une partie corps HTTP. Le corps HTTP est une chaîne de données encodée en JSON. Elle contient le numéro du destinataire et le texte du message. 

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":	[]
		}
	]
}

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 la soumission du message. 

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 en attente de livraison.",
	"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"
	    }
	  ]
	}
}

Connecter votre passerelle SMS au réseau mobile et créer un compte utilisateur HTTP API

Nous supposons que vous avez déjà installé Ozeki SMS Gateway, et que vous avez connecté la passerelle au réseau mobile. Pour pouvoir envoyer un SMS vers un téléphone mobile depuis Ruby, vous devez configurer un compte utilisateur HTTP API dans Ozeki SMS Gateway.

Vidéo 2 - Comment configurer un compte utilisateur HTTP API (Tutoriel vidéo)

Comment envoyer un SMS depuis Ruby en utilisant l'API SMS C# (Tutoriel vidéo)

Cette vidéo vous montre comment télécharger le fichier SendSms.rb.zip depuis cette page. Si vous regardez la vidéo, vous remarquerez que le contenu de SendSms.rb.zip est placé sur le bureau Windows. Vous verrez également que nous utilisons l'invite de commande pour envoyer le SMS.

Exemple Ruby SMS : SendSms.rb

Le code exemple ci-dessous fait partie du fichier SendSms.rb.

Figure 3 - Fichier SendSms.rb

Comment vérifier que le SMS a été accepté par l'utilisateur HTTP

Après la soumission du SMS, il est conseillé de vérifier votre passerelle SMS, pour voir ce qu'elle a reçu. Vous pouvez vérifier les logs en ouvrant les détails de l'utilisateur HTTP depuis la console de gestion d'Ozeki SMS Gateway. La vidéo suivante vous montre ce qu'il faut rechercher.

Vidéo 4 - Comment envoyer un SMS avec le code Ruby ci-dessus (Tutoriel vidéo)

Comment vérifier que le SMS a été envoyé vers le réseau mobile

La dernière étape pour vérifier la procédure consiste à examiner les logs de la connexion au réseau mobile. Vous devrez peut-être activer les logs dans la configuration de la connexion avant d'envoyer le message pour voir les logs. Si les logs sont activés, vous verrez le numéro de téléphone et le texte du message que vous avez envoyé.

Vidéo 5 - Comment tester si la requête a été acceptée par le client SMPP (Tutoriel vidéo)

Vidéo 6 - À quoi ressemble la réception d'un SMS sur un téléphone mobile (Tutoriel vidéo)

More information