TUTORIAL

Como enviar SMS em Ruby

Gostaria de enviar SMS via Ruby em apenas 3 minutos? Então utilize a biblioteca desenvolvida por nossa equipe de desenvolvimento para tornar seu trabalho muito mais fácil.

Vamos disponibilizar também exemplos de como agendar envios de SMS, autenticação dois fatores, consultar relatórios e muito mais, tudo através de seu sistema.

Antes de começar, você precisa de uma conta conosco para testar nossas soluções. Você pode testar gratuitamente solicitando uma conta teste conosco clicando no botão abaixo.

Instalando a SDK

comtele_sdk está disponível no RubyGems o código é open source e pode ser encontrado em nosso GitHub.

A versão mínima necessária do Ruby para instalar a SDK é a 2.0, caso esteja utilizando uma versão inferior recomendamos que utilize o RVM, além disso, você pode dar uma olhadinha no nosso GitHub como fazer as chamadas via API Rest ou até então modificar os dependências que precisam da versão 2.0 e fazer a sua própria versão.

$ gem install comtele_sdk

Retorno de Sucesso da Instalação

Done installing documentation for http-accept, unf_ext, unf, domain_name, http-cookie, mime-types-data, mime-types, netrc, rest-client, comtele_sdk after 8 seconds
10 gems installed

Enviar SMS em Ruby

Veja abaixo um código Ruby para enviar sms a celulares de forma instantânea utilizando uma de nossas SDK.

É simples, rápido e fácil.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@textmessage_service = TextMessageService.new(API_KEY)
result = @textmessage_service.send(
  "my_id",          # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "Hello Ruby",     # Content: Conteudo da mensagem a ser enviada.
  ["11999998888"])  # Receivers: Numero de telefone que vai ser enviado o SMS.

puts result

Enviar SMS com regra de resposta automática

Com este recurso, é possível enviar SMS de forma instantânea e quando o SMS for respondido, é possível enviar uma resposta de forma automática, baseado em um contexto previamente configurado.

Para utilizar este recurso, é necessário que você acesse a opção Resposta Automática no menu Configurações no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo ContextRuleName no momento que for usar o endpoint.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@contextmessage_service = ContextMessageService.new(API_KEY)
result = @contextmessage_service.send(
  "my_id",            # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "ContextRuleName",  # ContextRuleName: Nome da regra de resposta automatica a ser usada no envio.
  ["11999998888"])    # Receivers: Numero de telefone que vai ser enviado o SMS.

puts result

Enviar SMS / Grupos de Contatos

Precisa enviar SMS para uma grande base de contatos? Também temos a solução.

Com este recurso, é possível enviar SMS de forma instantânea para um grupo de contatos.

Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso Cadastrar Grupos e Adicionar Contatos / Grupos

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@contactmessage_service = ContactMessageService.new(API_KEY)
result = @contactmessage_service.send(
  "my_id",            # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "Hello Ruby",       # Content: Conteudo da mensagem a ser enviada.
  "GroupName")        # GroupName: Nome do grupo de contatos que receberao o SMS

puts result

Agendar SMS

Precisa agendar aquele SMS de aniversário? Ou até de algum evento que está próximo? Também temos a solução.

Com este recurso, é possível programar a data e horário de envio de SMS para serem enviados.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@textmessage_service = TextMessageService.new(API_KEY)
result = @textmessage_service.schedule(
  "my_id",            # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "Hello Ruby",       # Content: Conteudo da mensagem a ser enviada.
  "yyyy-MM-dd HH:mm", # ScheduleDate: Data que o SMS deve ser disparado.
  ["11999998888"])    # Receivers: Numero de telefone que vai ser enviado o SMS.

puts result

Agendar SMS / Regra de Resposta Automática

Com este recurso, é possível programar a data e horário de envio de SMS para serem enviados, e quando o SMS for respondido, é possível enviar uma resposta de forma automática, baseado em um contexto previamente configurado.

Para utilizar este recurso, é necessário que você acesse a opção Resposta Automática no menu Configurações no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo ContextRuleName no momento que for usar o endpoint.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@contextmessage_service = ContextMessageService.new(API_KEY)
result = @contextmessage_service.schedule(
  "my_id",            # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "ContextRuleName",  # ContextRuleName: Nome da regra de resposta automatica a ser usada no envio.
  "yyyy-MM-dd HH:mm", # ScheduleDate: Data que o SMS deve ser disparado.
  ["11999998888"])    # Receivers: Numero de telefone que vai ser enviado o SMS.

puts result

Agendar SMS / Grupos de Contatos

Precisa agendar SMS para uma grande quantidade de contatos? Também temos a soluçã.

Com este recurso, é possível programar a data e horário de envio de SMS para um grupo de contatos.

Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso Cadastrar Grupos e Adicionar Contatos / Grupos

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@contactmessage_service = ContactMessageService.new(API_KEY)
result = @contactmessage_service.schedule(
  "my_id",            # Sender: Id de requisicao da sua aplicacao para ser retornado no relatorio.
  "Hello Ruby",     # Conteudo da mensagem a ser enviada.
  "GroupName",        # GroupName: Nome do grupo de contatos que receberao o SMS.
  "yyyy-MM-dd HH:mm") # ScheduleDate: Data que o SMS deve ser disparado.

puts result

Enviar SMS Autenticação Dois Fatores

Precisa de mais segurança em seu sistema de autenticação? Nós cuidamos disso para você.

Com este recurso, é possível enviar via SMS de forma instantânea um código de autenticação para o destinatário, que pode ser validado posteriormente no endpoint a seguir: Validar Código / Dois Fatores.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@token_service = TokenService.new(API_KEY)
result = @token_service.send_token(
  "11999998888",  # PhoneNumber: Numero de telefone que vai ser enviado o token via SMS.
  "Company")      # Prefix: Identificação da empresa que aparecerá no corpo da mensagem.

print(result)

Validar Código de Autenticação Dois Fatores

Com este recurso, é possível validar o token recebido e informado pelo usuário que recebeu o SMS, enviado pelo endpoint anterior anterior: Enviar SMS / Dois Fatores.

require 'comtele_sdk'
include ComteleSdk

API_KEY = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

@token_service = TokenService.new(API_KEY)
result = @token_service.validate_token(
  "TokenCode")  # TokenCode: Token que o cliente informou e deve ser validado pela Comtele.

puts result

Retornos das requisições

Exemplo de Retorno de Sucesso

{
  "Success": true, 
  "Object": null, 
  "Message": "A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios."
}

Campos do Retorno

Retornos Previsíveis

Outros endpoints

Criar conta teste

Agora que você já sabe como enviar SMS de uma maneira rápida e fácil para é só criar uma conta teste agora mesmo.

O processo é automático e rápido, acesse nossa página de contratação e comece a codar agora mesmo.