Documentação da API
Construa integrações poderosas com a API REST completa do Klivo Chat. Automatize fluxos de trabalho, gerencie conversas e estenda a plataforma para as necessidades do seu negócio.
Autenticação
Como gerar e usar o token de acesso em todas as requisições.
Leitura essencial
Conversas
Liste, crie, atualize e gerencie o status de conversas.
6 endpoints
Contatos
Gerencie sua base de clientes via API.
7 endpoints
Mensagens
Envie e liste mensagens em conversas existentes.
3 endpoints
Webhooks
Receba notificações em tempo real de eventos da plataforma.
4 endpoints
Agentes
Gerencie agentes e suas permissões programaticamente.
4 endpoints
Base URL
Todas as requisições à API do Klivo Chat devem usar a seguinte URL base:
Base URL
https://chat.klivo.marketing/api/v1
Como funciona a autenticação?
A API usa autenticação por token. Você precisa incluir o header api_access_token em todas as requisições. O token é pessoal e pode ser obtido nas Configurações de Perfil da plataforma.
Exemplo básico
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations \
--header 'api_access_token: SEU_TOKEN_AQUI'
Não sabe seu account_id? Ele aparece na URL do painel do Klivo Chat quando você está logado: https://chat.klivo.marketing/app/accounts/123/
Formatos de resposta
Todas as respostas são retornadas em JSON. O header Content-Type: application/json é obrigatório em requisições com body (POST, PATCH, PUT).
Códigos de status HTTP
- 200 OK — Requisição bem sucedida.
- 201 Created — Recurso criado com sucesso.
- 400 Bad Request — Parâmetros inválidos ou ausentes.
- 401 Unauthorized — Token ausente, inválido ou sem permissão.
- 404 Not Found — Recurso não encontrado.
- 422 Unprocessable Entity — Dados inválidos no body.
- 429 Too Many Requests — Limite de requisições atingido.
- 500 Internal Server Error — Erro interno do servidor.