fbpx

< / >

APIs WhatsApp

5. Crear plantilla (Marketing)

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

 

Descripción:

API que permite la creación programática de plantillas de mensajes de WhatsApp de categoría Marketing directamente en un conector de WhatsApp vinculado a tu operación. 

Con esta API, puedes definir el nombre de la plantilla, el idioma, la categoría y los componentes del mensaje, incluyendo encabezados multimedia y el cuerpo del texto con variables personalizables. Esto agiliza el proceso de aprobación de plantillas por parte de Meta, permitiéndote gestionar tus campañas de marketing de manera más eficiente.

 

Beneficio:

  • Creación Programática de Plantillas: Permite automatizar la creación de plantillas de WhatsApp, lo que es esencial para operaciones con alto volumen de campañas.
  • Agilización del Marketing: Facilita la implementación rápida de campañas de marketing a través de WhatsApp, reduciendo el tiempo de configuración.
  • Centralización de la Gestión: Permite gestionar las plantillas directamente desde Wolkvox Manager, manteniendo la coherencia y el control.
  • Personalización a Escala: La capacidad de incluir variables en el cuerpo del mensaje permite enviar comunicaciones personalizadas a un gran número de clientes de manera eficiente.
  • Cumplimiento con Requisitos de Meta: La estructura de la API está diseñada para cumplir con las especificaciones de Meta para la creación de plantillas, lo que ayuda a garantizar un proceso de aprobación más fluido.

 

Cómo funciona:

  • El consumo de esta API se realiza por método POST.
  • 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 se vinculará la plantilla. String
name El nombre único de la plantilla. Importante: Este nombre debe ser único en toda tu operación de Wolkvox Manager y no puede repetirse en otras plantillas. Tampoco puede contener mayúsculas ni  espacios ni caracteres especiales aunque sí puede contener números. String
language El código de idioma de la plantilla. Debe ser uno de los idiomas soportados por Meta (consulta la lista completa dando [clic aquí]) String
category La categoría de la plantilla. Para esta API, debe ser “MARKETING”. String
components Un arreglo de objetos que definen las secciones de la plantilla (encabezado, cuerpo, pie de página, botones). Array
type Componente “HEADER” (opcional). String
format El tipo de archivo multimedia. Puede ser “IMAGE”, “VIDEO” o “DOCUMENT”. String
example Objeto que contiene el header_handle. Object
header_handle El valor handle obtenido previamente al consumir la API de subir archivo. String
type Componente “BODY”. String
text El contenido del mensaje. Puedes incluir variables dinámicas utilizando {{1}}, {{2}}, etc. Los agentes de Wolkvox Agent podrán reemplazar estos valores al enviar el mensaje. (Ej. “Hello {{1}}! Example message. {{2}}”). 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 “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 Define el tipo de acción que realizará el botón. Los tipos de botones soportados en wolkvox son “URL”, “QUICK_REPLY”, “PHONE_NUMBER” y  “FLOW”. Obtén más información acerca de los tipos de botones dando [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
name El ID único de la plantilla generada por Meta. String
status El estado actual de la plantilla en el proceso de revisión de Meta. Los posibles estados son: “APPROVED”: La plantilla ha superado la revisión y se puede usar para enviar mensajes. “PENDING”: La plantilla ha superado la validación inicial y está en proceso de revisión por parte de Meta. “REJECTED”: La plantilla no ha superado la validación de categoría o la revisión de Meta.  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=create_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 => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "connector_id": "",
    "name": "",
    "language": "",
    "category": "MARKETING",
    "components": [
        {
            "type": "HEADER",
            "format": "",
            "example": {
                "header_handle": ""
            }
        },
        {
            "type": "BODY",
            "text": "",
            "example": {
                "body_text": [
                    [
                        ""
                    ]
                ]
            }
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "",
                    "text": ""
                },
                {
                    "type": "",
                    "text": ""
                }
            ]
        }
    ]
}',
  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 created 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