Pular para o conteúdo

NooviChat API

API completa para customer engagement — gerencie conversas, contatos, inboxes, automacoes e integracoes WhatsApp.

v1.1.082 endpointsOpenAPI 3.0

Base URL

https://chat.seudominio.com

Primeiros Passos

~5 min
  1. 1Obter seu API Access Token em Configuracoes > Conta
  2. 2Fazer sua primeira requisicao (ver Quick Start abaixo)
  3. 3Testar autenticacao com GET /conversations
  4. 4Explorar os endpoints na Referencia API

Quick Start & Autenticacao

Faca sua primeira requisicao 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"

Autenticacao

A NooviChat API utiliza tokens de acesso para autenticacao. Envie o header api_access_token em todas as requisicoes. Consulte o guia de autenticacao para mais detalhes.

Conversations

Gerenciar conversas com clientes

GET
/api/v1/accounts/{account_id}/conversations

Listar todas as conversas

POST
/api/v1/accounts/{account_id}/conversations

Criar uma nova conversa

GET
/api/v1/accounts/{account_id}/conversations/{id}

Obter detalhes de uma conversa

Messages

Enviar e receber mensagens

GET
/api/v1/accounts/{account_id}/conversations/{id}/messages

Listar mensagens de uma conversa

POST
/api/v1/accounts/{account_id}/conversations/{id}/messages

Enviar uma mensagem

DELETE
/api/v1/accounts/{account_id}/conversations/{id}/messages/{message_id}

Excluir uma mensagem

Contacts

Gerenciar contatos e informacoes de clientes

GET
/api/v1/accounts/{account_id}/contacts

Listar todos os contatos

POST
/api/v1/accounts/{account_id}/contacts

Criar um novo contato

GET
/api/v1/accounts/{account_id}/contacts/search

Buscar contatos

PUT
/api/v1/accounts/{account_id}/contacts/{id}

Atualizar um contato

Inboxes

Configurar canais de comunicacao

GET
/api/v1/accounts/{account_id}/inboxes

Listar todas as inboxes

POST
/api/v1/accounts/{account_id}/inboxes

Criar uma nova inbox

PUT
/api/v1/accounts/{account_id}/inboxes/{id}

Atualizar uma inbox

Webhooks

Configurar webhooks para eventos

GET
/api/v1/accounts/{account_id}/webhooks

Listar webhooks configurados

POST
/api/v1/accounts/{account_id}/webhooks

Criar um webhook

DELETE
/api/v1/accounts/{account_id}/webhooks/{id}

Remover um webhook

Agents

Gerenciar agentes de atendimento

GET
/api/v1/accounts/{account_id}/agents

Listar todos os agentes

POST
/api/v1/accounts/{account_id}/agents

Adicionar um agente

PUT
/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 unica plataforma.

POST /conversationsPOST /messages
Facil

Chatbot com IA

Automatize respostas com bots inteligentes e assistentes de IA.

POST /messagesWebhooks
Medio

Dashboard de Metricas

Acompanhe tempo de resposta, volume de conversas e satisfacao.

GET /conversationsGET /reports
Avancado

Erros Comuns

401Unauthorized

Causa: API key ausente, invalida ou expirada.

Solucao: Verifique o header api_access_token e gere um novo token se necessario.

404Not Found

Causa: Recurso nao encontrado. ID ou account_id incorreto.

Solucao: Confirme que o account_id e o ID do recurso estao corretos na URL.

422Unprocessable Entity

Causa: Dados enviados invalidos ou campos obrigatorios ausentes.

Solucao: Revise o body da requisicao e verifique os campos obrigatorios na documentacao.

429Too Many Requests

Causa: Limite de requisicoes excedido (300 req/min).

Solucao: Implemente backoff exponencial e respeite o header Retry-After.

Problema persiste? Entre em contato com o suporte

Referencia Completa

Explore todos os 82 endpoints com exemplos, schemas e detalhes de parametros.

Abrir Referencia API