Klivo Chat API › Application APIs

Mensagens

Envie e liste mensagens em conversas existentes do Klivo Chat.

ℹ️

Para enviar mensagens via API, a conversa precisa já existir. Use o endpoint Criar Conversa primeiro se necessário.

GET

Listar Mensagens

Retorna todas as mensagens de uma conversa.

GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
Parâmetros de Path
account_id integer obrigatório
ID da conta.
conversation_id integer obrigatório
ID da conversa.
CURL 
curl --request GET \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'api_access_token: '
200 
{
  "payload": [
    {
      "id": 101,
      "content": "Olá, preciso de ajuda!",
      "message_type": 0,
      "content_type": "text",
      "private": false,
      "created_at": 1716000000,
      "sender": {
        "id": 17,
        "name": "João Silva",
        "type": "contact"
      }
    }
  ]
}
POST

Enviar Mensagem

Envia uma nova mensagem em uma conversa.

POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
Parâmetros de Path
account_id integer obrigatório
ID da conta.
conversation_id integer obrigatório
ID da conversa.
Body Parameters
content string obrigatório
Conteúdo da mensagem.
message_type string
Tipo: outgoing (enviada pelo agente, padrão) ou activity.
private boolean
Se true, é uma nota privada (não visível ao cliente). Padrão: false.
content_type string
Tipo do conteúdo: text (padrão), input_select, cards.
CURL 
curl --request POST \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'api_access_token: ' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "Olá! Como posso te ajudar?",
  "message_type": "outgoing",
  "private": false
}'
200 
{
  "id": 102,
  "content": "Olá! Como posso te ajudar?",
  "message_type": 1,
  "private": false,
  "created_at": 1716000100
}
DELETE

Deletar Mensagem

Deleta uma mensagem de uma conversa. Apenas mensagens enviadas pelo agente podem ser deletadas.

DELETE
https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{id}
Parâmetros de Path
account_id integer obrigatório
ID da conta.
conversation_id integer obrigatório
ID da conversa.
id integer obrigatório
ID da mensagem.
CURL 
curl --request DELETE \
  --url https://chat.klivo.marketing/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{id} \
  --header 'api_access_token: '
200 
{
  "message": "Message deleted"
}