Skip to main content

Introduccion

Para trabajar con WhatsApp, es necesario configurar tu numero en Plazbot. La configuracion se realiza directamente con Meta.

Configurar WhatsApp

Guia para conectar tu numero de WhatsApp en Plazbot.

Inicializacion

import { Plazbot } from 'plazbot';

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

// Usar: plazbot.message.onWhatsappMessage(...)

Enviar Mensaje Simple

Envia un mensaje de texto por WhatsApp. Solo funciona si la conversacion con el cliente esta activa (dentro de la ventana de 24 horas de Meta).
const result = await plazbot.message.onWhatsappMessage({
  message: "Gracias por contactarnos!",
  to: "51912345678"
});
Consulta la documentacion de Meta sobre ventanas de conversacion y tarifas: Meta Pricing

Enviar Plantilla (Template)

Las plantillas permiten iniciar conversaciones en cualquier momento. Deben estar creadas y aprobadas previamente en Marketing > Plantillas dentro de Plazbot. Uso basico:
await plazbot.message.onConversation({
  to: "51912345678",
  template: "welcome_plazbot"
});
Con variables:
await plazbot.message.onConversation({
  to: "51912345678",
  template: "order_confirmation",
  variablesBody: [
    { variable: "1", value: "Juan" },
    { variable: "2", value: "ORD-12345" }
  ],
  variablesHeader: [
    { variable: "1", value: "Pedido Confirmado" }
  ]
});
Con archivo adjunto:
await plazbot.message.onConversation({
  to: "51912345678",
  template: "invoice_template",
  file: {
    fileUrl: "https://tu-servidor.com/facturas/INV-001.pdf",
    fileName: "factura.pdf"
  }
});
CampoTipoRequeridoDescripcion
tostringSiNumero de telefono con codigo de pais
templatestringSiNombre de la plantilla aprobada
variablesBodyarrayNoVariables para el cuerpo del mensaje
variablesHeaderarrayNoVariables para el header
fileobjectNoArchivo adjunto (fileUrl y fileName)

Historial de Mensajes

Consulta mensajes enviados y recibidos en tu workspace.
// Obtener mensajes recientes
const messages = await plazbot.message.getMessages({ limit: 20 });

// Historial de conversacion con un contacto
const history = await plazbot.message.getConversationHistory({
  contactId: "contact-id"
});

// Buscar mensajes por texto
const results = await plazbot.message.searchMessages({
  query: "precio"
});

Webhooks

Registra un webhook para recibir mensajes entrantes de WhatsApp en tu endpoint. Registrar webhook:
await plazbot.message.registerWebhook({
  number: "51912345678",
  webhookUrl: "https://tu-servidor.com/webhooks/whatsapp"
});
Eliminar webhook:
await plazbot.message.deleteWebhook({
  number: "51912345678"
});
El webhook envia el mensaje y la informacion del contacto cada vez que un cliente escribe al numero configurado. Es ideal para integraciones con Make, Zapier o tu propio servidor.