Comment recevoir un SMS en Node.js
La manière la plus simple d'envoyer des SMS depuis Node.js 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.
Code JavaScript pour recevoir des messages SMS
L'exemple de code JavaScript pour les SMS ci-dessous montre comment vous pouvez recevoir des SMS en utilisant l'API SMS HTTP Rest d'Ozeki SMS Gateway avec la bibliothèque JavaScript Ozeki.Libs.Rest. Cette bibliothèque vous est fournie gratuitement, et vous pouvez l'utiliser et la modifier dans tous vos projets.
ReceiveSms.mjs
import { Configuration, MessageApi } from './Ozeki.Libs.Rest.js';
var configuration = new Configuration();
configuration.Username = "http_user";
configuration.Password = "qwe123";
configuration.ApiUrl = "http://127.0.0.1:9509/api";
var api = new MessageApi(configuration);
const result = await api.DownloadIncoming();
console.log(result.toString());
for (let i = 0; i < result.MessageCount; i++) {
console.log(result.Messages[i].toString());
}
Comment utiliser l'exemple JavaScript pour les SMS :
Vous pouvez utiliser la classe Message pour créer le SMS et 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.js
Le code source expliqué dans cet article peut être téléchargé, utilisé et modifié gratuitement.
Télécharger : ReceiveSms.js.zip (4.38 Ko)
Que contient le fichier ReceiveSms.js.zip ?
Le fichier ReceiveSms.js.zip contient la bibliothèque Ozeki.Libs.Rest, qui vous fournit tous les outils nécessaires pour envoyer, marquer, supprimer et recevoir des messages SMS. Vous trouverez également un fichier ReceiveSms.mjs dans le projet, qui contient le code exemple pour vous montrer comment recevoir des messages SMS. Ce code exemple est listé ci-dessous.
Ce projet a des dépendances, donc avant de commencer, vous devez installer le package node-fetch avec la commande suivante :
npm install node-fetch
Comment recevoir des messages SMS depuis Node.js (étapes rapides)
Pour recevoir des messages SMS depuis Node.js :
- Installez Ozeki SMS Gateway
- Connectez Ozeki SMS Gateway au réseau mobile
- Envoyez un SMS test depuis l'interface Ozeki
- Créez un utilisateur API SMS HTTP
- Apache NetBeans
- Téléchargez l'exemple de projet ci-dessus
- Créez le SMS en créant un nouvel objet Message
- Créez une API pour envoyer votre message
- Utilisez la méthode DownloadIncoming() pour recevoir votre/vos message(s)
- Lisez le message de réponse sur la console et affichez les messages sur la console
- Vérifiez les logs dans la passerelle SMS
Installez Ozeki SMS Gateway et créez un utilisateur API HTTP
Pour pouvoir envoyer des SMS depuis Node.js, 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 JavaScript dans Visual Studio Code ou tout autre éditeur de code. 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 JavaScript.
URL de l'API HTTP pour recevoir des SMS depuis Node.js
Pour recevoir un SMS depuis Node.js, votre JavaScript 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 JavaScript 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 JavaScript
Pour authentifier le client SMS Node.js, 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 JavaScript, vous pouvez utiliser le code suivant pour effectuer cet encodage :
var usernamePassword = username + ":" + password;
return `Basic ${Base64.encode(usernamePassword)}`;
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 JavaScript
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 Node.js
Pour soumettre le SMS, votre application Node.js 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. Il contient le numéro du destinataire et le texte du message.
GET /api?action=receivemsg&folder=inbox HTTP/1.1 Connection: close Accept: */* Accept-Encoding: gzip,deflate Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw== Host: 127.0.0.1:9509 User-Agent: node-fetch/1.0 (+https://github.com/bitinn/node-fetch)
Réponse HTTP reçue par l'exemple JavaScript 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 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.120 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Mon, 14 Jun 2021 09:12:00 GMT
Server: 10/10.3.120
Transfer-Encoding: chunked
{
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "",
"data": {
"folder": "inbox",
"limit": "1000",
"data": [
{
"message_id": "02ccc4d5-4aeb-7f64-b980-9aa262ef86fb",
"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-06-14 12:00:14",
"valid_until": "2021-06-21 12:00:14",
"time_to_send": "2021-06-14 12:00:14",
"submit_report_requested": true,
"delivery_report_requested": true,
"view_report_requested": true,
"tags": [
{
"name": "Type",
"value": "SMS:TEXT"
}
]
},
{
"message_id": "bb663f6c-fcf2-df32-bd33-1778e8578f23",
"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-06-14 12:00:14",
"valid_until": "2021-06-21 12:00:14",
"time_to_send": "2021-06-14 12:00:14",
"submit_report_requested": true,
"delivery_report_requested": true,
"view_report_requested": true,
"tags": [
{
"name": "Type",
"value": "SMS:TEXT"
}
]
},
{
"message_id": "ca555a52-2f5a-285a-b6e2-6aa1fa3353f8",
"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-06-14 12:00:14",
"valid_until": "2021-06-21 12:00:14",
"time_to_send": "2021-06-14 12:00:14",
"submit_report_requested": true,
"delivery_report_requested": true,
"view_report_requested": true,
"tags": [
{
"name": "Type",
"value": "SMS:TEXT"
}
]
}
]
}
}
Comment recevoir des SMS depuis Node.js en utilisant l'API SMS (Tutoriel vidéo)
Cette vidéo vous montre comment télécharger et utiliser le projet ReceiveSms.js. Une fois que vous avez ajouté les fichiers nécessaires à votre projet, vous remarquerez peut-être qu'il y a un fichier appelé Ozeki.Lbis.Rest.js. C'est le fichier qui contient MessageApi et tout ce dont vous avez besoin pour envoyer un SMS en JavaScript.
Exemple Node.js pour les SMS : ReceiveSms.mjs (dans Notepad)
Sur l'image suivante, vous pouvez voir le code source de ReceiveSMS.mjs ouvert (Figure 3). Dans ce cas, nous avons utilisé Notepad pour ouvrir le code source, qui peut également être utilisé pour le modifier. Comme vous pouvez le voir, le code contient des variables prédéfinies pour le nom d'utilisateur et le mot de passe. Si vous êtes familier avec le langage de programmation Node.js, n'hésitez pas à modifier les valeurs des variables pour correspondre à vos identifiants HTTP.
Exemple Node.js pour les SMS : ReceiveSms.mjs (dans Visual Studio Code)
Si vous souhaitez utiliser un IDE avec coloration syntaxique intégrée, une documentation utile et des extensions, utilisez Visual Studio Code. C'est un environnement de programmation léger et gratuit que vous pouvez utiliser pour éditer du code dans de nombreux langages différents. Comme vous pouvez le voir, nous avons codé l'exemple de nom d'utilisateur et de mot de passe dans le code source. Si vous êtes familier avec le langage de programmation Node.js, n'hésitez pas à les modifier pour correspondre à votre utilisateur HTTP.
Comment vérifier que le SMS a été accepté par l'utilisateur HTTP
Après que la requête a été soumise, il est bon 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.
Résumé
Ce guide explique comment configurer cette API SMS pour recevoir des SMS avec le programme Node.js en utilisant l'utilisateur HTTP d'Ozeki SMS Gateway. Cette solution vous aide à organiser vos messages entrants en les déplaçant du dossier Inbox vers votre application Node.js. L'application de ce programme vous donne la possibilité de garder votre système de messagerie organisé et de laisser les informations importantes vous parvenir.
Je parie que vous souhaitez en savoir plus sur la gestion efficace des messages, vous trouverez ce dont vous avez besoin sur la page web d'Ozeki. Cela aide beaucoup si vous triez les messages et ne gardez que ce dont vous avez besoin, alors lisez le prochain article sur Comment supprimer un SMS en Node.js.
Configurez Ozeki SMS Gateway maintenant et utilisez ce que vous avez obtenu !
More information
- Envoyer un SMS en Node.js avec l'API REST HTTP (exemple de code)
- Envoyer plusieurs SMS en Node.js avec l'API REST HTTP (exemple de code)
- Planifier un SMS en Node.js avec l'API REST HTTP (exemple de code)
- Recevoir un SMS en Node.js avec l'API REST HTTP (exemple de code)
- Supprimer un SMS en Node.js avec l'API REST HTTP (exemple de code)
- API SMS Node.js sur Github
- Tutoriel Node.js Hello world