Chats
Gerencie chats de WhatsApp com a Wazend: listar, arquivar, excluir, marcar como lido, fixar mensagens e mais.
Métodos para gerenciar chats e mensagens de WhatsApp.
{session}— nome da sua sessão (aparece no Dashboard, por exemploS0001).{chatId}— ID do chat no formato123123123123@c.us(direto) ou123123123123@g.us(grupo).
Obter todos os chats
GET /api/{session}/chatsParâmetros de consulta:
GET /api/{session}/chats?limit=100&offset=0&sortBy=messageTimestamp&sortOrder=desclimit=100— limita o número de chats a retornar.offset=0— ignora N chats desde o início.sortBy— ordena por campo:messageTimestamp(última mensagem),idouname.sortOrder—desc(novos primeiro) ouasc(antigos primeiro).
Dica
Se você vir timeout ou a requisição demorar muito, use limit para obter os objetos em partes menores.
Obter resumo de chats
A API que quase todo cliente de interface de chat precisa.
GET /api/{session}/chats/overview?limit=20&offset=0limit/offset— paginação.ids=11111&ids=9999@c.us— filtra por ID ou número de telefone.
Use POST se você tiver muitos chats (>400) no filtro ids:
POST /api/{session}/chats/overview{
"pagination": { "limit": 20, "offset": 0 },
"filter": { "ids": ["5215551234567@c.us"] }
}[
{
"id": "5215551234567@c.us",
"name": "Juan Pérez",
"picture": "https://ejemplo.com/foto.jpg",
"lastMessage": {
"id": "true_5215551234567@c.us_AAAA",
"timestamp": 1667561485,
"from": "5215551234567@c.us",
"fromMe": true,
"body": "Olá"
}
}
]Obter foto do chat
GET /api/{session}/chats/{chatId}/picture?refresh=true{ "url": "https://ejemplo.com/foto.jpg" }url pode ser null se o chat não tiver foto. refresh=true força a atualização (cacheada por 24 h).
Arquivar / desarquivar chat
POST /api/{session}/chats/{chatId}/archivePOST /api/{session}/chats/{chatId}/unarchiveMarcar chat como não lido
POST /api/{session}/chats/{chatId}/unreadExcluir chat
DELETE /api/{session}/chats/{chatId}Marcar mensagens como lidas
Marca todas as mensagens não lidas do chat como lidas (duplo check azul).
POST /api/{session}/chats/{chatId}/messages/read{ "messages": 30, "days": 7 }{
"ids": [
"false_5215551234567@c.us_AAAA",
"true_5215551234567@c.us_BBBB"
]
}messages— quantas mensagens ler (padrão 30 em chats diretos, 100 em grupos).days— quantos dias ler (padrão 7).
Obter mensagens
GET /api/{session}/chats/{chatId}/messages?limit=10Parâmetros disponíveis:
downloadMedia=true— baixar arquivos de mídia.limit/offsetpaginação.filter.timestamp.gte/filter.timestamp.lte— filtrar por timestamp.filter.fromMe=false— excluir mensagens próprias.filter.ack— filtrar por estado de confirmação:ERROR(-1),PENDING(0),SERVER(1),DEVICE(2),READ(3),PLAYED(4).
[
{
"id": "false_5215551234567@c.us_AAAAAA",
"timestamp": 1727745026,
"from": "5215551234567@c.us",
"fromMe": false,
"body": "Olá!",
"hasMedia": false,
"ack": 3,
"ackName": "READ",
"replyTo": null
}
]Obter mensagem por id
GET /api/{session}/chats/{chatId}/messages/{messageId}?downloadMedia=trueFixar / desfixar mensagem
POST /api/{session}/chats/{chatId}/messages/{messageId}/pin{
"duration": 86400
}Duração: 24 horas = 86400, 7 dias = 604800, 30 dias = 2592000.
POST /api/{session}/chats/{chatId}/messages/{messageId}/unpinEditar mensagem
PUT /api/{session}/chats/{chatId}/messages/{messageId}{ "text": "Mensagem editada" }Informação
Lembre-se de escapar @ com %40 em chatId e messageId.
Excluir mensagem
DELETE /api/{session}/chats/{chatId}/messages/{messageId}Excluir todas as mensagens
DELETE /api/{session}/chats/{chatId}/messagesEventos
Receba eventos de chats mediante Eventos. O evento chat.archive é disparado quando um chat é arquivado ou desarquivado (consulte o detalhe do payload na página de Eventos).