📕 Manual Interno 04: Painel do Revendedor, Subcontas, Usuários SIP & Gestão de DIDs

🛡️ Sentinel Status

  • Classificação: Manual de Governança Administrativa & Provisionamento
  • Módulos: Contas Gerenciadas, Controle de Acesso (RBAC), Números Virtuais (DID) e Billing
  • Painel Oficial: https://painel.nvoip.com.br/
  • Ambiente de API: Endpoints /managed-accounts, /users, /access-profiles, /numbers e /balance

1. Estrutura Multi-Tenant & Contas Gerenciadas

Para agências e empresas que administram múltiplos clientes ou filiais, a Nvoip disponibiliza a funcionalidade de Revendedor (Multi-Tenant). Cada subconta opera com isolamento de saldo, histórico de ligações e ramais próprios.

graph TD
    A[Conta Master / Revendedor] --> B[Conta Gerenciada: Cliente A]
    A --> C[Conta Gerenciada: Cliente B]
    A --> D[Conta Gerenciada: Filial SC]
    B --> B1[Ramais SIP 68105001..05]
    B --> B2[DID Virtual 11 3199-6999]
    C --> C1[Ramais SIP 68105010..20]

1.1. Listar Contas da Carteira via API

Endpoint: GET /managed-accounts?limit=20

curl -X GET "https://api.nvoip.com.br/v3/managed-accounts?limit=20" \
  -H "Authorization: Bearer SEU_TOKEN_MASTER"

2. Gestão de Usuários e Ramais SIP

Cada conta ou filial pode ter múltiplos usuários secundários, atribuindo ou removendo o acesso ao painel web e habilitando credenciais para softphones ou aparelhos IP físicos.

2.1. Criar Usuário Secundário

Endpoint: POST /users?managedAccountId=CONTA_ID

{
  "name": "Operador Suporte 01",
  "email": "operador01@artesdosul.com",
  "extension": "1001",
  "accessProfileId": "perfil-atendente-suporte",
  "sipEnabled": true,
  "panelAccessEnabled": false
}

2.2. Ativar ou Desativar Ramal SIP Instantaneamente

Caso um dispositivo seja comprometido ou um colaborador seja desligado, o ramal SIP pode ser desativado via API ou Painel sem remover o usuário:

Endpoint: PUT /users/{userId}/sip-status?managedAccountId=CONTA_ID

{
  "active": false,
  "reason": "Bloqueio preventivo de segurança"
}

3. Gestão e Compra de Números Virtuais (DID)

A Nvoip permite a contratação programática de números fixos locais em qualquer DDD do Brasil e números 0800 nacionais.

3.1. Ciclo de Vida da Aquisição de DIDs

O fluxo de contratação segue quatro etapas autoritativas para evitar concorrência ou reservas órfãs:

[1. Consultar Disponibilidade] ➔ [2. Criar Cotação] ➔ [3. Reservar Número] ➔ [4. Confirmar Compra com Saldo]

Passo 1: Consultar Números Disponíveis por Localidade

Endpoint: GET /numbers/availability?countryId=30&state=SC&city=Bombinhas

curl -X GET "https://api.nvoip.com.br/v3/numbers/availability?countryId=30&state=SC&city=Bombinhas" \
  -H "Authorization: Bearer SEU_TOKEN"

Passo 2: Criar Cotação Autoritativa

Endpoint: POST /number-quotes Retorna o custo de ativação, mensalidade e validade da proposta (geralmente 15 minutos).

Passo 3: Reservar o Número Escolhido

Endpoint: POST /number-reservations Garante a exclusividade temporária do número para validação cadastral. Caso o cliente desista, a reserva pode ser liberada sem qualquer ônus via DELETE /number-reservations/{id}/cancel.

Passo 4: Confirmar a Compra com Saldo da Carteira

Endpoint: POST /number-orders

{
  "reservationId": "res_84920492841029",
  "paymentSource": "account_balance"
}

4. Portabilidade Numérica

Para portar números fixos legados de outras operadoras (Vivo, Claro, Oi, Embratel) para a Nvoip:

  1. No painel Nvoip, acesse Números > Portabilidade.
  2. Preencha o formulário com o número a ser portado, razão social e CNPJ/CPF do titular.
  3. Anexe a última fatura da operadora doadora (comprovante de quitação e titularidade recente).
  4. O processo regulatório da Anatel leva em média de 3 a 5 dias úteis sem interrupção do serviço até a janela de corte.