💡 Exemplos de uso da API
A seguir, os cenários de integração mais comuns usando a API do Klivo Chat. Para a referência completa de todos os endpoints, acesse devchat.klivo.marketing.
1. Criar uma conversa automaticamente
Útil para abrir uma conversa quando um lead preenche um formulário no seu site, por exemplo.
Requisição — POST /api/v1/accounts/{account_id}/conversations
- inbox_id: ID da caixa de entrada (WhatsApp, chat, etc.)
- contact_id: ID do contato no Klivo Chat
- assignee_id: ID do agente responsável (opcional)
2. Enviar uma mensagem via API
Ideal para enviar notificações ou mensagens automáticas em conversas existentes.
Requisição — POST /api/v1/accounts/{account_id}/conversations/{id}/messages
- content: texto da mensagem
- message_type:
outgoingpara mensagem ao cliente - private:
truepara nota privada (só a equipe vê)
3. Buscar contato e ver histórico
Consulte os dados de um cliente e todas as conversas anteriores antes de ligar ou enviar uma campanha.
Requisição — GET /api/v1/accounts/{account_id}/contacts/search?q=email@empresa.com
- Retorna lista de contatos que correspondem ao termo buscado
- Use o
idretornado para consultar as conversas:/contacts/{id}/conversations
4. Atualizar status de uma conversa
Resolve automaticamente conversas após uma integração ser concluída (ex: pedido entregue).
Requisição — POST /api/v1/accounts/{account_id}/conversations/{id}/toggle_status
- status:
resolvedpara encerrar,openpara reabrir
5. Receber eventos via webhook
Em vez de consultar a API repetidamente, configure um webhook para receber eventos em tempo real no seu sistema.
Configurar em — POST /api/v1/accounts/{account_id}/webhooks
- url: seu endpoint HTTPS
- subscriptions: lista de eventos a receber
Documentação completa no portal de desenvolvedores
Acesse devchat.klivo.marketing para ver todos os endpoints com exemplos.