Skip to content

totalvoice/totalvoice-ruby

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 

totalvoice-ruby

Client em Ruby para a API da TotalVoice

Funcionalidades

  • Gerenciamento das chamadas
  • Consulta e envio de SMS
  • Consulta e envio de TTS
  • Consulta e envio de Audio
  • Consulta e envio de Composto
  • Gerenciamento da Conta
  • Gerenciamento de Ramais
  • URL do Webphone
  • Gerenciamento de DID
  • Verificação[Two Dactor Authentication]

Requisitos

  • Ruby: 2.4.3
  • Gem: 2.6.14

Instalação

 gem 'totalvoice-ruby'
 gem install totalvoice-ruby

Utilização

Para utilizar esta biblioteca, primeiramente você deverá realizar um cadastro no site da Total Voice. Após a criação do cadastro será disponibilizado um AccessToken para acesso a API.

Com o AccessToken em mãos será possível realizar as consultas/cadastros conforme documentação da API

A seguir exemplos de como utilizar esta biblioteca.

Realiza uma chamada telefônica entre dois números: A e B
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.chamada.ligar("NUMERO-A", "NUMERO-B")
Consulta os dados da chamada pelo ID
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.chamada.buscar(123456)
Encerra uma chamada ativa
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.chamada.encerrar(123456)
Envio de SMS
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.sms.enviar("NUMERO-DESTINO", "MENSAGEM")
Envio de TTS
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.tts.enviar("NUMERO-DESTINO", "MENSAGEM")
Envio de Audio
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.audio.enviar("NUMERO-DESTINO", "URL-AUDIO")
Configurações de central telefonica - consultando ramal
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.ramal.buscar(123)
Buscar os dados da Conta
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.conta.buscar(123)
Consulta saldo da Minha Conta
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.perfil.consulta_saldo()
Caso você necessite utilizar seu próprio endereço configurado na Total Voice
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token", "https://meuhost.com.br")
puts @client.perfil.consulta_saldo()
Adquirindo um did
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.did.adquirir()
Listando seus DIDs
require 'totalvoice-ruby'
include TotalVoice

@client = TotalVoice::API.new("access-token")
puts @client.did.listar()

To-Do

  • Tests

Mais informações sobre os métodos disponíveis podem ser encontrados na documentação da API

Licença

Esta biblioteca segue os termos de uso da MIT

About

Client em Ruby para a API da TotalVoice

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages