Comment recevoir des SMS depuis Python

La méthode la plus simple pour recevoir des SMS depuis Python est d'utiliser l'API HTTP/REST intégrée d'Ozeki SMS Gateway. Lorsque vous utilisez cette API, vous recevrez les messages SMS en envoyant une requête HTTP GET à la passerelle SMS. La réponse HTTP Post contiendra les messages formatés en JSON. La passerelle SMS enverra les messages SMS à l'application console Python, et elle renverra une réponse HTTP 200 OK à votre requête.

comment recevoir des sms depuis python
Figure 1 - Comment recevoir des SMS depuis Python

Code Python pour recevoir des SMS

L'exemple de code Python pour les SMS ci-dessous montre comment vous pouvez recevoir des SMS en utilisant l'API HTTP REST d'Ozeki SMS Gateway avec la bibliothèque Python ozekilibsrest. Cette bibliothèque vous est fournie gratuitement, et vous pouvez l'utiliser et la modifier dans n'importe lequel de vos projets.

ReceiveSms.py 

		from ozekilibsrest import Configuration, MessageApi
		
		configuration = Configuration(
		    username="http_user",
		    password="qwe123",
		    api_url="http://127.0.0.1:9509/api"
		)
		
		api = MessageApi(configuration)
		
		results = api.download_incoming()
		
		print(results)
		
		for result in results.messages:
			print(result)

Comment utiliser l'exemple Python pour les SMS :

Cet exemple Python pour les SMS peut être utilisé dans n'importe quelle application Python. Pour l'utiliser, vous devez installer le package ozekilibsrest avec la commande pip install ozekilibsrest. Une fois le package installé, vous devez ajouter la directive "from ozekilibsrest import Configuration, Message, MessageApi" dans l'en-tête de votre code source Python. Cela vous permettra d'utiliser les classes fournies par la bibliothèque ozekilibsrest. 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.py

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

Que contient le dossier ReceiveSms.py ?

Le dossier ReceiveSms.py contient le script de l'exemple Python pour les SMS qui vous montrera comment recevoir des messages SMS en utilisant Python.

répertoire receive sms py
Figure 2 - Contenu de ReceiveSms.py.zip

Comment installer la bibliothèque ozekilibsrest

Pour installer la bibliothèque ozekilibsrest, vous devez ouvrir l'invite de commande et utiliser la commande suivante. Cela installera la bibliothèque ozekilibsrest et les dépendances nécessaires. 

		pip install ozekilibsrest

Code 2 - Commande pour installer la bibliothèque ozekilibsrest

Comment recevoir des SMS depuis Python (étapes rapides)

Pour recevoir des SMS depuis Python :

  1. Téléchargez et installez Python
  2. Installez la bibliothèque ozekilibsrest en utilisant pip ou conda
  3. Téléchargez le fichier ReceiveSms.py.zip
  4. Extrayez le fichier .zip depuis le dossier Téléchargements
  5. Ouvrez le fichier ReceiveSms.py dans un éditeur de texte
  6. Lancez Ozeki SMS Gateway
  7. Créez un utilisateur HTTP API dans Ozeki
  8. Exécutez le code ReceiveSms.py en utilisant l'invite de commande pour envoyer les SMS de test
  9. 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 Python, 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 Python. 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 Python.

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

Pour envoyer des SMS depuis Python, votre code Python devra envoyer une requête HTTP à 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 Python pour les 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 Python

Pour authentifier le client Python pour les SMS, 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 d'utilisateur+":"+mot de passe). En Python, vous pouvez utiliser le code suivant pour effectuer cet encodage : 

	    def create_authorization_header(username, password):
	        username_password = f'{ username }:{ password }'
	        return f'Basic { b64encode(username_password.encode()).decode() }'

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==.

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

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 Python

Pour soumettre les messages SMS, votre application Python enverra une requête HTTP similaire à celle ci-dessous. Notez que cette requête contient une partie en-tête HTTP, dans laquelle nous avons défini le dossier à partir duquel nous voulons télécharger les messages, ainsi que l'action. Nous avons également envoyé le nom d'utilisateur et le mot de passe encodés en base64 pour authentifier la requête. 

GET /api?action=receivemsg&folder=inbox HTTP/1.1
Host: 127.0.0.1:9509
User-Agent: python-requests/2.26.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==

Réponse HTTP reçue par l'exemple Python pour les 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 d'état 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
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf8
Last-Modified: Fri, 17 Sep 2021 08:36:07 GMT
Server: 10/10.3.124 Microsoft-HTTPAPI/2.0
User-Agent: OZEKI 10.3.124 (www.myozeki.com)
Access-Control-Allow-Origin: *
Date: Fri, 17 Sep 2021 07:08:11 GMT

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "",
  "data": {
    "folder": "inbox",
    "limit": "1000",
    "data": [
      {
        "message_id": "31bc2fe0-c2a6-4ebe-afcd-6bcd9ea341fb",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 1!",
        "create_date": "2021-09-17 09:07:14",
        "valid_until": "2021-09-24 09:07:14",
        "time_to_send": "2021-09-17 09:07:14",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      },
      {
        "message_id": "b7b8d592-e182-4e96-a375-b4a6aa73e483",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 2!",
        "create_date": "2021-09-17 09:07:23",
        "valid_until": "2021-09-24 09:07:23",
        "time_to_send": "2021-09-17 09:07:23",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      },
      {
        "message_id": "b0308970-a3c9-45c4-bf97-14a914a66f57",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 3!",
        "create_date": "2021-09-17 09:07:33",
        "valid_until": "2021-09-24 09:07:33",
        "time_to_send": "2021-09-17 09:07:33",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      }
    ]
  }
}

Exemple Python pour les SMS : ReceiveSms.py

Comment télécharger le projet ReceiveSMS.py (Tutoriel vidéo)

Dans la vidéo suivante, vous apprendrez comment utiliser le projet Python ReceiveSms.py. La vidéo commencera par la page de téléchargement et vous guidera jusqu'au panneau de l'éditeur de code ouvert. Vous apprendrez comment télécharger et ouvrir le fichier de code. La vidéo ne dure que 54 secondes mais elle contient toutes les informations nécessaires pour utiliser correctement le fichier d'exemple.

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

L'exemple de code ci-dessous fait partie du dossier ReceiveSms.py.zip.

Figure 3 - ReceiveSms.py

Comment utiliser le projet (Tutoriel vidéo)

Dans le clip suivant, vous verrez comment lancer le code Python ReceiveSms.py. La vidéo commencera avec le code ouvert et vous guidera jusqu'à l'onglet des événements avec le log du message envoyé. Vous verrez comment lancer le code et ce qui se passe si le code est exécuté. La vidéo dure un peu moins d'une minute, mais elle contient toutes les informations nécessaires pour exécuter le projet.

Vidéo 2 - Comment utiliser le script ReceiveSms.py (Tutoriel vidéo)

Conclusion

Cet article a montré les étapes pour recevoir des SMS en une seule requête depuis Python.

Avec ces connaissances et les outils fournis, vous devriez être capable de contacter plusieurs clients avec un seul code. Ozeki SMS Gateway joue un rôle important dans ce processus car ce programme organise la livraison des messages. Ozeki SMS Gateway fonctionne avec une qualité et une performance élevées, vous permettant d'envoyer jusqu'à 1000 SMS par seconde.

Poursuivez votre apprentissage sur les pages de tutoriels d'Ozeki, où vous pouvez lire sur des sujets comme supprimer des SMS en Python.

Maintenant, la seule chose à faire est de télécharger Ozeki SMS Gateway et de commencer à travailler !

More information