curl --request POST \
--url https://api.wppfy.com/chat/find \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"operator": "AND",
"sort": "-wa_lastMsgTimestamp",
"limit": 50,
"offset": 0,
"wa_isGroup": true,
"lead_status": "~novo",
"wa_label": "~importante"
}
'{
"chats": [
{
"id": "<string>",
"wa_fastid": "<string>",
"wa_chatid": "<string>",
"wa_archived": false,
"wa_contactName": "",
"wa_name": "",
"name": "",
"image": "",
"imagePreview": "",
"wa_ephemeralExpiration": 0,
"wa_isBlocked": false,
"wa_isGroup": false,
"wa_isGroup_admin": false,
"wa_isGroup_announce": false,
"wa_isGroup_community": false,
"wa_isGroup_member": false,
"wa_isPinned": false,
"wa_label": "[]",
"wa_lastMessageTextVote": "",
"wa_lastMessageType": "",
"wa_lastMsgTimestamp": 0,
"wa_lastMessageSender": "",
"wa_muteEndTime": 0,
"owner": "",
"wa_unreadCount": 0,
"phone": "",
"wa_common_groups": "Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)",
"lead_name": "",
"lead_fullName": "",
"lead_email": "",
"lead_personalid": "",
"lead_status": "",
"lead_tags": "<string>",
"lead_notes": "",
"lead_isTicketOpen": false,
"lead_assignedAttendant_id": "",
"lead_kanbanOrder": 0,
"lead_field01": "",
"lead_field02": "",
"lead_field03": "",
"lead_field04": "",
"lead_field05": "",
"lead_field06": "",
"lead_field07": "",
"lead_field08": "",
"lead_field09": "",
"lead_field10": "",
"lead_field11": "",
"lead_field12": "",
"lead_field13": "",
"lead_field14": "",
"lead_field15": "",
"lead_field16": "",
"lead_field17": "",
"lead_field18": "",
"lead_field19": "",
"lead_field20": "",
"chatbot_agentResetMemoryAt": 0,
"chatbot_lastTrigger_id": "",
"chatbot_lastTriggerAt": 0,
"chatbot_disableUntil": 0,
"created": "strftime('%Y-%m-%d %H:%M:%f', 'now')",
"updated": "strftime('%Y-%m-%d %H:%M:%f', 'now')"
}
],
"totalChatsStats": {},
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123
}
}Busca chats com diversos filtros e ordenação. Suporta filtros em todos os campos do chat, paginação e ordenação customizada.
Operadores de filtro:
~ : LIKE (contém)!~ : NOT LIKE (não contém)!= : diferente>= : maior ou igual> : maior que<= : menor ou igual< : menor quecurl --request POST \
--url https://api.wppfy.com/chat/find \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"operator": "AND",
"sort": "-wa_lastMsgTimestamp",
"limit": 50,
"offset": 0,
"wa_isGroup": true,
"lead_status": "~novo",
"wa_label": "~importante"
}
'{
"chats": [
{
"id": "<string>",
"wa_fastid": "<string>",
"wa_chatid": "<string>",
"wa_archived": false,
"wa_contactName": "",
"wa_name": "",
"name": "",
"image": "",
"imagePreview": "",
"wa_ephemeralExpiration": 0,
"wa_isBlocked": false,
"wa_isGroup": false,
"wa_isGroup_admin": false,
"wa_isGroup_announce": false,
"wa_isGroup_community": false,
"wa_isGroup_member": false,
"wa_isPinned": false,
"wa_label": "[]",
"wa_lastMessageTextVote": "",
"wa_lastMessageType": "",
"wa_lastMsgTimestamp": 0,
"wa_lastMessageSender": "",
"wa_muteEndTime": 0,
"owner": "",
"wa_unreadCount": 0,
"phone": "",
"wa_common_groups": "Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)",
"lead_name": "",
"lead_fullName": "",
"lead_email": "",
"lead_personalid": "",
"lead_status": "",
"lead_tags": "<string>",
"lead_notes": "",
"lead_isTicketOpen": false,
"lead_assignedAttendant_id": "",
"lead_kanbanOrder": 0,
"lead_field01": "",
"lead_field02": "",
"lead_field03": "",
"lead_field04": "",
"lead_field05": "",
"lead_field06": "",
"lead_field07": "",
"lead_field08": "",
"lead_field09": "",
"lead_field10": "",
"lead_field11": "",
"lead_field12": "",
"lead_field13": "",
"lead_field14": "",
"lead_field15": "",
"lead_field16": "",
"lead_field17": "",
"lead_field18": "",
"lead_field19": "",
"lead_field20": "",
"chatbot_agentResetMemoryAt": 0,
"chatbot_lastTrigger_id": "",
"chatbot_lastTriggerAt": 0,
"chatbot_disableUntil": 0,
"created": "strftime('%Y-%m-%d %H:%M:%f', 'now')",
"updated": "strftime('%Y-%m-%d %H:%M:%f', 'now')"
}
],
"totalChatsStats": {},
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123
}
}Operador lógico entre os filtros
AND, OR Campo para ordenação (+/-campo). Ex -wa_lastMsgTimestamp
Limite de resultados por página
Offset para paginação
Lista de chats encontrados
Show child attributes
ID único da conversa (r + 7 bytes aleatórios em hex)
Identificador rápido do WhatsApp
ID completo do chat no WhatsApp
Indica se o chat está arquivado
Nome do contato no WhatsApp
Nome do WhatsApp
Nome exibido do chat
URL da imagem do chat
URL da miniatura da imagem
Tempo de expiração de mensagens efêmeras
Indica se o contato está bloqueado
Indica se é um grupo
Indica se o usuário é admin do grupo
Indica se é um grupo somente anúncios
Indica se é uma comunidade
Indica se é membro do grupo
Indica se o chat está fixado
Labels do chat em JSON
Texto/voto da última mensagem
Tipo da última mensagem
Timestamp da última mensagem
Remetente da última mensagem
Timestamp do fim do silenciamento
Dono da instância
Contador de mensagens não lidas
Número de telefone
Grupos em comum separados por vírgula, formato: (nome_grupo)id_grupo
"Grupo Família(120363123456789012@g.us),Trabalho(987654321098765432@g.us)"
Nome do lead
Nome completo do lead
Email do lead
Documento de identificação
Status do lead
Tags do lead em JSON
Anotações sobre o lead
Indica se tem ticket aberto
ID do atendente responsável
Ordem no kanban
Timestamp do último reset de memória
ID do último gatilho executado
Timestamp do último gatilho
Timestamp até quando chatbot está desativado
Data de criação
Data da última atualização
Contadores totais de chats