https://github.com/nvoip/nvoip-ruby

Ruby SDK and examples for Nvoip API OAuth, calls, OTP, SMS, WhatsApp, and balance checks.
https://github.com/nvoip/nvoip-ruby

api nvoip oauth otp ruby rubygems sdk sms telefonia voip whatsapp

Last synced: 2 months ago
JSON representation

Ruby SDK and examples for Nvoip API OAuth, calls, OTP, SMS, WhatsApp, and balance checks.

• Host: GitHub
• URL: https://github.com/nvoip/nvoip-ruby
• Owner: Nvoip
• License: gpl-3.0
• Created: 2026-04-29T21:34:05.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2026-04-30T15:25:26.000Z (2 months ago)
• Last Synced: 2026-05-01T02:18:47.770Z (2 months ago)
• Topics: api, nvoip, oauth, otp, ruby, rubygems, sdk, sms, telefonia, voip, whatsapp
• Language: Ruby
• Homepage: https://www.nvoip.com.br
• Size: 19.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nvoip-ruby

[![CI](https://github.com/Nvoip/nvoip-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/Nvoip/nvoip-ruby/actions/workflows/ci.yml) [![Gem](https://img.shields.io/gem/v/nvoip?style=flat-square)](https://rubygems.org/gems/nvoip) [![Gem downloads](https://img.shields.io/gem/dt/nvoip?style=flat-square)](https://rubygems.org/gems/nvoip) [![Nvoip](https://img.shields.io/badge/Nvoip-site-00A3E0?style=flat-square)](https://www.nvoip.com.br/) [![API v2](https://img.shields.io/badge/API-v2-1F6FEB?style=flat-square)](https://www.nvoip.com.br/api/) [![Docs](https://img.shields.io/badge/docs-Apiary-6A737D?style=flat-square)](https://nvoip.docs.apiary.io/) [![Postman](https://img.shields.io/badge/Postman-workspace-FF6C37?style=flat-square)](https://nvoip-api.postman.co/workspace/e671d01f-168a-4c38-8d0e-c217229dd61a/team-quickstart) [![Stack](https://img.shields.io/badge/stack-Ruby-CC342D?style=flat-square)](https://github.com/Nvoip/nvoip-api-examples) [![License: GPL-3.0](https://img.shields.io/badge/license-GPL--3.0-blue?style=flat-square)](LICENSE)

SDK e exemplos oficiais da [Nvoip](https://www.nvoip.com.br/) para integrar a API v2 com OAuth, chamadas, OTP, WhatsApp, SMS e saldo em Ruby.

## Requisitos

- Ruby 3.0+

## Instalacao

```bash

gem install nvoip

```

## Configuração

```bash

cp .env.example .env

```

Ou exporte:

```bash

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

- [Site da Nvoip](https://www.nvoip.com.br/)

- [Documentação da API](https://nvoip.docs.apiary.io/)

- [Página da API](https://www.nvoip.com.br/api/)

- [Workspace Postman](https://nvoip-api.postman.co/workspace/e671d01f-168a-4c38-8d0e-c217229dd61a/team-quickstart)

- [Hub de exemplos](https://github.com/Nvoip/nvoip-api-examples)