WhatsApp | Plazbot Docs

Introducción

Para trabajar con WhatsApp, es necesario configurar tu número en Plazbot. La configuración se realiza directamente con Meta.

Configurar WhatsApp

Guía para conectar tu número de WhatsApp en Plazbot.

Inicialización

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.message.onWhatsappMessage(...)

Enviar Mensaje Simple

Envía un mensaje de texto por WhatsApp. Solo funciona si la conversación con el cliente está activa (dentro de la ventana de 24 horas de Meta).

01const result = await plazbot.message.onWhatsappMessage({
02  message: "Gracias por contactarnos!",
03  to: "51912345678"
04});

Consulta la documentación de Meta sobre ventanas de conversación 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 básico:

01await plazbot.message.onConversation({
02  to: "51912345678",
03  template: "welcome_plazbot"
04});

Con variables:

01await plazbot.message.onConversation({
02  to: "51912345678",
03  template: "order_confirmation",
04  variablesBody: [
05    { variable: "1", value: "Juan" },
06    { variable: "2", value: "ORD-12345" }
07  ],
08  variablesHeader: [
09    { variable: "1", value: "Pedido Confirmado" }
10  ]
11});

Con archivo adjunto:

01await plazbot.message.onConversation({
02  to: "51912345678",
03  template: "invoice_template",
04  file: {
05    fileUrl: "https://tu-servidor.com/facturas/INV-001.pdf",
06    fileName: "factura.pdf"
07  }
08});

Campo	Tipo	Requerido	Descripción
`to`	`string`	Si	Número de teléfono con código de país
`template`	`string`	Si	Nombre de la plantilla aprobada
`variablesBody`	`array`	No	Variables para el cuerpo del mensaje
`variablesHeader`	`array`	No	Variables para el header
`file`	`object`	No	Archivo adjunto (`fileUrl` y `fileName`)

Historial de Mensajes

Consulta mensajes enviados y recibidos en tu workspace.

01// Obtener mensajes recientes
02const messages = await plazbot.message.getMessages({ limit: 20 });
03 
04// Historial de conversación con un contacto
05const history = await plazbot.message.getConversationHistory({
06  contactId: "contact-id"
07});
08 
09// Buscar mensajes por texto
10const results = await plazbot.message.searchMessages({
11  query: "precio"
12});

Webhooks

Registra un webhook para recibir mensajes entrantes de WhatsApp en tu endpoint.

Registrar webhook:

01await plazbot.message.registerWebhook({
02  number: "51912345678",
03  webhookUrl: "https://tu-servidor.com/webhooks/whatsapp"
04});

Eliminar webhook:

01await plazbot.message.deleteWebhook({
02  number: "51912345678"
03});

El webhook envía el mensaje y la información del contacto cada vez que un cliente escribe al número configurado. Es ideal para integraciones con Make, Zapier o tu propio servidor.