NNocSuiteDocumentação

Docs / WhatsApp

WhatsApp — API para sistemas terceiros (NwOS)

Gere chaves e envie cobranças pelo WhatsApp com modelos oficiais, a partir de outro sistema.

Atualizado 2026-11-02

WhatsApp — API para sistemas terceiros (NwOS)

Artigo para quem integra sistemas; não é necessário no dia a dia.

O que você vai fazer

Gerar uma chave de acesso e usá-la no NwOS (ou outro sistema) para enviar cobranças pelo WhatsApp com modelos de utilidade aprovados pela Meta.

Antes de começar

  • Canal WhatsApp oficial ativo (Meta Cloud ou YCloud) em Configurações → WhatsApp.
  • Modelos de cobrança ligados e aprovados (boleto gerado, a vencer, vence hoje, atrasado, pago).
  • Permissão Configurar WhatsApp para criar ou revogar chaves.
  • A API não liga o envio automático, que continua desligado.

Passo a passo

  1. Abra Configurações → WhatsApp → Integrações.
  2. Informe um nome (ex.: NwOS produção) e clique em Gerar chave.
  3. Copie a chave na hora: ela só aparece uma vez.
  4. No NwOS, configure o endpoint e o Bearer:

``bash curl -X POST "https://SEU_DOMINIO/api/v1/whatsapp/billing/send" \ -H "Authorization: Bearer nwwa_SEU_PREFIXO_SEU_SECRET" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: nwos-unique-123" \ -d '{ "event": "paymentDueToday", "phone": "+5511999990000", "variables": { "cliente": "Cliente Exemplo", "data": "22/07/2026", "quantidade_titulos": "1", "valor_total": "R$ 199,90", "resumo_vencimento": "1 título vence hoje", "titulos_e_valores": "NF-1001 — R$ 199,90", "links_pagamento": "https://app.nocwork.com.br/pagar/exemplo", "empresa": "Sua Empresa" } }' ``

  1. Confira o envio na conversa (número de cobrança) e em Configurações → Auditoria.

Ler leads e conversas (MCP)

Para um assistente de IA ou ferramenta de relatório consultar os leads do WhatsApp sem acesso ao sistema:

  1. Em Configurar → WhatsApp → API / Integrações, escolha Uso da chave: Ler leads e conversas (MCP, só leitura), dê um nome e clique em Gerar chave.
  2. Copie a chave na hora; ela não aparece de novo.
  3. No cliente MCP, use o endereço https://nocsuite.com.br/api/v1/mcp e o cabeçalho Authorization: Bearer seguido da chave.

A chave só lê: telefone sai em código (hash), nome só o primeiro, e e-mail, CPF e telefone dentro das mensagens saem trocados por marcadores. Nada é enviado aos contatos. Cada consulta fica registrada na auditoria. Para cortar o acesso, revogue a chave na mesma tela.

Para o desenvolvedor

  • Scope da chave: whatsapp.billing.send.
  • Endpoint: POST /api/v1/whatsapp/billing/send.
  • Eventos: boletoGenerated, paymentDueSoon, paymentDueToday, paymentOverdue, paymentConfirmed.
  • Envios via chave usam apiSendsAllowed (default true) ou manualSendsAllowed — ação explícita do cliente.
  • Rate limit: 30 req/min por chave.

Se der erro

  • 401 — secret inválido ou chave revogada.
  • 403 — scope ausente ou apiSendsAllowed/manualSendsAllowed bloqueados.
  • 422 SEND_BLOCKED — template não aprovado, canal inativo ou variáveis incompletas.
  • 429 — rate limit; aguarde e reenvie com o mesmo Idempotency-Key se necessário.

Pronto

Próximo: Envio manual e automação.

Este artigo também está disponível no ERP: /ajuda/whatsapp/api-integracao-terceiros.

NocSuite Docs — NocSuite