Search by

nvoip / nvoip-php

nvoip

SDK PHP oficial para integrar OAuth, chamadas, OTP, WhatsApp, SMS e saldo com a API v3 da Nvoip.

v3.0.0 2026-10-03 20:53 UTC

README

CI Packagist Packagist downloads Nvoip API v3 Docs Postman Stack License: GPL-3.0

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

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.

Os tokens retornados devem ser consumidos somente pelo backend. Não os registre em logs, commits ou mensagens. Em OTP, methods é um objeto, por exemplo ['sms' => true] para phoneNumber.

O que tem aqui

  • src/NvoipClient.php: cliente leve para a API v3
  • examples/: exemplos separados por fluxo principal
  • Scripts/sender-sms.php: endpoint PHP simples para disparo de SMS via query string

Requisitos

  • PHP 8.0+
  • extensao curl

Instalacao

composer require nvoip/nvoip-php

Configuracao

Configure credenciais OAuth client credentials no ambiente do servidor:

export NVOIP_OAUTH_CLIENT_ID="seu_client_id"
export NVOIP_OAUTH_CLIENT_SECRET="seu_client_secret"

Exemplos

  • php examples/create-client-credentials-token.php
  • php examples/send-sms.php
  • php examples/create-call.php
  • php examples/send-otp.php
  • php examples/check-otp.php
  • php examples/list-whatsapp-templates.php
  • php examples/send-whatsapp-template.php

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.

Mini endpoint HTTP

O arquivo Scripts/sender-sms.php usa OAuth client credentials configurado no ambiente do servidor. Não aceite nem passe credenciais na query string.

Exemplo:

https://seusite.exemplo/Scripts/sender-sms.php?numberPhone=11999999999&message=Mensagem%20de%20teste

SDK web

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

Links oficiais