Contactos | Plazbot Docs

Introduccion

El modulo de Contact te permite gestionar tu base de contactos de forma programatica. Puedes crear, buscar por telefono o email, actualizar y eliminar contactos.

Inicializacion

Plazbot (recomendado)·ts

01import { Plazbot } from 'plazbot';
02 
03const plazbot = new Plazbot({
04  workspaceId: "YOUR_WORKSPACE_ID",
05  apiKey: "YOUR_API_KEY",
06  zone: "LA"
07});
08 
09// Usar: plazbot.contact.getContacts()

Crear Contacto

01const contact = await plazbot.contact.createContact({
02  name: "Juan Perez",
03  cellphone: "51912345678",
04  email: "juan@ejemplo.com",
05  tags: ["lead", "web"]
06});
07 
08console.log("Contacto creado:", contact.id);

Campo	Tipo	Requerido	Descripcion
`name`	`string`	No	Nombre del contacto
`cellphone`	`string`	No	Numero de telefono con codigo de pais
`email`	`string`	No	Correo electronico
`tags`	`string[]`	No	Etiquetas de clasificacion
`stage`	`string`	No	Etapa del contacto en el pipeline

Listar Contactos

01const contacts = await plazbot.contact.getContacts();
02console.log(`Total: ${contacts.length} contactos`);

Obtener Contacto por ID

01const contact = await plazbot.contact.getContact("contact-id");
02console.log(contact.name, contact.email);

Buscar por Telefono

01const results = await plazbot.contact.searchByPhone("51912345678");

Buscar por Email

01const results = await plazbot.contact.searchByEmail("juan@ejemplo.com");

Actualizar Contacto

01const updated = await plazbot.contact.updateContact({
02  id: "contact-id",
03  name: "Juan Perez Actualizado",
04  tags: ["lead", "premium", "web"]
05});

Eliminar Contactos

Elimina uno o multiples contactos por sus IDs.

01await plazbot.contact.deleteContacts([
02  "contact-id-1",
03  "contact-id-2"
04]);

Campos del Contacto

Campo	Tipo	Descripcion
`id`	`string`	Identificador unico
`name`	`string`	Nombre del contacto
`cellphone`	`string`	Numero de telefono
`email`	`string`	Correo electronico
`tags`	`string[]`	Etiquetas
`stage`	`string`	Etapa en el pipeline
`owner`	`string`	Propietario del contacto
`createdAt`	`string`	Fecha de creacion
`updatedAt`	`string`	Fecha de actualizacion

TypeScript

El SDK exporta los tipos para autocompletado:

01import type {
02  ContactData,
03  CreateContactParams,
04  UpdateContactParams
05} from 'plazbot';

Combina el modulo de Contact con el de Message para enviar plantillas de WhatsApp a contactos de tu base de datos de forma automatizada.