[
  {
    "id": "conversation-id-1",
    "title": "Conversa com Cliente",
    "status": "UNRESOLVED",
    "channel": "whatsapp",
    "channelExternalId": "+5511999999999",
    "agent": {
      "id": "agent-id",
      "name": "Nome do Agente",
      "iconUrl": "https://exemplo.com/icon.png",
      "handle": "@agent_handle"
    },
    "contactInfo": {
      "phoneNumber": "+5511999999999",
      "name": "Nome do Cliente",
      "email": "cliente@exemplo.com"
    },
    "messages": [
      {
        "id": "message-id-1",
        "text": "Olá, como posso ajudar?",
        "from": "agent",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "read": true,
        "attachments": []
      }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]

​
Listar Conversas do Usuário

Este endpoint permite listar e filtrar conversas do usuário no sistema. Você pode usar vários parâmetros de consulta para filtrar os resultados conforme necessário.

​
Casos de uso

  • Obter histórico de conversas do usuário para análise
  • Filtrar conversas por canal de comunicação
  • Buscar conversas por período específico
  • Exportar conversas para análise ou backup

​
Parâmetros de consulta

ParâmetroTipoDescrição
agentIdstringFiltrar por ID do agente
channelstringFiltrar por canal de conversação (whatsapp, dashboard, website, slack, crisp, mail, zapier, api, telegram)
channelExternalIdstringFiltrar por ID externo do canal (ex: número de telefone para WhatsApp)
searchstringBuscar em títulos de conversas, informações de contato e conteúdo das mensagens
startDatestringFiltrar conversas a partir desta data (formato ISO 8601)
endDatestringFiltrar conversas até esta data (formato ISO 8601)
fullConversationbooleanIncluir histórico completo da conversa (true) ou apenas resumo (false)
simplifiedbooleanRetornar dados simplificados da conversa com apenas informações essenciais

​
Exemplos de código

const fetchUserConversations = async () => {
  const response = await fetch('https://dash.superagentes.ai/api/user-conversations?channel=whatsapp&startDate=2024-01-01T00:00:00Z', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${seu_token_jwt}`,
      'Content-Type': 'application/json'
    }
  });
  
  const data = await response.json();
  return data;
};

​
Exemplo de resposta

[
  {
    "id": "conversation-id-1",
    "title": "Conversa com Cliente",
    "status": "UNRESOLVED",
    "channel": "whatsapp",
    "channelExternalId": "+5511999999999",
    "agent": {
      "id": "agent-id",
      "name": "Nome do Agente",
      "iconUrl": "https://exemplo.com/icon.png",
      "handle": "@agent_handle"
    },
    "contactInfo": {
      "phoneNumber": "+5511999999999",
      "name": "Nome do Cliente",
      "email": "cliente@exemplo.com"
    },
    "messages": [
      {
        "id": "message-id-1",
        "text": "Olá, como posso ajudar?",
        "from": "agent",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "read": true,
        "attachments": []
      }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]