Como Receber um SMS em Node.js

A maneira mais simples de enviar SMS a partir do Node.Js é usar a API HTTP/Rest de SMS integrada do Ozeki SMS Gateway. Ao usar esta API, você enviará mensagens SMS fazendo uma requisição HTTP Post para o gateway de SMS. A requisição HTTP Post conterá uma mensagem formatada em json. O gateway de SMS enviará este SMS para o telefone do destinatário e retornará uma resposta HTTP 200 OK para a sua requisição.

como receber mensagens sms usando node js
Figura 1 - Como receber SMS do Node.Js

Código JavaScript para receber mensagens SMS

O exemplo de código JavaScript para SMS abaixo demonstra como você pode receber SMS usando a API HTTP Rest de SMS do Ozeki SMS Gateway com a biblioteca JavaScript Ozeki.Libs.Rest. Esta biblioteca é fornecida gratuitamente e você pode usá-la e modificá-la em qualquer um dos seus projetos.

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());
}

Como usar o exemplo de SMS em JavaScript:

Você pode usar a classe Message para criar o SMS e pode usar a classe MessageApi para enviar o SMS para o gateway de SMS. O gateway de SMS encaminhará sua mensagem para a rede móvel através de uma conexão sem fio ou pela Internet.

Baixar ReceiveSms.js

O código-fonte explicado neste artigo pode ser baixado, usado e modificado gratuitamente.
Download: ReceiveSms.js.zip (4.38Kb)

O que está no arquivo ReceiveSms.js.zip?

O arquivo ReceiveSms.js.zip contém a biblioteca Ozeki.Libs.Rest, que fornece todas as ferramentas necessárias para enviar, marcar, excluir e receber mensagens SMS. Você também encontrará um arquivo ReceiveSms.mjs no projeto, que contém o código de exemplo para mostrar como receber mensagens SMS. Este código de exemplo está listado abaixo.

exemplo de projeto para receber sms usando node js
Figura 2 - Diretório ReceiveSms.js

Este projeto tem dependências, então antes de começar você deve instalar o pacote node-fetch com o seguinte comando: 

npm install node-fetch

Código 1 - Comando para instalar o pacote node-fetch

. Como Receber Mensagens SMS do Node.Js (Passos rápidos)

Para receber mensagens SMS do Node.Js:

  1. Instale o Ozeki SMS Gateway
  2. Conecte o Ozeki SMS Gateway à rede móvel
  3. Envie um SMS de teste da interface gráfica do Ozeki
  4. Crie um usuário de API HTTP para SMS
  5. Apache NetBeans
  6. Baixe o projeto de exemplo acima
  7. Crie o SMS criando um novo objeto Message
  8. Crie uma API para enviar sua mensagem
  9. Use o método DownloadIncoming() para receber sua(s) mensagem(ns)
  10. Leia a mensagem de resposta no console e imprima as mensagens no console
  11. Verifique os logs no gateway de SMS
Instale o Ozeki SMS Gateway e crie um usuário de API HTTP

Para poder enviar SMS do Node.Js, primeiro você precisa instalar o Ozeki SMS Gateway. O gateway de SMS pode ser instalado no mesmo computador onde você desenvolve seu código JavaScript no Visual Studio Code ou em qualquer outro editor de código. Após a instalação, o próximo passo é conectar o Ozeki SMS Gateway à rede móvel. Você pode enviar um SMS de teste da interface gráfica do Ozeki para verificar se sua conexão com a rede móvel está funcionando. O passo final para preparar seu ambiente é criar um usuário de API HTTP para SMS. Crie um usuário com o nome "http_user" e senha "qwe123" para fazer o exemplo funcionar sem modificações.

Depois que o ambiente estiver configurado, você pode executar seu código JavaScript.

URL da API HTTP para receber SMS do Node.Js

Para receber um SMS do Node.Js, seu JavaScript terá que fazer uma requisição HTTP para o gateway de SMS. A URL da API é mostrada abaixo. Observe que o endereço IP (127.0.0.1) deve ser substituído pelo endereço IP do seu gateway de SMS. Se o Ozeki SMS Gateway estiver instalado no mesmo computador onde o aplicativo JavaScript de SMS está sendo executado, pode ser 127.0.0.1. Se estiver instalado em um computador diferente, deve ser o endereço IP desse computador. 

http://127.0.0.1:9509/api?action=rest
Autenticação HTTP para enviar SMS do JavaScript

Para autenticar o cliente de SMS do Node.Js, você precisa enviar o nome de usuário e senha em uma string codificada em base64 para o servidor em uma requisição HTTP. O formato usado é: base64(nome de usuário+":"+senha). Em JavaScript, você pode usar o seguinte código para fazer essa codificação: 

var usernamePassword = username + ":" + password;
return `Basic ${Base64.encode(usernamePassword)}`;

Por exemplo, se você codificar o nome de usuário 'http_user' e a senha 'qwe123', você obterá a seguinte string codificada em base64: aHR0cF91c2VyOnF3ZTEyMw==. Para enviar

Cabeçalho da requisição HTTP para enviar SMS a partir de JavaScript

Para enviar as mensagens SMS, você precisa incluir as seguintes linhas como cabeçalhos na requisição HTTP. Observe que incluímos um tipo de conteúdo e um cabeçalho de Autorização. 

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

Requisição HTTP para enviar SMS a partir de Node.Js

Para enviar o SMS, sua aplicação Node.Js enviará uma requisição HTTP semelhante à mostrada abaixo. Observe que esta requisição contém uma parte de cabeçalho HTTP e uma parte de corpo HTTP. O corpo HTTP é uma string de dados codificada em JSON. Ela contém o número do destinatário e o texto da mensagem. 

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)

Resposta HTTP recebida pelo exemplo de SMS em JavaScript

Assim que o gateway SMS receber esta requisição, ele gerará uma resposta HTTP. A resposta HTTP conterá um código de status, para indicar se a requisição de envio de SMS foi bem-sucedida ou não. Ela também retornará uma estrutura codificada em JSON para fornecer detalhes úteis sobre o envio da mensagem. 

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

Como receber SMS a partir de Node.Js usando a API de SMS (Tutorial em vídeo)

Este vídeo mostra como baixar e usar o projeto ReceiveSms.js. Depois de adicionar os arquivos necessários ao seu projeto, você pode notar que há um arquivo chamado Ozeki.Lbis.Rest.js. Este é o arquivo que contém a MessageApi e tudo o que você precisa para enviar um SMS usando JavaScript.

Vídeo 1 - Como baixar Ozeki.Libs.Rest e configurar seu projeto (Tutorial em vídeo)

Exemplo de SMS em Node.Js: ReceiveSms.mjs (no Notepad)

Na imagem a seguir, você pode ver o código-fonte do ReceiveSMS.mjs aberto (Figura 3). Neste caso, usamos o Notepad para abrir o código-fonte, que também pode ser usado para editá-lo. Como você pode ver, o código contém variáveis pré-definidas de nome de usuário e senha. Se você estiver familiarizado com a linguagem de programação Node.js, sinta-se à vontade para alterar os valores das variáveis para corresponder às suas credenciais de login HTTP.

exemplo de javascript para receber mensagens sms
Figura 3 - ReceiveSms.mjs no Notepad

Exemplo de SMS em Node.Js: ReceiveSms.mjs (no Visual Studio Code)

Se você quiser usar uma IDE com colorização de código integrada, documentação útil e extensões, use o Visual Studio Code. É um ambiente de programação leve e gratuito que você pode usar para editar código em várias linguagens. Como você pode ver, codificamos o exemplo de nome de usuário e senha no código-fonte. Se você estiver familiarizado com a linguagem de programação Node.js, sinta-se à vontade para editá-los para corresponder ao seu usuário HTTP.

exemplo de javascript para receber mensagens sms
Figura 4 - ReceiveSms.mjs no Visual Studio Code

Como verificar se o SMS foi aceito pelo usuário HTTP

Depois que a solicitação for enviada, é uma boa ideia verificar seu gateway SMS, para ver o que foi recebido. Você pode verificar o log abrindo os detalhes do usuário HTTP no console de gerenciamento do Ozeki SMS Gateway. O vídeo a seguir mostra o que você deve procurar.

Vídeo 2 - Como receber mensagens SMS com o código JavaScript acima (Tutorial em vídeo)

Resumo

O guia explicou como configurar esta API SMS para receber SMS com o programa Node.js usando o usuário HTTP do Ozeki SMS Gateway. Esta solução ajuda você a organizar suas mensagens recebidas, movendo-as da pasta Inbox para seu aplicativo Node.js. Aplicar este programa dá a você a capacidade de manter seu sistema de mensagens organizado e deixar as informações importantes fluírem até você.

Aposto que você quer aprender mais sobre o gerenciamento eficiente de mensagens, você encontrará o que precisa na página da Ozeki. Ajuda muito se você classificar as mensagens e manter apenas o que precisa, então leia o próximo artigo sobre Como excluir um SMS em Node.js.

Configure o Ozeki SMS Gateway agora e use o que você tem!

More information