Listar Conversas

Listar todas as conversas do usuário autenticado com filtragem e paginação

GET https://suasofia.online/api//user/conversations

cURL

curl -X GET "https://suasofia.online/api/user/conversations?type=widget&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "current_page": 1,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "widget",
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "whatsapp",
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45"
    }
  ],
  "first_page_url": "https://suasofia.online/api/user/conversations?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://suasofia.online/api/user/conversations?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://suasofia.online/api/user/conversations?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://suasofia.online/api/user/conversations?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://suasofia.online/api/user/conversations?page=2",
  "path": "https://suasofia.online/api/user/conversations",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15,
  "total": 68
}

Este endpoint retorna uma lista paginada de conversas pertencentes aos assistentes do usuário autenticado. Use isto para exibir o histórico de conversas, filtrar por tipo ou integrar com seu CRM.

Este endpoint requer autenticação. Passe sua chave API no cabeçalho Authorization como um token Bearer.

Parâmetros de Consulta

type · string

Filtrar conversas por tipo. Valores possíveis: test, widget, whatsapp, api

assistant_id · integer

Filtrar conversas por ID do assistente (deve pertencer ao usuário autenticado)

date_from · string

Filtrar conversas a partir desta data (formato YYYY-MM-DD)

date_to · string

Filtrar conversas até esta data (formato YYYY-MM-DD)

per_page · integer

Número de conversas por página (1-100, padrão: 15)

page · integer

Número da página (padrão: 1)

Campos da Resposta

data · array

Show properties

id · string

O identificador UUID único da conversa

assistant_id · string

O UUID do assistente que gerencia esta conversa

assistant_name · string

O nome do assistente que gerencia esta conversa

type · string

O tipo da conversa: test, widget, whatsapp ou api

message_count · integer

Número total de mensagens na conversa

total_cost · number

O custo total da conversa em USD

ai_enabled · boolean

Se as respostas de IA estão habilitadas para esta conversa

created_at · string

A data e hora quando a conversa foi criada

updated_at · string

A data e hora quando a conversa foi atualizada pela última vez

current_page · integer

O número da página atual

per_page · integer

Número de itens por página

total · integer

Número total de conversas que correspondem aos critérios

last_page · integer

O número da última página

cURL

curl -X GET "https://suasofia.online/api/user/conversations?type=widget&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 Response

{
  "current_page": 1,
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "widget",
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistant",
      "type": "whatsapp",
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45"
    }
  ],
  "first_page_url": "https://suasofia.online/api/user/conversations?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://suasofia.online/api/user/conversations?page=5",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    },
    {
      "url": "https://suasofia.online/api/user/conversations?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": "https://suasofia.online/api/user/conversations?page=2",
      "label": "2",
      "active": false
    }
  ],
  "next_page_url": "https://suasofia.online/api/user/conversations?page=2",
  "path": "https://suasofia.online/api/user/conversations",
  "per_page": 15,
  "prev_page_url": null,
  "to": 15,
  "total": 68
}

Tipos de Conversa

Tipo	Descrição
test	Conversas de teste internas da interface de teste do assistente
widget	Conversas do widget de chat da web
whatsapp	Conversas do WhatsApp Business
api	Conversas criadas via API

Casos de Uso

• Dashboard de Análises: Exibir métricas e tendências de conversas
• Integração com CRM: Sincronizar dados de conversas com sua base de clientes
• Monitoramento de Qualidade: Revisar volumes de conversas por tipo e assistente
• Revisão de Cobrança: Acompanhar custos de conversas em sua organização