Enviar mensajes

Todos los ejemplos usan la misma autenticación: Authorization: Bearer <API key> y el header x-workspace-id. La base de la API es https://api.plazbot.com (América) o https://apieu.plazbot.com (Europa).

Texto libre

Para responder dentro de la ventana de 24 horas. El contacto debe existir (debe haberte escrito antes).

01await bot.message.onWhatsappMessage({
02  to:      "51912345678",
03  message: "Gracias por escribirnos, Ana.",
04})

El mensaje sale por el número al que el contacto escribió.

Plantilla con variables

Para iniciar conversaciones o escribir fuera de la ventana de 24 horas. La plantilla debe estar aprobada y activa.

01await bot.message.onConversation({
02  to:            "51912345678",
03  template:      "recordatorio_cita",
04  variablesBody: [
05    { variable: "1", value: "Ana" },
06    { variable: "2", value: "jueves 10:30" },
07  ],
08})

La plantilla se envía desde el número al que pertenece. Para variables del encabezado usa variablesHeader (SDK/REST) o --header-var (CLI).

Plantilla con archivo

Facturas, tickets o imágenes como encabezado de la plantilla, desde una URL pública.

01await bot.message.onConversation({
02  to:            "51912345678",
03  template:      "factura_mensual",
04  variablesBody: [{ variable: "1", value: "Ana" }],
05  file: {
06    fileUrl:  "https://tu-app.com/facturas/F-1024.pdf",
07    fileName: "F-1024.pdf",
08  },
09})

Envíos masivos

Para enviar una plantilla a una lista de números desde un archivo:

01plazbot whatsapp broadcast --template promo_octubre --phones ./numeros.txt --delay 1000

El archivo tiene un número por línea. Ver broadcast.

Inicializar el SDK

01import { Plazbot } from "plazbot"
02 
03export const bot = new Plazbot({
04  apiKey:      process.env.PLAZBOT_KEY!,
05  workspaceId: process.env.PLAZBOT_WORKSPACE_ID!,
06  zone:        "LA", // "LA" | "EU"
07})

Referencia completa del módulo de mensajes en SDK → WhatsApp.