API do NooviChat para WhatsApp, CRM e automações
Documentação para integrar conversas, contatos, inboxes, webhooks e fluxos de atendimento em operações que usam o NooviChat como distribuição privada/licenciada.
Base URL
Primeiros Passos
~5 min- 1Obter seu API Access Token em Configurações > Conta
- 2Fazer sua primeira requisição (ver Quick Start abaixo)
- 3Testar autenticação com GET /conversations
- 4Explorar os endpoints na Referência API
Quick Start & Autenticação
Faça sua primeira requisição listando conversas da sua conta:
curl -X GET \
"https://chat.seudominio.com/api/v1/accounts/{account_id}/conversations" \
-H "api_access_token: YOUR_API_TOKEN" \
-H "Content-Type: application/json"Autenticação
A NooviChat API utiliza tokens de acesso para autenticação. Envie o header api_access_token em todas as requisições. Consulte o guia de autenticação para mais detalhes.
Antes de integrar em produção
Licença e ambiente
A API e os exemplos devem ser usados no ambiente licenciado do cliente. O NooviChat não é um repositório open-source gratuito; é uma distribuição privada vendida via licença/acesso à imagem Docker.
WhatsApp com responsabilidade
Automações, mensagens e campanhas precisam respeitar opt-in, políticas da Meta/WhatsApp e regras da sua operação. Evite fluxos de disparo abusivo ou contorno de bloqueios.
Suporte comercial e técnico
Se a integração envolver CRM, n8n, webhooks ou canais críticos, valide o escopo técnico da integração e as boas práticas antes de implantar em produção. Todos os planos entregam as mesmas funcionalidades.
Endpoints
Ver referência completaConversations
Gerenciar conversas com clientes
/api/v1/accounts/{account_id}/conversationsListar todas as conversas
/api/v1/accounts/{account_id}/conversationsCriar uma nova conversa
/api/v1/accounts/{account_id}/conversations/{id}Obter detalhes de uma conversa
Messages
Enviar e receber mensagens
/api/v1/accounts/{account_id}/conversations/{id}/messagesListar mensagens de uma conversa
/api/v1/accounts/{account_id}/conversations/{id}/messagesEnviar uma mensagem
/api/v1/accounts/{account_id}/conversations/{id}/messages/{message_id}Excluir uma mensagem
Contacts
Gerenciar contatos e informações de clientes
/api/v1/accounts/{account_id}/contactsListar todos os contatos
/api/v1/accounts/{account_id}/contactsCriar um novo contato
/api/v1/accounts/{account_id}/contacts/searchBuscar contatos
/api/v1/accounts/{account_id}/contacts/{id}Atualizar um contato
Inboxes
Configurar canais de comunicação
/api/v1/accounts/{account_id}/inboxesListar todas as inboxes
/api/v1/accounts/{account_id}/inboxesCriar uma nova inbox
/api/v1/accounts/{account_id}/inboxes/{id}Atualizar uma inbox
Webhooks
Configurar webhooks para eventos
/api/v1/accounts/{account_id}/webhooksListar webhooks configurados
/api/v1/accounts/{account_id}/webhooksCriar um webhook
/api/v1/accounts/{account_id}/webhooks/{id}Remover um webhook
Agents
Gerenciar agentes de atendimento
/api/v1/accounts/{account_id}/agentsListar todos os agentes
/api/v1/accounts/{account_id}/agentsAdicionar um agente
/api/v1/accounts/{account_id}/agents/{id}Atualizar um agente
Exemplo Completo
Crie um contato, inicie uma conversa e envie uma mensagem em 3 passos:
const API = "https://chat.seudominio.com/api/v1/accounts/1";
const TOKEN = "YOUR_API_TOKEN";
const headers = { "api_access_token": TOKEN, "Content-Type": "application/json" };
// 1. Criar contato
const contact = await fetch(`${API}/contacts`, {
method: "POST",
headers,
body: JSON.stringify({
name: "Maria Silva",
phone_number: "+5511999999999",
}),
}).then(r => r.json());
// 2. Criar conversa com o contato
const conversation = await fetch(`${API}/conversations`, {
method: "POST",
headers,
body: JSON.stringify({
contact_id: contact.id,
inbox_id: 1, // ID da inbox WhatsApp
}),
}).then(r => r.json());
// 3. Enviar mensagem
await fetch(`${API}/conversations/${conversation.id}/messages`, {
method: "POST",
headers,
body: JSON.stringify({
content: "Ola! Como posso ajudar?",
message_type: "outgoing",
}),
});
console.log("Conversa criada:", conversation.id);Casos de Uso
Atendimento via WhatsApp
Integre canais WhatsApp e gerencie conversas em uma única plataforma.
Automações
Automatize respostas e fluxos de atendimento com bots e N8N.
Dashboard de Métricas
Acompanhe tempo de resposta, volume de conversas e satisfação.
Erros Comuns
401Unauthorized
Causa: API key ausente, inválida ou expirada.
Solução: Verifique o header api_access_token e gere um novo token se necessário.
404Not Found
Causa: Recurso não encontrado. ID ou account_id incorreto.
Solução: Confirme que o account_id e o ID do recurso estão corretos na URL.
422Unprocessable Entity
Causa: Dados enviados inválidos ou campos obrigatórios ausentes.
Solução: Revise o body da requisição e verifique os campos obrigatórios na documentação.
429Too Many Requests
Causa: Limite de requisições excedido (300 req/min).
Solução: Implemente backoff exponencial e respeite o header Retry-After.
Problema persiste? Entre em contato com o suporte
Pronto para conectar a API ao seu atendimento?
Explore a referência completa, valide o escopo do seu plano e fale com o time para alinhar WhatsApp, CRM, webhooks e automações antes de colocar a integração em produção.