fbpx

< / >

APIs WhatsApp

10. Editar plantilla

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=edit_template

 

Descripción:

Esta API permite a los usuarios editar la información de las plantillas de mensajes de WhatsApp que ya han sido creadas y asociadas a un conector específico. Esta funcionalidad es fundamental para mantener las plantillas actualizadas, corregir errores o ajustar el contenido sin tener que crear una nueva plantilla desde cero.

 

Beneficio:

  • Flexibilidad y Agilidad: Permite a las empresas adaptar rápidamente sus mensajes de WhatsApp a nuevas promociones, cambios de información o actualizaciones de políticas sin tener que esperar por la aprobación de nuevas plantillas completas.
  • Optimización Continua: Facilita la prueba A/B de diferentes contenidos o llamadas a la acción en las plantillas existentes para mejorar el rendimiento de las comunicaciones.
  • Consistencia de Marca: Mantiene la coherencia de la marca al permitir actualizaciones en la redacción, encabezados o pies de página de las plantillas existentes.
  • Ahorro de Tiempo y Recursos: Evita el proceso de creación y aprobación de una plantilla completamente nueva para pequeñas modificaciones, optimizando el tiempo del equipo.
  • Manejo de Requisitos de Meta: Aunque los cambios requieren una nueva revisión, este proceso es más eficiente que la creación de una plantilla totalmente nueva.

 

Cómo funciona:

  • El consumo de esta API se realiza por método PUT.
  • Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
  • Se debe hacer uso del header wolkvox-token para hacer uso de el token de autorización.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • Límite de registros que se pueden bajar por consumo: 60,000 registros.
  • Límite de registros que se pueden subir por consumo: 10,000 registros.
  • Límite de días consultados en fechas: 31 días.
  • Límite de peso del resultado: 256 MB.
  • Límite de tiempo de consumo del API: 60 segundos.
  • Límite de consumo simultáneo de un token: 2 solicitudes simultáneas.
  • Límite diario de tokens: Número de licencias multiplicado por 1000 tokens diarios.

 

Ejemplos de código:

En nuestro workspace de Postman (da clic aquí para ir), tienes acceso a ejemplos de código que facilitan la integración con nuestras APIs en diferentes lenguajes de programación, como cURL, Python, JavaScript, y más.

Esta funcionalidad es ideal para integraciones rápidas y permite adaptar los llamados a la API según el lenguaje de programación de tu sistema.

Cómo Usar los Ejemplos de Código:

  1. Navega a nuestro workspace en Postman.
  2. Selecciona la API que deseas consultar.
  3. Edita los parámetros necesarios de la API según tus objetivos.
  4. En la pestaña de “Code”, selecciona el lenguaje de tu preferencia.
  5. Obtendrás un fragmento de código autogenerado, listo para usarse con los parámetros y autenticación configurados anteriormente.

 

 

Request

NAME DESCRIPTION TYPE
connector_id El ID del conector de WhatsApp al que pertenece la plantilla que se desea editar. (Ej. “1266”). String
name El nombre exacto de la plantilla existente que se desea modificar. Este campo es crucial para identificar la plantilla a editar. String
components Un arreglo de objetos que definen las secciones actualizadas de la plantilla. Cada objeto dentro de este arreglo representa una sección (ej. HEADER, BODY, FOOTER, BUTTONS) y sus propiedades. Se deben incluir todos los componentes que conformarán la versión actualizada de la plantilla, incluso si algunos no cambian, para asegurar que la plantilla se reemplace completamente con la nueva definición. String
type “HEADER” String
format  El formato del encabezado (ej. "TEXT", "IMAGE", "VIDEO", "DOCUMENT"). Array
text El texto del encabezado (si format es "TEXT"). Puede contener variables. String
format El tipo de archivo multimedia. Puede ser “IMAGE”, “VIDEO” o “DOCUMENT”. String
example Objeto para proporcionar ejemplos de las variables. Object
header_text Un arreglo con un arreglo interno que contiene el valor de ejemplo para la variable en el text del encabezado. String
type Componente “BODY”. String
text El contenido principal del mensaje. Puede contener variables dinámicas (ej. {{1}}, {{2}}, {{3}}). String
example Objeto que contiene body_text Object
body_text Obligatorio. Un arreglo de arreglos con textos de ejemplo para las variables definidas en text. Estos ejemplos son solo para la revisión de Meta y no se envían al cliente final. (Ej. [[“Example Name”, “Example Name 2”]]). String
type Componente “FOOTER”. String
text El texto que se mostrará en el pie de página de la plantilla. (Ej. “Use the buttons below to manage your marketing subscriptions”). String
type Componente “BUTTONS”. Define un botón individual y sus propiedades. String
buttons Arreglo que representa un botón individual con sus propiedades específicas. String
type El tipo de botón (ej. “QUICK_REPLY”, “URL”, “PHONE_NUMBER”, “FLOW”, “OTP”). Para leer la documentación oficial de Meta Business acerca de los botones da [clic aquí]. String
text Texto que se mostrará en el botón. String

Response

NAME DESCRIPTION TYPE
code Código de error Int
error Nombre del error String
msg Explicación del error String
data Objeto que contiene los datos relevantes de la carga Object
template_id El ID único de la plantilla en Meta. Este ID no cambia con la edición. String
name El nombre de la plantilla que fue editada. String
status El estado actual de la plantilla después de la edición. Después de una edición, la plantilla entrará en un proceso de revisión y su estado será “PENDING” hasta que Meta la apruebe nuevamente, momento en el que cambiará a “APPROVED”. El ejemplo proporcionado muestra “APPROVED” lo cual implicaría que la revisión ya finalizó. String

 

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=edit_template',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "connector_id": "",
    "name": "",
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "",
            "example": {
                "header_text": [
                    ""
                ]
            }
        },
        {
            "type": "BODY",
            "text": "",
            "example": {
                "body_text": [
                    [
                        ""
                    ]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "Use the buttons below to manage your marketing subscriptions"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Unsubcribe from Promos"
                },
                {
                    "type": "QUICK_REPLY",
                    "text": "Unsubscribe from All"
                }
            ]
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Template edited successfully",
    "data": {
        "template_id": "",
        "name": "",
        "status": ""
    }
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales