nvoip-node
v3.0.0
Published
Cliente Node.js simples para a API v3 da Nvoip.
Readme
nvoip-node
SDK e exemplos oficiais da Nvoip para integrar a API v3 com OAuth, chamadas, OTP, WhatsApp, SMS e saldo em Node.js.
Migração para v3
Esta é uma quebra de compatibilidade: use createClientCredentialsToken() e envie o access token RS256 em Authorization: Bearer. O SDK usa https://api.nvoip.com.br/auth/oauth2/token; não use napikey, password grant ou /v3/oauth/token. Para SMS de texto livre, valide antes a política e o template aprovado aplicáveis à sua conta.
Requisitos
- Node.js 18+
Instalacao
npm install nvoip-nodeConfiguracao
cp .env.example .envOu exporte as variaveis:
export NVOIP_OAUTH_CLIENT_ID="seu_numbersip"
export NVOIP_OAUTH_CLIENT_SECRET="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:tokennpm run balancenpm run call:createnpm run otp:sendnpm run otp:checknpm run send:smsnpm run wa:listnpm 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.
