Conversas

Buscar Chats

Busca chats com filtros avançados: por nome, label, status, grupo, e mais.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/chat/find

Autenticação por cabeçalhos x-api-key e x-api-secret.

Parâmetros

Nome	Tipo	Onde	Obrigatório	Descrição
`operator`	select	corpo	Não	Operador lógico entre os filtros
`sort`	text	corpo	Não	Ordenação (+/- campo, ex: -wa_lastMsgTimestamp)
`limit`	number	corpo	Não	Quantidade máxima de resultados a retornar
`offset`	number	corpo	Não	Número de registros a pular (para paginação)
`wa_fastid`	text	corpo	Não	ID interno do chat
`wa_chatid`	text	corpo	Não	ID do chat no WhatsApp
`wa_archived`	select	corpo	Não	Arquivado?
`wa_contactName`	text	corpo	Não	Nome do contato
`wa_name`	text	corpo	Não	Nome no WhatsApp
`name`	text	corpo	Não	Nome
`wa_isBlocked`	select	corpo	Não	Bloqueado?
`wa_isGroup`	select	corpo	Não	É grupo?
`wa_isGroup_admin`	select	corpo	Não	É admin do grupo?
`wa_isGroup_announce`	select	corpo	Não	Grupo apenas admins?
`wa_isGroup_member`	select	corpo	Não	É membro do grupo?
`wa_isPinned`	select	corpo	Não	Fixado?
`wa_label`	text	corpo	Não	ID da label aplicada ao chat. Use o valor retornado por `/labels`, não o nome da etiqueta.
`wa_notes`	text	corpo	Não	Tem notas?
`lead_tags`	text	corpo	Não	Tags do lead
`lead_isTicketOpen`	select	corpo	Não	Ticket aberto?
`lead_assignedAttendant_id`	text	corpo	Não	ID do atendente
`lead_status`	text	corpo	Não	Status do lead

Exemplo de requisição

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/find" \
  -H "x-api-key: SUA_API_KEY" \
  -H "x-api-secret: SEU_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"operator":"AND","sort":"-wa_lastMsgTimestamp"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chat/find", {
  method: "POST",
  headers: {
    "x-api-key": "SUA_API_KEY",
    "x-api-secret": "SEU_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "operator": "AND",
    "sort": "-wa_lastMsgTimestamp"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/chat/find",
    headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
    json={"operator":"AND","sort":"-wa_lastMsgTimestamp"},
)
print(res.json())

Exemplo de resposta

JSON

{
  "chats": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "name": "João",
      "unreadCount": 3
    }
  ]
}

Os valores são ilustrativos; os campos seguem o formato real da resposta.

Outros endpoints desta categoria

Ver referência completa

Pegue suas chaves de API

Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.

Criar conta grátis Ver a documentação