Como agendar um SMS em Ruby

A maneira mais simples de enviar um SMS agendado a partir de Ruby é usar a API HTTP/Rest de SMS integrada do Ozeki SMS Gateway. Ao usar essa API, você enviará mensagens SMS enviando 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 agendar um sms em ruby
Figura 1 - Como agendar um SMS em Ruby

Código Ruby para enviar SMS agendado para celular

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

SendScheduledSms.rb 
require 'ozeki_libs_rest'

configuration = Configuration.new(
    "http_user",
    "qwe123",
    "http://127.0.0.1:9509/api"
);

msg = Message.new
msg.to_address = "+36201111111"
msg.text = "Olá mundo!"
msg.time_to_send = DateTime.parse('2021-07-06T013:00:00')

api = MessageApi.new(configuration)

result = api.send(msg)

print(result)

Como usar o exemplo de SMS em Ruby:

Este exemplo de SMS em Ruby pode ser usado em qualquer aplicação Ruby. Para usá-lo, você deve baixar a gem ozeki_libs_rest. Após o download da gem, você precisa adicionar uma referência a ela em seu código-fonte Ruby. Isso permitirá que você use as classes fornecidas pela gem ozeki_libs_rest. Você pode usar a classe Message para criar o SMS. Você 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 sem fio ou pela Internet.

Baixar SendScheduledSms.rb

O código-fonte explicado neste artigo pode ser baixado, usado e modificado gratuitamente.
Download: SendScheduledSms.rb.zip (373B)

O que está no arquivo SendScheduledSms.rb.zip?

O SendScheduledSms.rb.zip contém o arquivo SendScheduledSms.rb, que contém o código de exemplo para mostrar como enviar um SMS. Este código de exemplo está listado abaixo.

Figura 2 - O que está dentro de SendScheduledSms.rb.zip

Como enviar um SMS agendado a partir de Ruby (Passos rápidos)

Para enviar um SMS agendado a partir de Ruby:

  1. Baixe o arquivo SendScheduledSms.rb.zip
  2. Extraia o arquivo .zip da pasta Downloads
  3. Abra o arquivo SendScheduledSms.rb em qualquer editor de texto como o Bloco de Notas do Windows
  4. Inicie o Ozeki SMS Gateway
  5. Crie um usuário de API HTTP no Ozeki
  6. Execute o código Ruby SendScheduledSms.rb usando o prompt de comando
  7. Verifique a caixa Enviados no Ozeki SMS Gateway
Instale o Ozeki SMS Gateway e crie um usuário de API HTTP

Para poder enviar SMS a partir de Ruby, primeiro você precisa instalar o Ozeki SMS Gateway. O gateway de SMS pode ser instalado no mesmo computador onde você desenvolve seu código Ruby no Visual Studio. 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 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 Ruby.

URL da API HTTP para enviar SMS a partir de Ruby

Para enviar SMS a partir de Ruby, seu Ruby terá que enviar 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 Ruby 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 a partir de Ruby

Para autenticar o cliente de SMS em Ruby, 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 Ruby, você pode usar o seguinte código para fazer essa codificação: 

username_password = username + ':' + password
username_password_encoded = Base64.encode64(username_password)
'Basic ' + username_password_encoded

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 solicitação HTTP para enviar SMS a partir de Ruby

Para enviar as mensagens SMS, você precisa incluir as seguintes linhas como cabeçalhos na solicitação HTTP. Observe que incluímos um cabeçalho de 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 Ruby

Para enviar o SMS, sua aplicação Ruby 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
Content-Length: 339
Content-Type: application/json
Accept: application/json
Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 127.0.0.1:9509
User-Agent: Faraday v1.5.0
  
{
	"messages":	[
		{
			"message_id":	"f0f02105-0a78-46a9-ae14-f0728bac2aa6",
			"to_address":	"+36201111111",
			"text":	"Hello world!",
			"create_date":	"2021-07-06T14:32:21",
			"valid_until":	"2021-07-13T14:32:21",
			"time_to_send":	"2021-07-06T13:00:00",
			"is_submit_report_requested":	true,
			"is_delivery_report_requested":	true,
			"is_view_report_requested":	true,
			"tags":	[]
		}
	]
}

Resposta HTTP recebida pelo exemplo de SMS em Ruby

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. 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.123 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Tue, 06 Jul 2021 14:26:41 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "Mensagens enfileiradas para entrega.",
	"data": {
	  "total_count": 1,
	  "success_count": 1,
	  "failed_count": 0,
	  "messages": [
	    {
	      "message_id": "f0f02105-0a78-46a9-ae14-f0728bac2aa6",
	      "from_station": "%",
	      "to_address": "+36201111111",
	      "to_station": "%",
	      "text": "Hello world!",
	      "create_date": "2021-07-06 14:32:21",
	      "valid_until": "2021-07-13 14:32:21",
	      "time_to_send": "2021-07-06 13:00:00",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ],
	      "status": "SUCCESS"
	    }
	  ]
	}
}

Exemplo de SMS em Ruby: SendScheduledSms.rb

No vídeo a seguir, apresentamos o processo de download do código-fonte do projeto. O vídeo começará com o download dos arquivos do projeto e o levará até o arquivo do projeto aberto. O vídeo mostrará como baixar o arquivo do projeto e abri-lo com a ajuda do Bloco de Notas. Este vídeo de 36 segundos é detalhado e contém todas as informações necessárias para concluir com sucesso o processo de download.

Vídeo 1 - Como baixar e abrir o arquivo acima (Tutorial em vídeo)

O código de exemplo

O código de exemplo abaixo faz parte do arquivo SendScheduledSms.rb. Você pode modificar o projeto de exemplo encontrando a linha correta e substituindo uma parte do código pelos dados corretos. Por exemplo, a variável msg.to_address contém o número de telefone para onde a mensagem será enviada (Figura 3). A variável msg.text contém o texto da mensagem. Modifique conforme desejar e execute o projeto para enviar uma mensagem de teste.

Figura 3 - Arquivo SendScheduledSms.rb

Como enviar SMS agendado usando Ruby (Tutorial em vídeo)

Neste vídeo, vamos mostrar o processo de execução do projeto de exemplo. O vídeo começará com o código-fonte preparado e terminará com o registro do SMS agendado. O vídeo ensinará como definir um horário para o envio da mensagem e a configuração necessária no prompt de comando. Este vídeo tem apenas 1 minuto e 30 segundos, mas é muito detalhado. Você aprenderá todos os passos cruciais necessários para agendar um SMS. Estamos usando o Ozeki SMS Gateway neste vídeo, então você trabalhará com uma interface muito intuitiva. Você não terá problemas para seguir os passos.

Vídeo 2 - Como usar o arquivo SendScheduledSms.rb (Tutorial em vídeo)

Conclusão

O artigo acima mostrou os passos para agendar SMS em Ruby com a ajuda do Ozeki SMS Gateway. Com esta solução, é possível o envio de SMS no momento perfeito, levando a um maior desempenho e uma imagem amigável para o cliente. Os destinatários recebem as mensagens quando não estão em seus horários ocupados, então têm tempo para lê-las. O Ozeki SMS Gateway é um software muito confiável e pode ser gerenciado com facilidade.

Continue lendo na página de tutoriais do Ozeki, onde você pode encontrar mais informações sobre tópicos semelhantes, como recebimento em Ruby.

A única coisa a fazer agora é baixar o Ozeki SMS Gateway e começar a trabalhar!

More information