Introdução

A TopTalking é uma plataforma de atendimento no WhatsApp com CRM (Kanban) e agentes de IA. A API da TopTalking deixa o seu sistema — ou a sua IA — fazer pelo código o que a equipe faz no painel: enviar mensagens, criar e atualizar contatos, ler o histórico de conversas, mover cards no Kanban, agendar mensagens e receber eventos em tempo real.

O que dá para construir

Avisos automáticos: confirmação de pedido, boleto, código de rastreio, lembrete de consulta.
Captura de leads: quem preenche o formulário do seu site vira contato no painel, já na etapa certa do Kanban, e recebe uma mensagem de boas-vindas.
Sincronização com o seu CRM ou ERP: quando o card muda de etapa na TopTalking, o seu sistema fica sabendo (webhook) — e vice-versa.
Painéis e relatórios próprios: liste conversas, etapas e mensagens para montar o seu dashboard.
Agentes de IA: conecte o Claude, o Cursor ou o ChatGPT à sua conta para consultar conversas e enviar mensagens com supervisão.
Automações sem código: n8n, Make e Zapier conversam com a API por HTTP e recebem os webhooks.

Quatro jeitos de integrar

API RESTEndpoints HTTP + JSON em https://platform.toptalking.com.br/v1.

WebhooksA TopTalking avisa o seu sistema quando algo acontece (mensagem recebida, etapa alterada…).

Servidor MCPFerramentas prontas para Claude, Cursor, VS Code e Windsurf usarem a sua conta.

llms.txt e promptsA documentação em texto puro e prompts prontos para Lovable, Claude, ChatGPT e outros.

Conceitos

Conceito	O que é	Objeto na API
Organização	A empresa (conta) na TopTalking. Toda chave de API pertence a uma organização e só enxerga os dados dela.	`organization` (em `GET /me`)
Canal	Por onde as conversas acontecem: um número de WhatsApp conectado por QR Code (`whatsapp`) ou o Chat do site (`webchat`). Só canais com status `connected` enviam mensagens. Dá para conectar um WhatsApp pela API.	`channel`
Contato	Uma conversa da caixa de entrada: um por número de telefone e canal. Guarda nome, telefone, e-mail, etapa do Kanban, responsável, agente de IA e se a IA está ligada.	`contact`
Grupo	Um grupo do WhatsApp. Também é uma conversa: o `id` do grupo é um `contact_id`.	`group`
Mensagem	Uma mensagem da conversa, recebida (`inbound`) ou enviada (`outbound`), com texto e/ou mídia e status de entrega.	`message`
Etapa	Uma coluna do Kanban (funil). Cada contato está em no máximo uma etapa. A etapa final (`is_final: true`, “Finalizado”) encerra a conversa.	`stage`
Mensagem agendada	Uma mensagem programada para sair em data e hora definidas — a mesma da Agenda do painel.	`scheduled_message`
Membro	Uma pessoa da equipe (dono, administrador ou atendente). Pode ser responsável por conversas.	`member`
Agente de IA	Um assistente que responde as conversas sozinho. Um deles é o padrão da organização.	`ai_agent`
Campanha	Um disparo para muitos contatos pelo WhatsApp Oficial (API da Meta), com um template aprovado e revisão da TopTalking.	`campaign`
Webhook	Um endereço HTTPS do seu sistema que recebe eventos da conta.	`webhook_endpoint`
Chave de API	A credencial (`tt_live_...`) que o seu backend usa para chamar a API e o MCP.	`api_key` (em `GET /me`)

Tudo o que a API faz aparece no painel como se a equipe tivesse feito: uma mensagem enviada pela API aparece no chat, um contato criado pela API aparece na caixa de entrada e um card movido pela API muda de coluna no Kanban.

Convenções

URL base: https://platform.toptalking.com.br/v1
Formato: JSON em UTF-8, nos pedidos e nas respostas (Content-Type: application/json).
Datas: ISO 8601 com fuso horário (ex.: 2026-11-11T14:30:00Z ou 2026-11-11T11:30:00-03:00).
IDs: UUID (ex.: 3f1c2b9a-7d4e-4c55-8a0e-1b2c3d4e5f60).
Tipo do objeto: todo recurso tem o campo object (contact, message, list…), útil para saber o que você recebeu.
Telefones: envie com DDI e DDD. A formatação é ignorada (só os dígitos contam) e números brasileiros sem 55 recebem o 55. As respostas trazem só dígitos, ex.: 5511999998888.
Rastreio: toda resposta tem o cabeçalho X-Request-Id. Guarde-o nos seus logs — ele ajuda o suporte a encontrar a sua requisição.

Próximo passo

Siga o Início rápido para gerar a chave e enviar a sua primeira mensagem.