nvoip-node

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

Requisitos

• Node.js 18+

Instalacao

npm install nvoip-node

Configuracao

cp .env.example .env

Ou exporte as variaveis:

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

Scripts prontos

• npm run auth:token
• npm run balance
• npm run call:create
• npm run otp:send
• npm run otp:check
• npm run send:sms
• npm run wa:list
• npm run wa:send

Destinatário WhatsApp

O exemplo mantém NVOIP_WA_DESTINATION para telefone. Para o contrato tipado, não informe esse campo e use NVOIP_WA_RECIPIENT_TYPE=phone|bsuid|parent_bsuid com NVOIP_WA_RECIPIENT_VALUE. BSUID é opaco; não use @username nem o coloque em campo de telefone. Valores mascarados seguros para testes de montagem: US.MASKED_BSUID_001 e PARENT.MASKED_BSUID_001.

SDK web

Para o fluxo de popup com telefone e codigo, use o repositório nvoip-web-sdk. Ele fica responsavel pela UI embutivel; este repo cobre o consumo server-side da API.

Links oficiais

• Site da Nvoip
• Documentação da API
• Página da API
• Workspace Postman
• Hub de exemplos