NooviChat API Reference

Referência completa da API NooviChat — 160+ endpoints para customer engagement, conversas, pipeline de vendas, atendimentos (agendamentos), follow-ups, lead scoring e integração WhatsApp.

Visão Geral

Base URL

https://chat.seudominio.com

Versão

v1.1.0OpenAPI 3.0.4

Autenticação

Todas as requisições requerem o header api_access_token com seu token de acesso.

Ver guia completo de autenticação

Convenções

Códigos de status

A API segue um contrato de erro consistente. Entrada inválida nunca retorna 500.

Status	Significado
200 / 201	Sucesso. Algumas rotas legacy retornam 200 na criação; as canônicas retornam 201.
204	Sucesso sem corpo (ex.: alguns DELETE).
401	Token ausente/inválido (`api_access_token`).
403	Autenticado mas sem permissão (ex.: recurso admin-only).
404	Recurso inexistente ou de outra conta (IDs são resolvidos dentro da conta autenticada — ver abaixo).
422	Validação falhou (campo obrigatório, valor fora de faixa, enum inválido). Corpo: `{ "error" \| "message", ... }`.
429	Rate limit excedido — ver Rate Limits.

IDs são resolvidos por conta

Todo {id} e display_id é resolvido dentro da conta autenticada. Um ID que pertence a outra conta retorna 404 — nunca os dados de outra conta. display_id e conversation_display_id são sequências por conta (contas diferentes podem ter o mesmo #42).

Wrapper do corpo e paginação

Recursos de escrita esperam o corpo dentro de um wrapper com o nome do recurso (ex.: pipeline_card, pipeline_automation, pipeline_webhook, campaign). A paginação varia por endpoint: a maioria usa page/per_page com envelope { data, meta }; algumas rotas legacy usam limit/offset ou retornam { payload }. Cada página de recurso documenta o formato específico.

Platform API

Gerenciamento de contas, usuários e configurações da plataforma.

/platform/api/v1/accounts

Criar uma conta

/platform/api/v1/accounts/{id}

Obter detalhes da conta

/platform/api/v1/accounts/{id}

Atualizar conta

/platform/api/v1/accounts/{id}

Deletar conta

Conversas

Gerenciar conversas com clientes nos canais habilitados.

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

Listar conversas

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

Criar conversa

/api/v1/accounts/{id}/conversations/{conv_id}

Obter conversa

/api/v1/accounts/{id}/conversations/{conv_id}/toggle_status

Alterar status

Mensagens

Enviar e receber mensagens nas conversas.

/api/v1/accounts/{id}/conversations/{conv_id}/messages

Listar mensagens

/api/v1/accounts/{id}/conversations/{conv_id}/messages

Enviar mensagem

/api/v1/accounts/{id}/conversations/{conv_id}/messages/{msg_id}

Deletar mensagem

Contatos

CRUD de contatos e sincronização com CRM.

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

Listar contatos

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

Criar contato

/api/v1/accounts/{id}/contacts/{contact_id}

Obter contato

/api/v1/accounts/{id}/contacts/{contact_id}

Atualizar contato

Caixas de Entrada

Gerenciar canais de atendimento habilitados (WhatsApp, web e outros).

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

Listar inboxes

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

Criar inbox

/api/v1/accounts/{id}/inboxes/{inbox_id}

Atualizar inbox

Equipes e Agentes

Gerenciar equipes de atendimento e agentes.

/api/v1/accounts/{id}/teams

Listar equipes

/api/v1/accounts/{id}/teams

Criar equipe

/api/v1/accounts/{id}/agents

Listar agentes

Automações

Regras de automação, bots e respostas automáticas.

/api/v1/accounts/{id}/automation_rules

Listar regras de automação

/api/v1/accounts/{id}/automation_rules

Criar regra

Webhooks

Configurar notificações de eventos via HTTP.

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

Listar webhooks

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

Criar webhook

/api/v1/accounts/{id}/webhooks/{webhook_id}

Atualizar webhook

/api/v1/accounts/{id}/webhooks/{webhook_id}

Deletar webhook

Relatórios

Métricas e relatórios de atendimento.

/api/v2/accounts/{id}/reports/agents

Relatório de agentes

/api/v2/accounts/{id}/reports/conversations

Relatório de conversas

Pipeline (CRM)

Pipeline de vendas com estágios, cards (deals), automações e lead scoring.

/api/v1/accounts/{id}/pipelines

Listar pipelines

/api/v1/accounts/{id}/pipeline_cards

Criar card (deal)

/api/v1/accounts/{id}/pipeline_cards/{card_id}/move_to_stage

Mover card

/api/v1/accounts/{id}/pipeline/cards/{card_id}/deal_status/mark_won

Marcar como ganho

Follow-ups

Acompanhamento automático de conversas com templates e automações.

/api/v1/accounts/{id}/conversations/{conv_id}/follow-ups

Listar follow-ups

/api/v1/accounts/{id}/conversations/{conv_id}/follow-ups

Criar follow-up

/api/v1/accounts/{id}/follow-up-templates

Listar templates

/api/v1/accounts/{id}/follow-up-automations

Criar automação

Atividades

Tarefas e atividades do pipeline: ligações, reuniões, e-mails.

/api/v1/accounts/{id}/pipeline/activities

Listar atividades

/api/v1/accounts/{id}/pipeline/activities

Criar atividade

/api/v1/accounts/{id}/pipeline/activities/{act_id}/complete

Concluir atividade

Lead Scoring

Pontuação automática de leads com regras e analytics.

/api/v1/accounts/{id}/lead_score_rules

Listar regras

/api/v1/accounts/{id}/lead_score_rules

Criar regra

/api/v1/accounts/{id}/pipeline_cards/{card_id}/recalculate_score

Recalcular score

Pipeline Analytics

Dashboard, win rate, velocidade de vendas e performance da equipe.

/api/v1/accounts/{id}/pipeline/analytics/dashboard

Dashboard completo

/api/v1/accounts/{id}/pipeline/analytics/win_rate

Win rate

/api/v1/accounts/{id}/pipeline/analytics/sales_velocity

Velocidade de vendas

Campanhas

Campanhas de marketing e broadcast via WhatsApp e outros canais.

/api/v1/accounts/{id}/campaigns

Listar campanhas

/api/v1/accounts/{id}/campaigns

Criar campanha

SLA

Políticas de nível de serviço e monitoramento de conformidade.

/api/v1/accounts/{id}/sla_policies

Listar políticas SLA

/api/v1/accounts/{id}/sla_policies

Criar política

/api/v1/accounts/{id}/applied_slas/metrics

Métricas SLA

WAHA

Integração WhatsApp self-hosted: sessões, QR code e configurações.

/api/v1/accounts/{id}/waha/{inbox_id}/status

Status da sessão

/api/v1/accounts/{id}/waha/{inbox_id}/refresh_qr

Gerar QR code

/api/v1/accounts/{id}/waha/{inbox_id}/reconnect

Reconectar

Atendimentos

Agendamentos clínicos e de serviços: CRUD, confirmação, reagendamento, disponibilidade e exportação.

/api/v1/accounts/{id}/appointments

Listar atendimentos

/api/v1/accounts/{id}/appointments

Criar atendimento

/api/v1/accounts/{id}/appointments/{apt_id}/confirm

Confirmar atendimento

/api/v1/accounts/{id}/appointments/availability

Verificar disponibilidade

Profissionais

Profissionais que executam os serviços, com horários de atendimento e disponibilidade.

/api/v1/accounts/{id}/professionals

Listar profissionais

/api/v1/accounts/{id}/professionals

Criar profissional

/api/v1/accounts/{id}/professionals/{prof_id}/availability

Disponibilidade por data

Serviços

Catálogo de serviços com duração, preço e templates de lembrete.

/api/v1/accounts/{id}/services

Listar serviços

/api/v1/accounts/{id}/services

Criar serviço

/api/v1/accounts/{id}/services/{svc_id}

Consultar serviço e templates

Parceiros

Convênios, seguros e planos de saúde vinculados aos atendimentos.

/api/v1/accounts/{id}/partners

Listar parceiros

/api/v1/accounts/{id}/partners

Criar parceiro

/api/v1/accounts/{id}/partners/{partner_id}

Atualizar parceiro