curl -X GET "https://suasofia.online/api/user/conversations?type=widget&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://suasofia.online/api/user/conversations?type=widget&per_page=10',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data.data); // Array de conversas
import requests
response = requests.get(
'https://suasofia.online/api/user/conversations',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'type': 'widget',
'per_page': 10
}
)
data = response.json()
print(data['data'])
{
"current_page": 1,
"data": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"assistant_name": "Assistente de Suporte",
"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": "Assistente de Suporte",
"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": "« Anterior",
"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
}
Conversas
Listar Conversas
Liste todas as conversas do usuário autenticado com filtragem e paginação
GET
/
user
/
conversations
curl -X GET "https://suasofia.online/api/user/conversations?type=widget&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://suasofia.online/api/user/conversations?type=widget&per_page=10',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data.data); // Array de conversas
import requests
response = requests.get(
'https://suasofia.online/api/user/conversations',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'type': 'widget',
'per_page': 10
}
)
data = response.json()
print(data['data'])
{
"current_page": 1,
"data": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"assistant_name": "Assistente de Suporte",
"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": "Assistente de Suporte",
"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": "« Anterior",
"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 isso para exibir o histórico de conversas, filtrar por tipo ou integrar com seu CRM.
Este endpoint requer autenticação. Passe sua chave de API no cabeçalho
Authorization como um token Bearer.Parâmetros de Consulta
string
Filtrar conversas por tipo. Valores possíveis:
test, widget, whatsapp, apiinteger
Filtrar conversas por ID do assistente (deve pertencer ao usuário autenticado)
string
Filtrar conversas a partir desta data (formato YYYY-MM-DD)
string
Filtrar conversas até esta data (formato YYYY-MM-DD)
integer
Número de conversas por página (1-100, padrão: 15)
integer
Número da página (padrão: 1)
Campos de Resposta
array
Show propriedades
Show propriedades
string
O identificador UUID único da conversa
string
O UUID do assistente que está gerenciando esta conversa
string
O nome do assistente que está gerenciando esta conversa
string
O tipo de conversa:
test, widget, whatsapp ou apiinteger
Número total de mensagens na conversa
number
O custo total da conversa em USD
boolean
Se as respostas de IA estão habilitadas para esta conversa
string
A data e hora em que a conversa foi criada
string
A data e hora em que a conversa foi atualizada pela última vez
integer
O número da página atual
integer
Número de itens por página
integer
Número total de conversas que correspondem aos critérios
integer
O número da última página
curl -X GET "https://suasofia.online/api/user/conversations?type=widget&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://suasofia.online/api/user/conversations?type=widget&per_page=10',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data.data); // Array de conversas
import requests
response = requests.get(
'https://suasofia.online/api/user/conversations',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={
'type': 'widget',
'per_page': 10
}
)
data = response.json()
print(data['data'])
{
"current_page": 1,
"data": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"assistant_name": "Assistente de Suporte",
"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": "Assistente de Suporte",
"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": "« Anterior",
"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 na web |
whatsapp | Conversas do WhatsApp Business |
api | Conversas criadas via API |
Casos de Uso
- Painel de Análise: Exibir métricas e tendências de conversas
- Integração com CRM: Sincronizar dados de conversas com seu banco de dados de clientes
- Monitoramento de Qualidade: Revisar volumes de conversas por tipo e assistente
- Revisão de Cobrança: Rastrear custos de conversas em toda a sua organização

