Como enviar SMS a partir do Ruby
A maneira mais simples de enviar SMS a partir do Ruby é usar a API HTTP/REST de SMS integrada do Ozeki SMS Gateway. Quando você usa esta API, 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.
O exemplo de código Ruby para SMS abaixo demonstra como você pode enviar SMS usando a API HTTP REST de SMS do Ozeki SMS Gateway com a gem ozeki_libs_rest. Esta biblioteca é fornecida gratuitamente e você pode usá-la e modificá-la em qualquer um dos seus projetos.
SendSms.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!"
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 baixar a gem, você precisa adicionar uma referência a ela no 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 através de uma conexão sem fio ou pela Internet.
Baixar SendSms.rb
O código-fonte explicado neste artigo pode ser baixado, usado e modificado gratuitamente.
Download: SendSms.rb.zip (316B)
No SendSms.rb.zip você encontrará o arquivo SendSms.rb, que contém o código de exemplo para mostrar como enviar um SMS. Este código de exemplo está listado abaixo.
gem install ozeki_libs_rest
Como enviar SMS a partir do Ruby (Passos simples)
Para enviar SMS a partir do Ruby:
- Instale um usuário de API HTTP
- Ative "Log communication events" na aba Advanced
- Configure o Visual Studio
- Baixe e extraia o arquivo SendSms.rb.zip
- Inicie o aplicativo Ozeki SMS Gateway
- Execute o código Ruby SendSms.rb usando o prompt de comando
- Verifique os logs para ver se o SMS foi enviado
Para poder enviar SMS a partir do 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 em qualquer editor de texto, como o Bloco de Notas do Windows. 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 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 de SMS. Crie um usuário com o nome "http_user" e senha "qwe123" para fazer o exemplo funcionar sem modificações.
Após configurar o ambiente, você pode executar seu código Ruby.
URL da API HTTP para enviar SMS a partir do RubyPara enviar SMS a partir do Ruby, seu código Ruby 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 a aplicação Ruby 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
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 requisição HTTP. O formato usado é: base64(nome_de_usuário+":"+senha). No 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 requisição HTTP para enviar SMS a partir do Ruby
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 do Ruby
Para submeter o SMS, sua aplicação Ruby enviará uma requisição HTTP similar à 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=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": "2861551f-fddd-4b8e-9b06-eab9e1a0d179",
"to_address": "+36201111111",
"text": "Hello world!",
"create_date": "2021-07-06T09:09:44",
"valid_until": "2021-07-13T09:09:44",
"time_to_send": "2021-07-06T09:09:44",
"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 requisição, ele gerará uma resposta HTTP. A resposta HTTP conterá um código de status, para indicar se a requisição de envio do 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.123 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Tue, 06 Jul 2021 08:52:02 GMT
Server: 10/10.3.123
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": "2861551f-fddd-4b8e-9b06-eab9e1a0d179",
"from_station": "%",
"to_address": "+36201111111",
"to_station": "%",
"text": "Hello world!",
"create_date": "2021-07-06 09:09:44",
"valid_until": "2021-07-13 09:09:44",
"time_to_send": "2021-07-06 09:09:44",
"submit_report_requested": true,
"delivery_report_requested": false,
"view_report_requested": false,
"tags": [
{
"name": "Type",
"value": "SMS:TEXT"
}
],
"status": "SUCCESS"
}
]
}
}
Conecte seu gateway SMS à rede móvel e crie uma conta de usuário HTTP API
Assumimos que você já instalou o Ozeki SMS Gateway, e que você conectou-o à rede móvel. Para poder enviar SMS para um telefone móvel a partir do Ruby, você precisa configurar uma conta de usuário HTTP API no Ozeki SMS Gateway.
Como enviar SMS a partir do Ruby usando a API de SMS em Ruby (Tutorial em vídeo)
Este vídeo mostra como baixar o arquivo SendSms.rb.zip desta página. Se assistir ao vídeo, você notará que o conteúdo do zip SendSms.rb é colocado na área de trabalho do Windows. Você também verá que executamos o prompt de comando para enviar o SMS.
Exemplo de SMS em Ruby: SendSms.rb
O código de exemplo abaixo faz parte do SendSms.rb.
Como verificar se o SMS foi aceito pelo usuário HTTP
Após o SMS ter sido submetido, é 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 a partir do console de gerenciamento do Ozeki SMS Gateway. O vídeo a seguir mostra o que procurar.
Como verificar se o SMS foi enviado para a rede móvel
O passo final para verificar o procedimento é olhar os logs da conexão com a rede móvel. Você pode precisar ativar o logging na configuração da conexão antes de enviar a mensagem para ver os logs. Se o logging estiver ativado, você verá o número do telefone e o texto da mensagem que você enviou.
Como é receber uma mensagem no Android (Tutorial em vídeo)
Neste vídeo, você verá o processo de recebimento de uma mensagem no Android, quando a mensagem é enviada usando o Ozeki SMS Gateway. O vídeo começa com uma tela principal comum do Android e mostra a notificação que você recebe no caso de um SMS recebido e, em seguida, o aplicativo Mensagens aberto com o SMS 'Hello World'. O vídeo tem apenas 18 segundos, mas mostra todo o processo.
Conclusão
O principal objetivo deste artigo foi mostrar as etapas do envio de SMS em Ruby com a ajuda do Ozeki SMS Gateway. Com essa inovação, você pode enviar mensagens para seus clientes sentado atrás de um computador, usando apenas o Ozeki SMS Gateway e um código Ruby. Esta solução é um ótimo exemplo de como é fácil controlar o Ozeki SMS Gateway com códigos Ruby. Também deve ser mencionado que o Ozeki SMS Gateway funciona em qualquer país e pode enviar e receber SMS através de várias conexões móveis.
Continue a leitura na página de tutoriais da Ozeki, onde mais informações podem ser encontradas sobre tópicos como agendamento de SMS em Ruby.
A única coisa a fazer agora é baixar o Ozeki SMS Gateway e começar a trabalhar!
More information
- Enviar SMS com a API REST HTTP em Ruby (exemplo de código)
- Enviar múltiplos SMS com a API REST HTTP em Ruby (exemplo de código)
- Agendar SMS com a API REST HTTP em Ruby (exemplo de código)
- Receber SMS com a API REST HTTP em Ruby (exemplo de código)
- Excluir SMS com a API REST HTTP em Ruby (exemplo de código)
- Como baixar a biblioteca Ruby SMS mais recente do Github
- Enviar SMS em Ruby a partir do Linux