nvoip-lua

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

Requisitos

Pacotes recomendados via LuaRocks:

• luasec
• lua-cjson

Instalacao

luarocks install nvoip

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

Configuração

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_TARGET_NUMBER="11999999999"
export NVOIP_SMS_MESSAGE="Mensagem de teste Nvoip"

Exemplos

Enviar SMS:

lua examples/send_sms.lua

Consultar saldo:

lua examples/get_balance.lua

Gerar access_token:

lua examples/create_access_token.lua

Criar chamada:

lua examples/create_call.lua

Enviar OTP:

lua examples/send_otp.lua

Validar OTP:

lua examples/check_otp.lua

Listar templates de WhatsApp:

lua examples/list_whatsapp_templates.lua

Enviar template de WhatsApp:

lua examples/send_whatsapp_template.lua

Destinatário WhatsApp

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

Onde este repositório ajuda mais

Lua é especialmente útil em cenários de automação e telefonia embarcada, como integrações com serviços e middlewares que já usam scripts leves para orquestração.

Para o fluxo de popup de telefone + codigo no navegador, use em conjunto o repositório nvoip-web-sdk.

Links oficiais

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