Conversaciones

Buscar Chats

Busca chats con filtros avanzados: por nombre, label, estado, grupo y más.

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

Autenticación con los encabezados x-api-key y x-api-secret.

Parámetros

Nombre	Tipo	Dónde	Obligatorio	Descripción
`operator`	select	cuerpo	No	Operador lógico entre los filtros
`sort`	text	cuerpo	No	Orden (+/- campo, ej: -wa_lastMsgTimestamp)
`limit`	number	cuerpo	No	Cantidad máxima de resultados a devolver
`offset`	number	cuerpo	No	Número de registros a omitir (para paginación)
`wa_fastid`	text	cuerpo	No	ID interno del chat
`wa_chatid`	text	cuerpo	No	ID del chat en WhatsApp
`wa_archived`	select	cuerpo	No	¿Archivado?
`wa_contactName`	text	cuerpo	No	Nombre del contacto
`wa_name`	text	cuerpo	No	Nombre en WhatsApp
`name`	text	cuerpo	No	Nombre
`wa_isBlocked`	select	cuerpo	No	¿Bloqueado?
`wa_isGroup`	select	cuerpo	No	¿Es grupo?
`wa_isGroup_admin`	select	cuerpo	No	¿Es admin del grupo?
`wa_isGroup_announce`	select	cuerpo	No	¿Grupo solo para admins?
`wa_isGroup_member`	select	cuerpo	No	¿Es miembro del grupo?
`wa_isPinned`	select	cuerpo	No	¿Fijado?
`wa_label`	text	cuerpo	No	ID de la label aplicada al chat. Usa el valor devuelto por `/labels`, no el nombre de la etiqueta.
`wa_notes`	text	cuerpo	No	¿Tiene notas?
`lead_tags`	text	cuerpo	No	Tags del lead
`lead_isTicketOpen`	select	cuerpo	No	¿Ticket abierto?
`lead_assignedAttendant_id`	text	cuerpo	No	ID del agente
`lead_status`	text	cuerpo	No	Estado del lead

Ejemplo de solicitud

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/find" \
  -H "x-api-key: TU_API_KEY" \
  -H "x-api-secret: TU_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": "TU_API_KEY",
    "x-api-secret": "TU_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": "TU_API_KEY", "x-api-secret": "TU_API_SECRET"},
    json={"operator":"AND","sort":"-wa_lastMsgTimestamp"},
)
print(res.json())

Ejemplo de respuesta

JSON

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

Los valores son ilustrativos; los campos siguen el formato real de la respuesta.

Otros endpoints de esta categoría

Ver la referencia completa

Consigue tus claves de API

Crea tu cuenta, conecta un número en minutos y empieza a usar la API. R$15 por número activo/mes, con un crédito de bienvenida al crear la cuenta, sujeto a la campaña vigente.

Crear cuenta gratis Ver la documentación