logoDocumentación
WhatsApp
Server Center
Quick AccessConsoleMeta Operation GuideREST APIFAQ
Buscar
Español
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Indonesian
Deutsch
Français
Iniciar sesión
REST API / Template Management API

Template Management API

Última actualización：hace casi 3 años

Visión general

Mediante la API de gestión de plantillas, se pueden añadir, eliminar y consultar las plantillas de WABA.

Validación de la llamada

EngageLab REST API autenticación básica HTTP método de verificación: añadir el encabezado HTTP Authorization (Header):

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}
Este bloque de código se muestra en una ventana flotante

El algoritmo anterior de generación de base64_auth_string es el siguiente: base64(dev_key:dev_secret)

  • El nombre del encabezado es "Authorization" y el valor es un par "username:password" convertido a base64 (con dos puntos en medio).
  • En el escenario de la API de WhatsApp, el nombre de usuario es DevKey y la contraseña es DevSecret. En la consola, se debe seleccionar Gestión de configuración – clave de API para obtener la página.

Obtener plantillas

Dirección de llamada

GET https://wa.api.engagelab.cc/v1/templates

Parámetros de solicitud

Parámetro Tipo Opción Descripción
name String Opcional Nombre de la plantilla; nota: este campo utiliza coincidencia aproximada
language_code String Opcional Idioma de la plantilla; consulte el [código de idioma]
category String Opcional Categoría de la plantilla.
● AUTHENTICATION: Código de verificación
● MARKETING: Marketing
● UTILITY: Notificación de servicio
status String Opcional Estado de la plantilla:
  • APPROVED - Aprobada
  • PENDING - Pendiente
  • REJECTED - Rechazada
  • PENDING_DELETION - Pendiente de eliminación
  • DELETED - Eliminada
  • DISABLED - Deshabilitada (bloqueada)
  • IN_APPEAL - En apelación
  • PAUSED - En pausa
    Los desarrolladores deben centrarse principalmente en APPROVED/PENDING/REJECTED/DISABLED
    		•

    Parámetros de respuesta

    Parámetro Tipo Opción Descripción
    id String Obligatorio ID de la plantilla
    name String Obligatorio Nombre de la plantilla
    language String Obligatorio Idioma de la plantilla; consulte código de idioma.
    category String Obligatorio Tipo de plantilla.
  • OTP: contraseña de un solo uso
  • MARKETING: marketing
  • TRANSACTIONAL: transaccional
    Nota: La categoría de plantilla se actualizará:
  • AUTHENTICATION
  • MARKETING
  • UTILITY
    • components Object Array Obligatorio Para obtener más información sobre el contenido de la plantilla, consulte crear objetos components en una plantilla
    status String Obligatorio Estado de la plantilla:
  • APPROVED
  • IN_APPEAL
  • PENDING
  • REJECTED
  • PENDING_DELETION
  • DELETED
  • DISABLED
  • PAUSED
  • LIMIT_EXCEEDED
    		•

    Consultar información de la plantilla

    Endpoint de API

    GET https://wa.api.engagelab.cc/v1//{template_id}

    Donde {template_id} representa el ID de la plantilla que se desea consultar.

    Parámetros de respuesta

    Parámetro Tipo Obligatorio Descripción
    id String Obligatorio ID de la plantilla
    name String Obligatorio Nombre de la plantilla
    language String Obligatorio Idioma de la plantilla; consulte códigos de idioma.
    category String Obligatorio Categoría de la plantilla.
  • OTP: contraseña de un solo uso
  • MARKETING: marketing
  • TRANSACTIONAL: transaccional
    Nota: Las categorías de plantilla se actualizarán a más tardar el 1 de mayo de 2023 a:
  • AUTHENTICATION
  • MARKETING
  • UTILITY
    		•
    components Object Array Obligatorio Componentes del contenido de la plantilla; consulte objeto Components en Create Template.
    status String Obligatorio Estado de la plantilla:
    APPROVED, IN_APPEAL, PENDING, REJECTED, PENDING_DELETION, DELETED, DISABLED, PAUSED, LIMIT_EXCEEDED

    Crear una plantilla

    Parámetros de solicitud

    Parámetro Tipo Opción Descripción
    name String Obligatorio Nombre de la plantilla. Solo puede contener letras minúsculas, números y guiones bajos. No puede superar los 512 caracteres.
    language String Obligatorio Idioma de la plantilla; consulte código de idioma.
    category String Obligatorio Tipo de plantilla.
  • OTP: contraseña de un solo uso
  • MARKETING: marketing
  • TRANSACTIONAL: transaccional
    Nota: La categoría de plantilla se actualizará a más tardar el 1 de mayo de 2023 a:
  • AUTHENTICATION
  • MARKETING
  • UTILITY
    • components Object Array Obligatorio Componentes obligatorios que describen el contenido de la plantilla. Para obtener más información, consulte objeto components

    Objeto components

    Este objeto describe el contenido de la plantilla. La plantilla se divide en varios componentes, como HEADER, BODY, FOOTER y BUTTONS.

    Componentes header y HEADER

    El componente header es opcional. No se debe configurar este componente si no es necesario establecer el header.

    Parámetro Tipo Opción Descripción
    type String Obligatorio Tipo de componente. Valores válidos: HEADER.
    format String Obligatorio Formato del header. Valores válidos: text, image, video y document.
    text String Opcional Contenido del texto del header. Este campo debe configurarse cuando format = text.
    example JSON Object Opcional Ejemplo de header. Este campo es obligatorio cuando text contiene variables o cuando format es de tipo multimedia.
    Componente body

    El componente body es obligatorio. Se debe configurar el contenido del body.

    Parámetro Tipo Opción Descripción
    type String Obligatorio Tipo de componente. Valores válidos: BODY.
    text String Obligatorio Contenido del body. Puede tener hasta 1024 caracteres.
    example JSON Object Opcional Ejemplo de body. Este campo es obligatorio cuando text contiene variables.

    El componente footer es opcional. No se debe configurar este componente si no es necesario establecer el footer.

    Parámetro Tipo Opción Descripción
    type String Obligatorio Tipo de componente. Establecer el valor en FOOTER.
    text String Obligatorio Contenido del footer. Solo se admite texto sin formato; no se pueden definir variables.
    Componente de botones BUTTONS

    El componente buttons es opcional en su conjunto. No se debe configurar este componente si no es necesario configurar botones.

    Parámetro Tipo Opción Descripción
    type String Obligatorio Tipo de componente. Valores válidos: BUTTONS.
    buttons Object Array Obligatorio Información del botón; consulte descripción del objeto buttons.

    Parámetros de respuesta

    Respuesta correcta

    Parámetro Tipo Opción Descripción
    template_id String Obligatorio ID de la plantilla.

    Respuesta de error

    Parámetro Tipo Opción Descripción
    code int Obligatorio Código de error.
    message String Obligatorio Mensaje de error.

    Actualizar plantilla

    Parámetros de respuesta

    Respuesta correcta

    Parámetro Tipo Opción Descripción
    code int Obligatorio Código de retorno, fijo en 0
    message String Obligatorio Información devuelta.

    Respuesta de error

    Parámetro Tipo Opción Descripción
    code int Obligatorio Código de error.
    message String Obligatorio Mensaje de error.

    Eliminar plantilla

    Parámetros de respuesta

    Respuesta correcta

    Parámetro Tipo Opción Descripción
    code int Obligatorio Código de retorno, fijo en 0
    message String Obligatorio Información devuelta.

    Respuesta de error

    Parámetro Tipo Opción Descripción
    code int Obligatorio Código de error.
    message String Obligatorio Mensaje de error.

    Códigos de error

    Código Código HTTP Descripción
    2004 403 No se dispone de autorización para llamar a esta API.
    3001 400 El formato del parámetro de solicitud no es válido. Se debe comprobar si se utiliza el formato JSON.
    3002 400 Los parámetros de solicitud son incorrectos. Se debe comprobar si los parámetros cumplen los requisitos.
    icon
    Contacto