_{Documentación del Webhook de WhatsApp Manager |
Ver en GitHub}

📋 Gestión de Plantillas

Introducción

El módulo de plantillas proporciona herramientas completas para crear, administrar y enviar mensajes basados en plantillas aprobadas por WhatsApp. Las plantillas son esenciales para comunicaciones automatizadas como notificaciones, promociones y mensajes transaccionales, permitiéndote mantener consistencia en tu comunicación mientras cumples con las políticas de WhatsApp.

Características principales:

Creación de plantillas para diferentes categorías (utilidad, marketing)
Gestión de versiones y componentes (cabeceras, cuerpos, pies de página, botones)
Sincronización con la API de WhatsApp
Envío masivo de mensajes basados en plantillas
Edición avanzada con validación en tiempo real

📚 Tabla de Contenidos

Administracion de Plantillas
- Obtener odas las plantillas
- Obtener Por nombre
- Obtener Por ID
- Eliminar Plantillas
- Soft delete
- Hard delete
Editar Plantillas
- Gestión de componentes
- Validaciones
- Manejo de errores
Crear Plantillas
- Plantillas de utilidad
- Plantillas de marketing
- Con imágenes
- Con botones
- Variaciones
Enviar Mensajes con Plantillas

Administracion de Plantillas

Obtener todas las plantillas de una cuenta de whatsapp
Se obtienen todas las plantillas de una cuenta de whatsapp y se almacenan en la base de datos.
Se hace la peticion a la API de whatsapp para obtener todas las plantillas que estan asociadas a la cuenta de whatsapp.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Obtener una instancia de WhatsApp Business Account
$account = WhatsappBusinessAccount::find($accountId);

// Obtener todas las plantillas de la cuenta
Whatsapp::template()->getTemplates($account);

Obtener una plantilla por el nombre.
Se hace la peticion a la API de whatsapp para obtener una plantilla por el nombre y se almacena en la base de datos.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Obtener una instancia de WhatsApp Business Account
$account = WhatsappBusinessAccount::find($accountId);

// Obtener plantilla por su nombre
$template = Whatsapp::template()->getTemplateByName($account, 'order_confirmation');

Obtener una plantilla por el ID.
Se hace la peticion a la API de whatsapp para obtener una plantilla por el ID y se almacena en la base de datos.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Obtener una instancia de WhatsApp Business Account
$account = WhatsappBusinessAccount::find($accountId);

// Obtener plantilla por su ID
$template = Whatsapp::template()->getTemplateById($account, '559947779843204');

Eliminar plantilla de la API y de la base de datos al mismo tiempo.
Se hace la peticion a la API de whatsapp para obtener una plantilla por el ID y se elimina la plantilla seleccionada, Existen dos maneras de eliminar Soft Delete y Hard Delete.

use ScriptDevelop\WhatsappManager\Facades\Whatsapp;
use ScriptDevelop\WhatsappManager\Models\WhatsappBusinessAccount;

// Obtener una instancia de WhatsApp Business Account
$account = WhatsappBusinessAccount::find($accountId);

// Soft delete
// Eliminar plantilla por su ID
$template = Whatsapp::template()->gdeleteTemplateById($account, $templateId);

// Eliminar plantilla por su Nombre
$template = Whatsapp::template()->deleteTemplateByName($account, 'order_confirmation');

// Hard delete
// Eliminar plantilla por su ID
$template = Whatsapp::template()->gdeleteTemplateById($account, $templateId, true);

// Eliminar plantilla por su Nombre
$template = Whatsapp::template()->deleteTemplateByName($account, 'order_confirmation', true);

Editar plantilla de la API y de la base de datos al mismo tiempo.
Se hace la peticion a la API de whatsapp para editar la plantilla seleccionada.

use ScriptDevelop\WhatsappManager\Models\Template;
use ScriptDevelop\WhatsappManager\Exceptions\TemplateComponentException;
use ScriptDevelop\WhatsappManager\Exceptions\TemplateUpdateException;

$template = Template::find('template-id');

try {
    $updatedTemplate = $template->edit()
        ->setName('nuevo-nombre-plantilla')
        ->changeBody('Nuevo contenido del cuerpo {{1}}', [['Ejemplo nuevo']])
        ->removeHeader()
        ->addFooter('Nuevo texto de pie de página')
        ->removeAllButtons()
        ->addButton('URL', 'Visitar sitio', 'https://mpago.li/2qe5G7E')
        ->addButton('QUICK_REPLY', 'Confirmar')
        ->update();

    return response()->json($updatedTemplate);

} catch (TemplateComponentException $e) {
    // Manejar error de componente
    return response()->json(['error' => $e->getMessage()], 400);

} catch (TemplateUpdateException $e) {
    // Manejar error de actualización
    return response()->json(['error' => $e->getMessage()], 500);
}

Agregar componentes a plantillas que no lo tenian:

$template->edit()
    ->addHeader('TEXT', 'Encabezado agregado')
    ->addFooter('Pie de página nuevo')
    ->addButton('PHONE_NUMBER', 'Llamar', '+1234567890')
    ->update();

Eliminar componentes existentes:

$template->edit()
    ->removeFooter()
    ->removeAllButtons()
    ->update();

Trabajar con componentes específicos:

$editor = $template->edit();

// Verificar y modificar header
if ($editor->hasHeader()) {
    $headerData = $editor->getHeader();
    if ($headerData['format'] === 'TEXT') {
        $editor->changeHeader('TEXT', 'Encabezado actualizado');
    }
} else {
    $editor->addHeader('TEXT', 'Nuevo encabezado');
}

// Modificar botones
$buttons = $editor->getButtons();
foreach ($buttons as $index => $button) {
    if ($button['type'] === 'URL' && str_contains($button['url'], 'old-domain.com')) {
        $newUrl = str_replace('old-domain.com', 'new-domain.com', $button['url']);
        $editor->removeButtonAt($index);
        $editor->addButton('URL', $button['text'], $newUrl);
    }
}

$editor->update();

Características Clave del Edit Template

1.- Gestión completa de componentes:
    - Métodos add, change, remove para cada tipo de componente
    - Métodos has para verificar existencia
    - Métodos get para obtener datos

2.- Validaciones robustas:
    - Unicidad de componentes (solo un HEADER, BODY, etc.)
    - Componentes obligatorios (BODY siempre requerido)
    - Límites de botones (máximo 10)
    - Restricciones de modificación (no cambiar categoría, no modificar aprobadas)

3.- Operaciones atómicas:
    - removeButtonAt: Elimina un botón específico
    - removeAllButtons: Elimina todos los botones
    - getButtons: Obtiene todos los botones actuales

4.- Manejo de errores:
    - Excepciones específicas para problemas de componentes
    - Excepciones para fallos en la actualización
    - Mensajes de error claros y descriptivos

5.- Flujo intuitivo:
    - $template->edit() inicia la edición
    - Encadenamiento de métodos para modificaciones
    - update() aplica los cambios

❤️Apóyanos con una donación en GitHub Sponsors

Me puedes apoyar como desarrollador open source en GitHub Sponsors:

Si este proyecto te ha sido útil, puedes apoyarlo con una donación a través de
O tambien por Mercadopago Colombia.

Gracias por tu apoyo 💙

Crear las plantillas en una cuenta de whatsapp

Crear Plantillas de Utilidad

Las plantillas transaccionales son ideales para notificaciones como confirmaciones de pedidos, actualizaciones de envío, etc.