Comment supprimer un SMS en Ruby

La méthode la plus simple pour supprimer des messages SMS depuis Ruby est d'utiliser l'API HTTP/REST SMS 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 supprimer un sms en ruby
Figure 1 - Comment supprimer un SMS en Ruby

Code Ruby pour supprimer des messages SMS

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

DeleteSms.rb 
require 'ozeki_libs_rest'

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

msg = Message.new
msg.id = "f53efb1a-8ff6-4e62-97c3-2c1e81964b9d"

api = MessageApi.new(configuration)

result = api.delete(Folder.new.inbox, msg)

print(result)
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 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 DeleteSms.rb

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

Que contient le fichier DeleteSms.rb.zip ?

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

Figure 2 - Contenu de DeleteSms.rb.zip

Comment supprimer un SMS en Ruby (étapes rapides)

Pour supprimer un SMS en Ruby :

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

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

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 graphique d'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 des SMS depuis Ruby

Pour envoyer des 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 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 type de contenu et un en-tête d'autorisation. 

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

Requête HTTP pour envoyer des SMS depuis Ruby

Pour supprimer un message, 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. La partie corps contient les identifiants SMS encodés en JSON. 

POST /api?action=deletemsg HTTP/1.1
Content-Length: 73
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

{	
	"folder":	"inbox",
	"message_ids":	[
		"8ddff323-a0e1-474f-b4b1-58d7fed30009"
	]
}

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 demande d'envoi de 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. 

User-Agent: OZEKI 10.3.123 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Tue, 06 Jul 2021 15:58:36 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "",
	"data": {
	  "folder": "inbox",
	  "message_ids": [
	    "8ddff323-a0e1-474f-b4b1-58d7fed30009"
	  ]
	}
}

Exemple Ruby SMS : DeleteSms.rb

Dans la vidéo suivante, vous verrez comment télécharger le fichier exemple. Cette vidéo de 36 secondes est très détaillée et montrera chaque étape importante que vous devez suivre pour avoir le fichier projet sur votre ordinateur. Vous n'aurez aucun problème à suivre les étapes.

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

Le code exemple

Le code exemple ci-dessous fait partie du fichier DeleteSms.rb. Ce code Ruby supprimera le message dont l'ID est stocké dans la variable msg.id (Figure 3). Vous pouvez modifier la variable pour que le code supprime un autre message. Si vous êtes familier avec le langage de programmation Ruby, n'hésitez pas à modifier le code à votre guise.

Figure 3 - Fichier DeleteSms.rb

Comment utiliser le projet exemple (Tutoriel vidéo)

Dans cette vidéo, nous allons vous montrer comment exécuter un projet qui supprime un message choisi. Elle commencera par le lancement d'Ozeki SMS Gateway et se terminera par le dossier Boîte de réception vide d'où le message a été supprimé. Cette vidéo de 1:12 explique tout ce que vous devez faire pour lancer le projet. Nous utilisons Ozeki SMS Gateway qui offre une interface utilisateur très intuitive pour que vous n'ayez aucun problème à suivre les étapes.

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

Résumé

L'article ci-dessus a montré les étapes de la suppression de SMS en Ruby avec l'aide d'Ozeki SMS Gateway. Maintenir un stockage équilibré et une boîte de réception fréquemment nettoyée est important si vous travaillez régulièrement avec des SMS. Cette solution est un excellent exemple de la facilité avec laquelle Ozeki SMS Gateway peut être géré avec des codes Ruby. Il faut également mentionner qu'Ozeki SMS Gateway vous permet de journaliser les messages SMS dans une base de données et offre de nombreuses capacités de reporting pour fournir plus d'informations sur la connexion SMS.

Ne terminez pas vos études ici, visitez la page de tutoriels d'Ozeki et lisez-en plus sur des sujets 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 !

More information