Como enviar SMS a partir do Node.js

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

como enviar sms a partir do node js
Figura 1 - Como enviar SMS a partir do Node.js

Código JavaScript para enviar SMS para celular

O exemplo de código JavaScript para SMS abaixo demonstra como você pode enviar SMS utilizando a API REST HTTP 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.

SendSms.mjs
import { Configuration, Message, 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);

var msg = new Message();
msg.ToAddress = "+36201111111";
msg.Text = "Olá mundo!";

const result = await api.Send(msg);

console.log(result.toString());
	

Como usar o exemplo de SMS em JavaScript:

Você pode usar a classe Message para criar o SMS e 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 SendSms.js

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

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

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

exemplo de projeto para enviar sms usando node js
Figura 2 - Diretório SendSms.js

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

npm install node-fetch
	

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

. Como enviar SMS a partir do Node.js (Passos rápidos)

Para enviar SMS a partir do Node.js:

  1. Instale o Ozeki SMS Gateway
  2. Conecte o Ozeki SMS Gateway à rede móvel
  3. Envie um SMS teste a partir da interface do Ozeki
  4. Crie um usuário de API HTTP para SMS
  5. Visual Studio Code ou Bloco de Notas do Windows
  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 Send para enviar sua mensagem
  10. Leia a mensagem de resposta 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 a partir 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 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 teste a partir da interface 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.

Após a configuração do ambiente, você pode executar seu código JavaScript.

URL da API HTTP para enviar SMS a partir do Node.js

Para enviar SMS a partir 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á rodando, 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 a partir do JavaScript

Para autenticar o cliente de SMS em 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 esta 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 do 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==
	

Solicitação HTTP para enviar SMS a partir do Node.Js

Para enviar o SMS, sua aplicação Node.Js enviará uma solicitação HTTP semelhante à mostrada abaixo. Observe que esta solicitaçã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.

POST /api?action=sendmsg HTTP/1.1
Connection: close
Content-Length: 319
Content-Type: application/json
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)
  
{
	"messages":	[
		{
			"message_id":	"faac3935-8358-d465-835c-0919186ddf7b",
			"to_address":	"+36201111111","text":"Hello world!",
			"create_date":	"2021-06-14T11:47:05",
			"vaild_date":	"2021-06-21T11:47:05",
			"time_to_send":	"2021-06-14T11:47:05",
			"submit_report_requested":	true,
			"delivery_report_requested":	true,
			"view_report_requested":	true
		}
	]
}
	

Resposta HTTP recebida pelo exemplo de SMS em JavaScript

Assim que o gateway SMS receber esta solicitação, ele gerará uma resposta HTTP. A resposta HTTP conterá um código de status, para indicar se o envio do SMS foi bem-sucedido 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": "Messages queued for delivery.",
	"data": {
	  "total_count": 1,
	  "success_count": 1,
	  "failed_count": 0,
	  "messages": [
	    {
	      "message_id": "faac3935-8358-d465-835c-0919186ddf7b",
	      "from_station": "%",
	      "to_address": "+36201111111",
	      "to_station": "%",
	      "text": "Hello world!",
	      "create_date": "2021-06-14 11:47:05",
	      "valid_until": "2021-06-21 11:47:05",
	      "time_to_send": "2021-06-14 11:47:05",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ],
	      "status": "SUCCESS"
	    }
	  ]
	}
}
	

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

Este vídeo mostra como baixar e usar o projeto SendSms.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: SendSms.mjs (no Notepad)

Nesta imagem, você pode encontrar o código-fonte do projeto, aberto no Notepad (Figura 3). Como você pode ver, ele pode ser aberto no Notepad e também pode ser editado nele. Se você estiver familiarizado com Node.js, sinta-se à vontade para alterar as variáveis no código e enviar uma mensagem personalizada para um endereço seu.

exemplo de javascript para enviar sms
Figura 3 - SendSms.mjs no Notepad

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

Se você está procurando uma maneira mais sofisticada de abrir o código-fonte, experimente usar o Visual Studio Code (Figura 4). Ele oferece coloração de código, mais ajuda e auto-completar. É um IDE (Ambiente de Desenvolvimento Integrado) leve, de código aberto e gratuito.

Figura 4 - SendSms.mjs no Visual Studio Code

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

Depois que o SMS for enviado, é 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 procurar.

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

Como verificar se o SMS foi enviado para a rede móvel

O passo final para verificar o procedimento é dar uma olhada nos logs da conexão com a rede móvel. Você pode precisar ativar o registro na configuração da conexão antes de enviar a mensagem para ver os logs. Se o registro estiver ativado, você verá o número de telefone e o texto da mensagem que você enviou.

Vídeo 3 - Como ativar o registro no Ozeki SMS Gateway (Tutorial em vídeo)

Para ativar o registro no http_user, você deve seguir as mesmas instruções.

Conclusão

Este guia oferece todas as informações necessárias sobre como enviar mensagens SMS a partir do Node.js com o usuário HTTP do Ozeki SMS Gateway. Você precisa configurar uma conexão de usuário HTTP no Ozeki SMS Gateway e usar o programa fornecido para sua aplicação Node.js, é assim que esta solução oferece uma conexão muito confiável e mensagens rápidas. Usar este serviço ajuda a tornar o trabalho mais fluido, pois permite remodelar o ambiente de trabalho de acordo com as necessidades dos seus funcionários e suas.

Você encontra mais artigos para ajudá-lo no site da Ozeki, então não deixe de continuar lendo. Em seguida, aprenda Como enviar vários SMS a partir do Node.js.

Baixe o Ozeki SMS Gateway! É simples de configurar, faça isso agora!

More information