Consultar y eliminar plantillas

Last update: 4 days ago by Irais Aguirre

Consulta plantillas, consulta una plantilla por ID y elimina una plantilla.

Resumen para integración
URL base: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: de administración, en el encabezado Authorization: Bearer {{admin-token}} (cómo generarlo)
Endpoints en esta página:
GET /v1/template/{{waba_id}}: Consultar Templates
GET /v1/template/{{waba_id}}/{{template_id}}: Consultar Template por ID
DELETE /v1/template/{{waba_id}}?template_name={{template_name}}: Eliminar Template

Consultar Templates

Petición

Petición de Consultar Templates:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}
Método	GET
Tipo	application/json

Encabezados

Encabezados de Consultar Templates:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Consultar Templates:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business (WABA). Debe ser la WABA asociada a tu token. Solo admite dígitos.	String	Obligatorio

Ejemplo

Ejemplo completo de Consultar Templates:

curl "https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}" \
-H 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Consultar Templates:

Nombre	Descripción	Tipo
id	ID de la plantilla.	String
name	Nombre del template.	String
language	Lenguaje Local. Ejemplo: es_ES, es_MX, es_US. Lenguajes Soportados: https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/	String
namespace	El espacio de nombres que se utilizará. Si el espacio de nombres no coincide con element_name, el mensaje no se envía.	String
status	Es el estatus en el que se encuentra el template. Por ejemplo: APPROVED REJECTED PENDING	String
category	Categoría de la plantilla: AUTHENTICATION MARKETING UTILITY	String
rejectedReason	Motivo del rechazo. Solo se incluye si la plantilla fue rechazada.	String
created	Fecha de creación.	String
allowCategoryChange	Indica si Meta puede asignar automáticamente la categoría de la plantilla.	Boolean

[
    {
        "id": "747393629111800",
        "name": "aviso",
        "language": "es_MX",
        "status": "APPROVED",
        "namespace": "2d5051d2_76fd_43e4_842f_2d5b215188fa",
        "category": "UTILITY",
        "created": "2021-11-23T16:18:49.285",
        "allowCategoryChange": true
    },
    {
        "id": "142990321034346",
        "name": "bienvenida",
        "language": "es",
        "status": "APPROVED",
        "namespace": "2d5051d2_76fd_43e4_842f_2d5b215188fa",
        "category": "MARKETING",
        "created": "2021-11-23T16:18:49.285",
        "allowCategoryChange": true
    }
]

Consultar Template por ID

Petición

Petición de Consultar Template por ID:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}/{{template_id}}
Método	GET
Tipo	application/json

Encabezados

Encabezados de Consultar Template por ID:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Consultar Template por ID:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business (WABA). Debe ser la WABA asociada a tu token.	String	Obligatorio
template_id	ID de la plantilla.	String	Obligatorio

Ejemplo

Ejemplo completo de Consultar Template por ID:

curl "https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}/{{template_id}}" \
-H 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Consultar Template por ID:

Nota: si no se encuentra la plantilla o la información de su WABA, el servicio responde con HTTP 204 y cuerpo vacío.

Nombre	Descripción	Tipo
id	ID de la plantilla.	String
name	Nombre del template.	String
language	Código de idioma y configuración regional de la plantilla.	String
status	Estatus de la plantilla.	String
category	Categoría de la plantilla.	String
structure	Estructura de la plantilla: encabezado, cuerpo, pie de página y botones.	Objeto structure
allowCategoryChange	Indica si Meta puede asignar automáticamente la categoría de la plantilla.	Boolean

{
    "id": "642673911170541",
    "name": "ejemplo_template",
    "language": "es",
    "status": "APPROVED",
    "category": "MARKETING",
    "structure":
    {
        "body":
        {
            "text": "¡Felices Fiestas {{1}}! Te deseo alegría y felicidad en compañía de tus seres queridos.",
            "example":
            {
                "body_text":
                [
                    [
                        "Cliente"
                    ]
                ]
            }
        }
    },
    "allowCategoryChange": true
}

Eliminar Template

Petición

Petición de Eliminar Template:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}?template_name={{template_name}}
Método	DELETE
Tipo	application/json

Encabezados

Encabezados de Eliminar Template:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Eliminar Template:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business (WABA). Debe ser la WABA asociada a tu token. Solo admite dígitos.	String	Obligatorio
template_name	Nombre de la plantilla, enviado como parámetro de consulta. Se eliminan todos los idiomas de la plantilla con ese nombre.	String	Obligatorio

Ejemplo

Ejemplo completo de Eliminar Template:

curl -X DELETE "https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/template/{{waba_id}}?template_name={{template_name}}" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Eliminar Template:

Nombre	Descripción	Tipo
code	Código de estatus. 0 indica que la plantilla se eliminó; 10 indica que no se pudo eliminar.	Integer
detail	Es el detalle del estatus de la respuesta	String

{
    "code": 0,
    "detail": "Success"
}

Consultar estatus de templates

Para consultar el estatus y la calidad de las plantillas de tu WABA (endpoint template-status), consulta Consultar calidad de plantillas en la sección Semaforización.

Crear plantilla

Cargar multimedia