Como Excluir 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. Quando você usa essa API, enviará mensagens SMS fazendo uma solicitação HTTP Post para o gateway de SMS. A solicitação HTTP Post conterá uma mensagem formatada em formato json. O gateway de SMS enviará esse SMS para o telefone do destinatário e retornará uma resposta HTTP 200 OK para sua solicitação.

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

Código JavaScript para excluir mensagens SMS

O exemplo de código JavaScript para SMS abaixo demonstra como você pode excluir SMS usando a API de SMS 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 de seus projetos.

DeleteSms.mjs
import { Configuration, Folder, 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 msg = new Message();
msg.ID = "49c4bec8-348b-42c4-ba56-dee741bc3160";

var api = new MessageApi(configuration);

const result = await api.Delete(Folder.Inbox, msg);

console.log(result);
	

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 por meio de uma conexão wireless ou pela Internet.

Baixar DeleteSms.js

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

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

O arquivo DeleteSms.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 DeleteSms.mjs no projeto, que contém o código de exemplo para mostrar como excluir mensagens SMS. Este código de exemplo está listado abaixo.

exemplo de projeto para excluir sms usando node js
Figura 2 - Diretório DeleteSms.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 Excluir Mensagens SMS do Node.Js (Passos Rápidos)

Para excluir 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 a partir da GUI do Ozeki
  4. Crie um usuário de API de SMS HTTP
  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 Delete() para excluir 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 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 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 a partir da GUI 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 de SMS HTTP. Crie um usuário com o nome de usuário "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 receber SMS do Node.Js

Para receber um SMS do Node.Js, seu JavaScript terá que fazer uma solicitaçã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 de SMS JavaScript 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 a partir do JavaScript

Para autenticar o cliente de SMS Node.Js, você precisa enviar o nome de usuário e senha em uma string codificada em base64 para o servidor em uma solicitaçã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.

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

{
	"folder":	"inbox",
	"message_ids":	[
		"9bd34eb0-244b-4b8e-8115-1f05b3b1ac19"
	]
}
	

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",
	  "message_ids": [
	    "9bd34eb0-244b-4b8e-8115-1f05b3b1ac19"
	  ]
	}
}
	

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

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

Na figura a seguir, você pode ver o código-fonte do projeto Node.js 'DeleteSMS.mjs' (Figura 3). Como você pode ver, usamos o Notepad para abrir o código. Você também pode usá-lo para editá-lo. Altere o valor da variável msg.ID e exclua qualquer mensagem que desejar.

exemplo de javascript para excluir mensagens sms
Figura 3 - DeleteSms.mjs no Notepad

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

Se você deseja usar uma IDE que ofereça coloração de código, documentação útil e extensões, use o Visual Studio Code. É um ambiente de programação leve e gratuito que você pode começar a usar agora. Altere o valor da variável msg.ID e exclua qualquer mensagem que desejar.

exemplo de javascript para excluir mensagens sms
Figura 4 - DeleteSms.mjs no Visual Studio Code

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

Depois que a requisição for enviada, é uma boa ideia verificar seu gateway SMS, para ver o que ele recebeu. 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 excluir mensagens SMS com o código JavaScript acima (Tutorial em vídeo)

Para resumir

Este artigo mostra como usar o código de exemplo Node.js mencionado para excluir mensagens SMS com o usuário HTTP do Ozeki SMS Gateway. Se você recebe muitas mensagens SMS diariamente e várias delas são indesejadas ou as informações que contêm expiram rapidamente, o método mostrado aqui é essencial para você. Um armazenamento bem organizado e completamente limpo para suas mensagens é muito importante para um trabalho eficiente.

Continue lendo tópicos como este na página da Ozeki, você encontrará muitos outros artigos. Confira mais sobre a API de SMS em nosso repositório GitHub, aprenda sobre o uso no guia Github: API de SMS em Node.js.

Mude para melhor, baixe o Ozeki SMS Gateway agora!

More information