🔌 O que é a API do Klivo Chat?
A API REST do Klivo Chat permite que sistemas externos se comuniquem diretamente com a plataforma de forma programática. Com ela você pode criar conversas, enviar mensagens, gerenciar contatos, atribuir agentes, configurar webhooks e muito mais — sem precisar acessar a interface manualmente.
É o recurso ideal para integrar o Klivo Chat com CRMs, ERPs, plataformas de e-commerce, sistemas próprios ou ferramentas como N8N, Make e Zapier.
Documentação técnica completa com todos os endpoints, parâmetros e exemplos de código em devchat.klivo.marketing →
📋 O que você pode fazer com a API
- Conversas: listar, criar, atualizar status, atribuir agentes e adicionar labels.
- Mensagens: enviar e listar mensagens, incluindo notas privadas.
- Contatos: criar, buscar, atualizar e visualizar o histórico completo.
- Agentes e Equipes: gerenciar membros da equipe e grupos de trabalho.
- Webhooks: receber notificações automáticas de eventos da plataforma.
- Relatórios: consultar métricas de atendimento e CSAT.
- Caixas de Entrada: listar canais e seus agentes responsáveis.
🔑 Obtendo o token de acesso
Toda requisição à API precisa de autenticação via token pessoal vinculado ao seu usuário.
Faça login no Klivo Chat
Acesse chat.klivo.marketing com seu e-mail e senha.
Acesse Configurações de Perfil
Clique no seu avatar no canto inferior esquerdo e selecione Configurações de Perfil.
Copie o Token de Acesso
Role até o final da página. O token é exibido no campo Token de Acesso. Copie e guarde em local seguro.
Nunca compartilhe seu token publicamente. Qualquer pessoa com o token pode acessar sua conta com suas permissões. Se suspeitar de comprometimento, faça logout — o token anterior é invalidado imediatamente.
🆔 Encontrando seu account_id
O account_id aparece na URL do painel quando você está logado:
https://chat.klivo.marketing/app/accounts/123/conversations
O número após /accounts/ é o seu account_id. Ele é necessário em quase todos os endpoints.
📡 Usando o token nas requisições
Inclua o token no header api_access_token de todas as requisições:
Exemplo — Listar conversas abertas
- Método: GET
- URL: https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations?status=open
- Header: api_access_token: SEU_TOKEN_AQUI
📊 Códigos de resposta
- 200 OK: requisição bem-sucedida.
- 201 Created: recurso criado com sucesso.
- 401 Unauthorized: token ausente, inválido ou sem permissão.
- 404 Not Found: recurso não encontrado.
- 429 Too Many Requests: limite de 20 requisições por segundo atingido.
❓ Perguntas Frequentes
Preciso saber programar para usar a API?
Para uso direto via código, sim.
Posso usar a API para enviar mensagens em massa?
Para envios em massa via WhatsApp, use o recurso de Campanhas, desenvolvido especificamente para esse caso. A API de mensagens é indicada para automações pontuais e integrações em tempo real.