Crear plantilla

Crear Template

Petición

Petición de Crear Template:

Encabezados

Encabezados de Crear Template:

Cuerpo

Campos del cuerpo de Crear Template:

Objeto structure

Objeto header

Objeto header example

Objeto body

Objeto body example

Objeto buttons

Objeto supported_apps

Objeto limited_time_offer

Objeto carousel

El componente de carrusel puede enviarse bajo la clave carousel o bajo la clave carousel_cards. Ambas se aceptan y corresponden al mismo componente.

Objeto cards

Ejemplo

Ejemplos completos de Crear Template. Cada body de abajo es un payload -d válido para la petición anterior; envía uno de ellos en lugar del Body general.

Body general

💾
curl -X POST "https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{admin-token}}' \
-d '{
    "wba_id": "1234567899870",
    "name": "notificacion_de_pedido",
    "language": "es_MX",
    "category": "AUTHENTICATION|MARKETING|UTILITY",
    "structure":
    {
        "header":
        {
            "format": "TEXT|IMAGE|DOCUMENT|VIDEO|LOCATION|GIF",
            "text": "PEDIDO: {{1}}",
            "example":
            {
                "header_handle":
                [
                    "file-handle"
                ],
                "header_text":
                [
                    "header-example"
                ]
            }
        },
        "body":
        {
            "text": "Tu pedido {{1}} está por llegar",
            "example":
            {
                "body_text":
                    [
                        [  "123"]
                    ]
            }
        },
        "footer": "Mi empresa",
        "buttons":
        [
            {
                "type": "PHONE_NUMBER|URL|QUICK_REPLY|COPY_CODE|FLOW",
                "text": "phone-button-text|url-button-text",
                "url": "https://www.website.com/{{1}}",
                "phone_number": "+52(1) 555-1111",
                "example":
                [
                    "https://www.website.com/dynamic-url-example"
                ]
            }
        ]
    }
}'

Body de encabezado de texto personalizado

Una plantilla MARKETING con encabezado TEXT, un cuerpo con parámetros, un pie de página y botones QUICK_REPLY + URL.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_custom_text",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "header": {
            "format": "TEXT",
            "text": "Big sale, {{1}}!",
            "example": {
                "header_text": [
                    "Ana"
                ]
            }
        },
        "body": {
            "text": "Hi {{1}}, enjoy {{2}} off your next order this weekend only.",
            "example": {
                "body_text": [
                    [
                        "Ana",
                        "20%"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop promotions"
            },
            {
                "type": "URL",
                "text": "Shop now",
                "url": "https://www.website.com/{{1}}",
                "example": [
                    "https://www.website.com/sale"
                ]
            }
        ]
    }
}

Body flows

💾
{
    "name": "lead_cj_cm_dudas",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Conecta con tus clientes interactuando por el canal y momento correcto. SMS, RCS, WhatsApp, Messenger, Email, Voz, Chatbot y muchos más."
        },
        "buttons":
        [
            {
                "type": "FLOW",
                "text": "Registrate",
                "flow_id": "1636507303762565",
                "navigate_screen": "CONTACT_INFO",
                "flow_action": "navigate"
            }
        ]
    },
    "wba_id": "1234567899870",
    "allowCategoryChange": false
}

Body carrusel con multimedia por URL

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "ejemplo_plantilla_carrusel",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Proporciona la mejor experiencia a tus clientes a través de sus canales favoritos. Usa el código {{1}} para obtener un descuento del {{2}} al registrarte.",
            "example":
            {
                "body_text":
                [
                    [
                        "DESCUENTO2024",
                        "25%"
                    ]
                ]
            }
        },
        "carousel":
        {
            "cards":
            [
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "https://iili.io/HDQOyc7.jpg"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Conecta con tus clientes interactuando por el canal y momento correcto. SMS, RCS..."
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Regístrate",
                            "url": "https://www.conceptomovil.com/producto_broadcastermobile.html"
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "https://iili.io/HDQOyc7.jpg"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Atiende a tus clientes con Chatbots y Agentes mediante Conversaciones en WhatsApp"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Regístrate",
                            "url": "https://www.conceptomovil.com/producto_broadcasterbot.html"
                        }
                    ]
                }
            ]
        }
    }
}

Body carrusel con multimedia por ID

El valor de header_handle es el ID que obtienes con Cargar contenido multimedia del encabezado.

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "coupon_code_fall2023_25off_02",
    "language": "en_US",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Proporciona la mejor experiencia a tus clientes a través de sus canales favoritos. Use el código {{1}} para obtener un descuento del {{2}} al registrarte.",
            "example":
            {
                "body_text":
                [
                    [
                        "Juan Pablo",
                        "25OFF"
                    ]
                ]
            }
        },
        "carousel":
        {
            "cards":
            [
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle1:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Conecta con tus clientes interactuando por el canal y momento correcto. SMS, RCS..."
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Registrate",
                            "url": "https://www.conceptomovil.com/producto_broadcastermobile.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_broadcastermobile.html"
                            ]
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle2:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "Atiende a tus clientes con Chatbots y Agentes mediante Conversaciones en WhatsApp"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Registrate",
                            "url": "https://www.conceptomovil.com/producto_broadcasterbot.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_broadcasterbot.html"
                            ]
                        }
                    ]
                },
                {
                    "header":
                    {
                        "format": "IMAGE",
                        "example":
                        {
                            "header_handle":
                            [
                                "4::aW1hZ2UvcG5n:ARZExampleHandle3:e:1771350704:1234567890:1234567890:ARZExample"
                            ]
                        }
                    },
                    "body":
                    {
                        "text": "La plataforma inteligente para gestionar tus dinámicas promocionales"
                    },
                    "buttons":
                    [
                        {
                            "type": "URL",
                            "text": "Registrate",
                            "url": "https://www.conceptomovil.com/producto_cmmkt.html",
                            "example":
                            [
                                "https://www.conceptomovil.com/producto_cmmkt.html"
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

Body de carrusel con multimedia (carousel_cards)

Hasta 10 tarjetas. Todas las tarjetas deben usar el mismo formato de encabezado (IMAGE o VIDEO) y la misma lista de botones (cantidad, tipos y orden). Cada tarjeta admite un máximo de 2 botones de tipo PHONE_NUMBER, URL o QUICK_REPLY. Este ejemplo usa el alias carousel_cards del componente de carrusel.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_media_carousel",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, check out this week's featured deals!",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "carousel_cards": {
            "cards": [
                {
                    "header": {
                        "format": "IMAGE",
                        "example": {
                            "header_handle": [
                                "https://www.website.com/card1.jpg"
                            ]
                        }
                    },
                    "body": {
                        "text": "Summer jacket, now {{1}} off.",
                        "example": {
                            "body_text": [
                                [
                                    "30%"
                                ]
                            ]
                        }
                    },
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "text": "More info"
                        },
                        {
                            "type": "URL",
                            "text": "Buy now",
                            "url": "https://www.website.com/jacket"
                        }
                    ]
                },
                {
                    "header": {
                        "format": "IMAGE",
                        "example": {
                            "header_handle": [
                                "https://www.website.com/card2.jpg"
                            ]
                        }
                    },
                    "body": {
                        "text": "Running shoes, now {{1}} off.",
                        "example": {
                            "body_text": [
                                [
                                    "25%"
                                ]
                            ]
                        }
                    },
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "text": "More info"
                        },
                        {
                            "type": "URL",
                            "text": "Buy now",
                            "url": "https://www.website.com/shoes"
                        }
                    ]
                }
            ]
        }
    }
}

Body oferta por tiempo limitado

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": false,
    "name": "coupon_code_fall2023_25off_02",
    "language": "en_US",
    "category": "MARKETING",
    "structure":
    {
        "header":
        {
            "format": "IMAGE",
            "example":
            {
                "header_handle":
                [
                    "https://iili.io/HDQOyc7.jpg"
                ]
            }
        },
        "limited_time_offer":
        {
            "text": "Fecha límite!",
            "has_expiration": true
        },
        "body":
        {
            "text": "Solo hoy, {{1}}! usa el código {{2}} para obtener un gran descuento al registrarte!",
            "example":
            {
                "body_text":
                [
                    [
                        "Juan Pablo",
                        "25OFF"
                    ]
                ]
            }
        },
        "buttons":
        [
            {
                "type": "COPY_CODE",
                "example":
                [
                    "1234"
                ]
            },
            {
                "type": "URL",
                "text": "Registrate!",
                "url": "https://www.conceptomovil.com/producto_broadcasterdata.html"
            }
        ]
    }
}

Body autenticación zero tap

Para implementar la autenticación sin toques en tu aplicación Android, consulta la documentación de Meta.

💾
{
    "wba_id": "1234567899870",
    "allowCategoryChange": true,
    "name": "zero_tap_example",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure":
    {
        "body":
        {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 5,
        "buttons":
        [
            {
                "type": "OTP",
                "otp_type": "zero_tap",
                "text": "Copy Code",
                "autofill_text": "Autofill",
                "zero_tap_terms_accepted": true,
                "supported_apps":
                [
                    {
                        "package_name": "com.example.luckyshrub",
                        "signature_hash": "K8a/AINcGX7"
                    }
                ]
            }
        ]
    }
}

Body solicitud de información de contacto

Solicita el número de teléfono a los usuarios de WhatsApp que tienen activo un nombre de usuario.

💾
{
    "wba_id": "1234567899870",
    "name": "request_contact_template",
    "language": "es_MX",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "Nos gustaría tener tu contacto para mantenerte al tanto de las últimas novedades. Si deseas recibir actualizaciones y promociones, compártenos tus datos de contacto."
        },
        "buttons":
        [
            {
                "type": "REQUEST_CONTACT_INFO"
            }
        ]
    }
}

Body personalizado con encabezado multimedia (IMAGE)

El endpoint descarga la URL de header_handle y la carga a Meta, reemplazándola por el ID de medio devuelto. Los encabezados VIDEO, DOCUMENT y GIF funcionan de la misma forma (GIF se envía como VIDEO cuando MM Lite no es aplicable).

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_custom_image",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "header": {
            "format": "IMAGE",
            "example": {
                "header_handle": [
                    "https://www.website.com/promo-banner.jpg"
                ]
            }
        },
        "body": {
            "text": "Hi {{1}}, our new collection is here. Tap below to explore.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "URL",
                "text": "View collection",
                "url": "https://www.website.com/collection"
            }
        ]
    }
}

Body con código de cupón (COPY_CODE)

El botón COPY_CODE copia el código de example[0] al portapapeles del cliente cuando se toca.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_coupon_code",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, use the code below to get 25% off your next purchase.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "Offer valid until stock lasts",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop promotions"
            },
            {
                "type": "COPY_CODE",
                "example": [
                    "SAVE25"
                ]
            }
        ]
    }
}

Body con encabezado de ubicación

Una plantilla UTILITY con encabezado LOCATION. El marcador de ubicación se completa al enviar el mensaje de plantilla.

💾
{
    "wba_id": "1234567899870",
    "name": "utility_order_delivery_update",
    "language": "en_US",
    "category": "UTILITY",
    "structure": {
        "header": {
            "format": "LOCATION"
        },
        "body": {
            "text": "Good news {{1}}! Your order #{{2}} is on its way to the location above. Thank you for your order!",
            "example": {
                "body_text": [
                    [
                        "Mark",
                        "566701"
                    ]
                ]
            }
        },
        "footer": "To stop receiving delivery updates, tap the button below.",
        "buttons": [
            {
                "type": "QUICK_REPLY",
                "text": "Stop Delivery Updates"
            }
        ]
    }
}

Body de autenticación con copiar código

💾
{
    "wba_id": "1234567899870",
    "name": "authentication_code_copy_code_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure": {
        "body": {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 10,
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "copy_code",
                "text": "Copy Code"
            }
        ]
    }
}

Body de autenticación con un toque

💾
{
    "wba_id": "1234567899870",
    "name": "authentication_code_autofill_button",
    "language": "en_US",
    "category": "AUTHENTICATION",
    "structure": {
        "body": {
            "add_security_recommendation": true
        },
        "footer_code_expiration_minutes": 15,
        "buttons": [
            {
                "type": "OTP",
                "otp_type": "one_tap",
                "text": "Copy Code",
                "autofill_text": "Autofill",
                "supported_apps": [
                    {
                        "package_name": "com.example.luckyshrub",
                        "signature_hash": "K8a/AINcGX7"
                    }
                ]
            }
        ]
    }
}

Body con botón de catálogo

El botón CATALOG abre el catálogo del negocio vinculado a la WABA.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_catalog_button",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, explore our full product catalog and find your next favorite item.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "footer": "My Company",
        "buttons": [
            {
                "type": "CATALOG",
                "text": "View catalog"
            }
        ]
    }
}

Body con botón de enviar ubicación

El botón SEND_LOCATION solicita al usuario de WhatsApp que comparta su ubicación.

💾
{
    "wba_id": "1234567899870",
    "name": "marketing_send_location_button",
    "language": "es_MX",
    "category": "MARKETING",
    "structure": {
        "body": {
            "text": "Hi {{1}}, share your location so we can find the nearest store for you.",
            "example": {
                "body_text": [
                    [
                        "Ana"
                    ]
                ]
            }
        },
        "buttons": [
            {
                "type": "SEND_LOCATION"
            }
        ]
    }
}

Body con botón de detalles del pedido

El botón ORDER_DETAILS inicia un flujo de pedido y pago. Consulta Plantillas de Payments Brasil.

💾
{
    "wba_id": "1234567899870",
    "name": "order_details_template",
    "language": "es_MX",
    "category": "UTILITY",
    "structure": {
        "body": {
            "text": "Review the details of your order and pay."
        },
        "buttons": [
            {
                "type": "ORDER_DETAILS",
                "text": "Review and pay"
            }
        ]
    }
}

Respuesta

Respuesta de Crear Template:

Si la plantilla se crea correctamente, el servicio responde con el código HTTP 201 y los datos de la plantilla.

Nota: la respuesta puede incluir otros campos opcionales (por ejemplo message_send_ttl_seconds) cuando se enviaron en la petición.

💾
{
    "id": "572279198452421",
    "name": "ejemplo_respuesta",
    "language": "es_MX",
    "status": "PENDING",
    "namespace": "2d2354d2_54fd_123r_842f_2d5b215188fa",
    "wba_id": "1234567899870",
    "category": "MARKETING",
    "allowCategoryChange": true
}