curl "https://crm.vistum.com.br/api/v1/conversations/conv_1" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": {
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z",
"messages": [
{ "id": "msg_9", "direction": "out", "type": "text", "body": "Bom dia! Tudo certo?", "timestamp": "2026-07-21T17:50:00.000Z", "status": "delivered" },
{ "id": "msg_8", "direction": "in", "type": "image", "body": "segue o comprovante", "timestamp": "2026-07-21T17:48:00.000Z", "status": "received", "mediaUrl": "https://cdn.vistum.com.br/media/..." }
]
},
"pagination": { "total": 2, "limit": 100, "offset": 0, "hasMore": false }
}
Conversas e Mensagens
Ver conversa
Retorna uma conversa com suas mensagens paginadas (mais recentes primeiro).
GET
/
api
/
v1
/
conversations
/
{id}
curl "https://crm.vistum.com.br/api/v1/conversations/conv_1" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": {
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z",
"messages": [
{ "id": "msg_9", "direction": "out", "type": "text", "body": "Bom dia! Tudo certo?", "timestamp": "2026-07-21T17:50:00.000Z", "status": "delivered" },
{ "id": "msg_8", "direction": "in", "type": "image", "body": "segue o comprovante", "timestamp": "2026-07-21T17:48:00.000Z", "status": "received", "mediaUrl": "https://cdn.vistum.com.br/media/..." }
]
},
"pagination": { "total": 2, "limit": 100, "offset": 0, "hasMore": false }
}
Autenticação
string
required
Bearer vg_live_<sua_chave> — API Key com escopo conversations:readlimit das mensagens tem teto 100 (padrão 100); offset disponível.
curl "https://crm.vistum.com.br/api/v1/conversations/conv_1" \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"data": {
"id": "conv_1",
"contact": { "id": "cnt_cmnl5abc123", "name": "João Ferreira", "phone": "5511999887766" },
"instanceId": "inst_a1",
"channel": "whatsapp",
"status": "open",
"lastMessageAt": "2026-07-21T17:50:00.000Z",
"createdAt": "2026-07-20T09:00:00.000Z",
"messages": [
{ "id": "msg_9", "direction": "out", "type": "text", "body": "Bom dia! Tudo certo?", "timestamp": "2026-07-21T17:50:00.000Z", "status": "delivered" },
{ "id": "msg_8", "direction": "in", "type": "image", "body": "segue o comprovante", "timestamp": "2026-07-21T17:48:00.000Z", "status": "received", "mediaUrl": "https://cdn.vistum.com.br/media/..." }
]
},
"pagination": { "total": 2, "limit": 100, "offset": 0, "hasMore": false }
}
direction é in (recebida) ou out (enviada). mediaUrl só aparece quando a mídia tem URL externa https — referências internas de storage nunca são expostas.