Listar Conversas
O comando Conversas retorna a lista de conversas (chats) recentes do dispositivo WhatsApp, incluindo conversas individuais e em grupo. Suporta paginação.Este comando está disponível apenas em canais do provider Z-API. Canais
whatsapp-web
(provider whatsmeow) não implementam GET_CHATS: o comando é aceito com 200 OK, mas
nenhum GET_CHATS_RESPONSE será entregue no webhook.Requisição
POST /api/v1/message/SendCommand
{
"channelId": "uuid-do-canal",
"content": {
"type": "GET_CHATS",
"commandType": "GET_CHATS",
"page": 1,
"pageSize": 10
}
}
Campos
| Campo | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
page | integer | Não | 1 | Número da página (inicio em 1) |
pageSize | integer | Não | 10 | Quantidade de conversas por página |
Resposta da API
{
"packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Webhook de resposta
O resultado é entregue via webhook do tipoGET_CHATS_RESPONSE:
{
"packageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"channelId": "uuid-do-canal",
"content": {
"type": "GET_CHATS_RESPONSE",
"chats": [
{
"jid": "5511999887766@s.whatsapp.net",
"name": "João Silva",
"isGroup": false,
"unreadCount": 3,
"lastMessageTime": "2025-04-14T10:30:00Z"
},
{
"jid": "120363012345678901@g.us",
"name": "Equipe de Vendas",
"isGroup": true,
"unreadCount": 12,
"lastMessageTime": "2025-04-14T10:15:00Z"
},
{
"jid": "5521988776655@s.whatsapp.net",
"name": "Maria Santos",
"isGroup": false,
"unreadCount": 0,
"lastMessageTime": "2025-04-13T18:45:00Z"
}
],
"count": 3
}
}
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
chats | array | Lista de conversas |
chats[].jid | string | Identificador único da conversa (JID) |
chats[].name | string | Nome do contato ou grupo |
chats[].isGroup | boolean | true se for um grupo, false se for conversa individual |
chats[].unreadCount | integer | Número de mensagens não lidas |
chats[].lastMessageTime | string (ISO 8601) | Data e hora da última mensagem na conversa |
count | integer | Total de conversas retornadas |
Exemplo completo
curl -X POST https://api-dev.messagefy.io/api/v1/message/SendCommand \
-H "Content-Type: application/json" \
-H "X-API-KEY: sua-api-key" \
-d '{
"channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"content": {
"type": "GET_CHATS",
"commandType": "GET_CHATS",
"page": 1,
"pageSize": 20
}
}'
import requests
response = requests.post(
"https://api-dev.messagefy.io/api/v1/message/SendCommand",
headers={
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key"
},
json={
"channelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"content": {
"type": "GET_CHATS",
"commandType": "GET_CHATS",
"page": 1,
"pageSize": 20
}
}
)
print(response.json())
const response = await fetch(
"https://api-dev.messagefy.io/api/v1/message/SendCommand",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-KEY": "sua-api-key",
},
body: JSON.stringify({
channelId: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
content: {
type: "GET_CHATS",
commandType: "GET_CHATS",
page: 1,
pageSize: 20,
},
}),
}
);
const data = await response.json();
console.log(data);
Use o
jid retornado nas conversas para buscar mensagens específicas com o comando
Últimas Mensagens.