Producto
CLI

Buscar contactos

plazbot contacts search: busca contactos por número de WhatsApp o por email

Buscar contactos

Busca contactos por número de WhatsApp o por email. Un mismo número puede tener más de un contacto si escribió a distintos números de tu empresa, por eso el resultado es una lista.

bash
01plazbot contacts search (-p <número> | -e <email>) [--json]

Parámetros

ParámetroFlagRequeridoDescripción
Teléfono-p, --phone <number>Uno de los dosNúmero en formato internacional: +51912345678, 51912345678 o "+51 912 345 678"
Email-e, --email <email>Uno de los dosEmail exacto
JSON--jsonNoImprime { data, nextCursor } en JSON
Workspace-w, --workspace <id>NoOtro de tus workspaces
Zona-z, --zone <zone>NoLA o EU

Pasa --phone o --email, no los dos.

Ejemplos

bash
01# Buscar por teléfono
02plazbot contacts search -p +51912345678
03 
04# Buscar por email, en JSON
05plazbot contacts search -e ana@empresa.com --json
06 
07# Obtener solo el ID del primer resultado
08plazbot contacts search -p +51912345678 --json | jq -r '.data[0].id'

Resultado

text
01 Contacts (2)
02 ────────────────────────────────────────
03┌───────────────┬────────────┬─────────────┬──────────┬────────────┬──────────────────┐
04│ ID │ Name │ Phone │ Channel │ Agent │ Last message │
05├───────────────┼────────────┼─────────────┼──────────┼────────────┼──────────────────┤
06│ con_AbcDef123 │ Ana Torres │ 51912345678 │ whatsapp │ Luis Pérez │ 2026-10-06 17:32 │
07├───────────────┼────────────┼─────────────┼──────────┼────────────┼──────────────────┤
08│ con_GhiJkl456 │ Ana Torres │ 51912345678 │ whatsapp │ Luis Pérez │ 2026-06-25 02:23 │
09└───────────────┴────────────┴─────────────┴──────────┴────────────┴──────────────────┘

Salida JSON

json
01{
02 "data": [
03 {
04 "id": "con_AbcDef123",
05 "name": "Ana",
06 "lastname": "Torres",
07 "internalWhatsappNumber": "51912345678",
08 "platformId": 2,
09 "assignedAgentName": "Luis Pérez",
10 "lastMessageDate": "2026-10-06T17:32:08.404Z"
11 }
12 ],
13 "nextCursor": null
14}

Cada elemento es el contacto completo, igual que en plazbot contacts get.

Errores comunes

MensajeCausaSolución
Pass either --phone or --email.No pasaste ninguno, o pasaste los dosUsa solo uno
Invalid phone number "..."El número no tiene entre 8 y 15 dígitosUsa el formato internacional con código de país
No contact matchesNo hay contactos con ese datoRevisa el número o el email, y el workspace activo
¿Quieres probar la API en vivo? Abre el Playground.