Project

nvoip

0.0
The project is in a healthy, maintained state
SDK Ruby oficial para integrar OAuth, chamadas, OTP, WhatsApp, SMS e saldo com a API v2 da Nvoip.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies
 Project Readme

nvoip-ruby

CI Gem Gem downloads Nvoip API v2 Docs Postman Stack License: GPL-3.0

SDK e exemplos oficiais da Nvoip para integrar a API v2 com OAuth, chamadas, OTP, WhatsApp, SMS e saldo em Ruby.

Requisitos

  • Ruby 3.0+

Instalacao

gem install nvoip

Configuração

cp .env.example .env

Ou exporte:

export NVOIP_NUMBERSIP="seu_numbersip"
export NVOIP_USER_TOKEN="seu_user_token"
export NVOIP_OAUTH_CLIENT_ID="seu_client_id"
export NVOIP_OAUTH_CLIENT_SECRET="seu_client_secret"
export NVOIP_CALLER="1049"
export NVOIP_TARGET_NUMBER="11999999999"

Fluxos cobertos

  • gerar access_token
  • renovar token
  • consultar saldo
  • enviar SMS
  • realizar chamada
  • enviar OTP
  • validar OTP
  • listar templates de WhatsApp
  • enviar template de WhatsApp

Exemplos

  • ruby examples/create_access_token.rb
  • ruby examples/get_balance.rb
  • ruby examples/send_sms.rb
  • ruby examples/create_call.rb
  • ruby examples/send_otp.rb
  • ruby examples/check_otp.rb
  • ruby examples/list_whatsapp_templates.rb
  • ruby examples/send_whatsapp_template.rb

SDK web

Para o fluxo de popup com telefone e código, use em conjunto o repositório nvoip-web-sdk. Este repo cobre o consumo server-side da API.

Links oficiais