Skip to main content

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

import { Plazbot } from 'plazbot';

const plazbot = new Plazbot({
  workspaceId: "YOUR_WORKSPACE_ID",
  apiKey: "YOUR_API_KEY",
  zone: "LA"
});

// Usar: plazbot.contact.getContacts()

Crear Contacto

const contact = await plazbot.contact.createContact({
  name: "Juan Perez",
  cellphone: "51912345678",
  email: "juan@ejemplo.com",
  tags: ["lead", "web"]
});

console.log("Contacto creado:", contact.id);
CampoTipoRequeridoDescripcion
namestringNoNombre del contacto
cellphonestringNoNumero de telefono con codigo de pais
emailstringNoCorreo electronico
tagsstring[]NoEtiquetas de clasificacion
stagestringNoEtapa del contacto en el pipeline

Listar Contactos

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

Obtener Contacto por ID

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

Buscar por Telefono

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

Buscar por Email

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

Actualizar Contacto

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

Eliminar Contactos

Elimina uno o multiples contactos por sus IDs.
await plazbot.contact.deleteContacts([
  "contact-id-1",
  "contact-id-2"
]);

Campos del Contacto

CampoTipoDescripcion
idstringIdentificador unico
namestringNombre del contacto
cellphonestringNumero de telefono
emailstringCorreo electronico
tagsstring[]Etiquetas
stagestringEtapa en el pipeline
ownerstringPropietario del contacto
createdAtstringFecha de creacion
updatedAtstringFecha de actualizacion

TypeScript

El SDK exporta los tipos para autocompletado:
import type {
  ContactData,
  CreateContactParams,
  UpdateContactParams
} 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.