WhatsApp Business API para notificación de devolución de pedido

Descripción del caso de uso

El escenario envía al cliente una plantilla de WhatsApp personalizada cuando se registra o actualiza una devolución de pedido. El mensaje incluye el nombre del cliente, número de pedido, nombre del producto y siguiente paso de devolución o reembolso. Un botón URL estático abre detalles de devolución o descarga de etiqueta.

Ejemplo de plantilla

Hola, {{1}}! Se inició una devolución para el pedido #{{2}} de "{{3}}". {{4}}.

[Detalles de devolución]

El botón URL de detalles de devolución está fijado en la plantilla de Meta — solo las variables del cuerpo se envían vía API.

Variables y propósito

• {{1}} — nombre del cliente
• {{2}} — número de pedido
• {{3}} — nombre del producto
• {{4}} — estado de devolución, plazo de reembolso o instrucción de entrega

Ejemplo completado

Hola, Alejandro! Se inició una devolución para el pedido #10482 de "Audífonos inalámbricos". Devuelve el artículo al punto de entrega antes del 5 de julio. Reembolso en 5–7 días hábiles tras inspección..

[Detalles de devolución]

Cuándo usarlo

• devoluciones e-commerce
• marketplaces
• integradores

Valor para el negocio

• OMS or returns system emits an order-return event
• System resolves the customer phone number and return details
• Template message is built with four body variables and a static URL button
• Customer receives WhatsApp confirmation about the return process
• Return status is logged for CRM or finance follow-up

Flujo de trabajo

1. El sistema de devoluciones registra o actualiza una devolución y dispara un evento.
2. El sistema obtiene el teléfono del cliente y los campos de devolución.
3. Se construye un mensaje de plantilla personalizado con cuatro variables en el cuerpo y un botón URL estático.
4. El cliente recibe la actualización en WhatsApp y puede abrir detalles de devolución con el botón.
5. Se registra el resultado de entrega; los errores se manejan según las reglas de la plataforma.
6. El progreso de entrega se reporta de forma asíncrona — típicamente sent, luego delivered (o failed/undelivered).
7. Tu sistema recibe el estado vía webhook (hooks[]) o consulta GET …/hookInfo?messageId=<id> y maneja fallos si es necesario.

Implementación técnica

Requisitos previos

• Cuenta 1MSG con WhatsApp Business API conectada y plantilla de mensaje aprobada.
• Número de teléfono del cliente en formato internacional (sin + ni espacios).
• Datos de devolución: nombre del cliente, número de pedido, nombre del producto, nota del siguiente paso.

Ejemplos de código

#!/usr/bin/env node

// === Configuration (replace "___" placeholders) ===

const API_BASE_URL = "https://api.1msg.io"; // production 1MSG API base URL
const CHANNEL_ID = "___";                   // channel ID from 1MSG dashboard
const API_TOKEN = "___";                    // channel JWT token (Bearer)

const TEMPLATE_NAME = "___";                // approved template name
const TEMPLATE_NAMESPACE = "___";           // template namespace (422 without it)
const TEMPLATE_LANGUAGE = "___";            // template language code, e.g. "en"



// === Test data ===
const TEST_PHONE = "___";            // client phone in international format
const TEST_CUSTOMERNAME = "___";    // {{1}} customer name
const TEST_TICKETNUMBER = "___";    // {{2}} ticket number
const TEST_PRODUCTNAME = "___";    // {{3}} product name
const TEST_NEXTSTEP = "___";    // {{4}} next step

function normalizePhone(phone) {
  return String(phone).replace(/\D/g, "");
}

function assertConfigured(values) {
  for (const [key, value] of Object.entries(values)) {
    if (value === "___" || value === "" || value === undefined || value === null) {
      throw new Error(`Missing configuration value: ${key}`);
    }
  }
}

async function sendTemplateMessage({ phone, customerName, ticketNumber, productName, nextStep }) {
  assertConfigured({
    CHANNEL_ID,
    API_TOKEN,
    TEMPLATE_NAME,
    TEMPLATE_NAMESPACE,
    TEMPLATE_LANGUAGE,
    phone,
    customerName,
    ticketNumber,
    productName,
    nextStep,
  });

  const url = `${API_BASE_URL}/${CHANNEL_ID}/sendTemplate`;

  // params carries body ONLY. Button text is fixed in the Meta template — no button param.
  const requestBody = {
    phone: normalizePhone(phone),
    template: TEMPLATE_NAME,
    namespace: TEMPLATE_NAMESPACE,
    language: {
      policy: "deterministic",
      code: TEMPLATE_LANGUAGE,
    },
    params: [
      {
        type: "body",
        parameters: [
          { type: "text", text: String(customerName) }, // {{1}} customer name
          { type: "text", text: String(ticketNumber) }, // {{2}} ticket number
          { type: "text", text: String(productName) }, // {{3}} product name
          { type: "text", text: String(nextStep) }, // {{4}} next step
        ],
      },
    ],
  };

  const res = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${API_TOKEN}`,
    },
    body: JSON.stringify(requestBody),
  });

  const raw = await res.text();
  let data;
  try {
    data = JSON.parse(raw);
  } catch {
    data = null;
  }

  if (!res.ok || !data || data.sent !== true) {
    console.error("Send failed. API response:");
    console.error(raw);
    process.exit(1);
  }

  console.log("Message sent to client.");
  console.log("API response:", raw);
  return data;
}

if (require.main === module) {
  sendTemplateMessage({
    phone: TEST_PHONE,
    customerName: TEST_CUSTOMERNAME,
    ticketNumber: TEST_TICKETNUMBER,
    productName: TEST_PRODUCTNAME,
    nextStep: TEST_NEXTSTEP,
  }).catch((err) => {
    console.error("Execution failed:", err.message);
    process.exit(1);
  });
}

module.exports = { sendTemplateMessage };

Respuesta inmediata de la API (síncrona)

• HTTP 2xx y JSON "sent": true significan que 1MSG aceptó el mensaje para envío — no que ya llegó al teléfono del cliente.
• Guarda el campo `id` de la respuesta (valor tipo wamid.…). Úsalo para correlacionar callbacks de entrega o polling.
• La respuesta también puede incluir message y description — solo informativos.

Estado de entrega (asíncrono)

• Registra un webhook (POST …/webhook) para que 1MSG envíe actualizaciones de entrega a tu endpoint HTTPS en un payload `hooks[]` separado (sent, delivered, read, o failed/undelivered cuando aplique).
• Opcionalmente consulta: GET {base}/{channel}/hookInfo?messageId=<id de sendTemplate>.
• En la práctica, la entrega suele completarse en pocos segundos — pero eso no está garantizado por el contrato de la API.

Errores frecuentes

• Número de teléfono inválido o no normalizado
• Nombre de plantilla / namespace no aprobado o ausente
• Sin opt-in del cliente para mensajes comerciales de WhatsApp
• Cantidad de variables de plantilla incorrecta (422 de la API)
• Fallo de entrega — revisa el webhook de estado y la política de reintentos

Preguntas frecuentes

• ¿Necesito una plantilla aprobada? Sí — los mensajes cold-start de WhatsApp requieren una plantilla aprobada por Meta.
• ¿Puedo personalizar el texto? Las variables del cuerpo son dinámicas; el texto fijo y las etiquetas de botones se definen en la plantilla de Meta.
• ¿Cómo verifico la entrega? sent: true solo confirma aceptación. Rastrea la entrega vía webhook hooks[] o GET …/hookInfo?messageId=<id>.
• ¿Qué pasa si no se entrega? Registra el hook failed/undelivered, verifica opt-in y estado de la plantilla, luego reintenta o usa otro canal.
• ¿Puedo conectarlo a mi CRM o backend? Sí — dispara la llamada a la API desde el webhook de tu plataforma o manejador de eventos.

Recursos relacionados

• Base de conocimiento
• Crear una plantilla
• Enviar una plantilla
• SDK