fbpx

< / >

APIs WhatsApp

6. Listar plantillas

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

 

Descripción:

Esta API permite obtener un listado de todas las plantillas de mensajes de WhatsApp que están asociadas a un conector de WhatsApp específico integrado en tu operación. Esta API es fundamental para administradores y desarrolladores que necesitan una visión general de las plantillas disponibles, sus estados de aprobación, idiomas y componentes.

 

 

Beneficio:

  • Visibilidad Completa de Plantillas: Permite a los usuarios y sistemas obtener una lista exhaustiva de todas las plantillas de WhatsApp asociadas a un conector específico, incluyendo su estado de aprobación y detalles de contenido.
  • Gestión Centralizada: Facilita la auditoría y gestión de las plantillas de WhatsApp directamente desde Wolkvox Manager, sin necesidad de acceder a la plataforma de Meta Business Suite para verificar su existencia o estado.
  • Automatización de Workflows: Permite que otras aplicaciones o procesos programáticos consulten la disponibilidad y el estado de las plantillas para automatizar el envío de mensajes o la gestión de campañas.
  • Optimización de Campañas: Al conocer el estado de las plantillas (APROBADA, PENDIENTE, RECHAZADA), los equipos de marketing pueden planificar y ejecutar sus campañas de WhatsApp de manera más eficiente.
  • Resolución de Problemas: Ayuda a diagnosticar problemas relacionados con plantillas que no se envían, al poder verificar rápidamente su estado y configuración.

 

Cómo funciona:

  • El consumo de esta API se realiza por método GET.
  • 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 número de identificación del conector de WhatsApp en tu operación de Wolkvox Manager del cual deseas listar las plantillas. 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
meta_templates Un arreglo de objetos, donde cada objeto representa una plantilla de WhatsApp y sus propiedades. String
name El nombre único de la plantilla. String
previous_category La categoría anterior de la plantilla, si ha sido modificada. String
parameter_format Formato de los parámetros de la plantilla. String
components Arreglo que describe las secciones de la plantilla. String
type Tipo de componente (ej. “HEADER”, “BODY”, “FOOTER”, “BUTTONS”). String
format Tipo de multimedia si el encabezado es multimedia (ej. “IMAGE”, “DOCUMENT”, “VIDEO”). String
example Contiene ejemplos del contenido, como header_handle (URLs de ejemplo de archivos multimedia) o body_text (ejemplos para variables del cuerpo). String
text El contenido textual del componente. String
buttons Arreglo de objetos que describen los botones (tipo, texto, URL, flow_id, flow_action, Maps_screen para flujos). 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
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
status El estado de la plantilla en Meta Business Suite. Puede ser: “APPROVED”: La plantilla ha sido revisada y aprobada, lista para ser usada. “PENDING”: La plantilla está en proceso de revisión. “REJECTED”: La plantilla no ha sido aprobada. String
category La categoría de la plantilla (ej. “UTILITY”, “MARKETING”, “AUTHENTICATION”). String
sub_category Subcategoría de la plantilla, si aplica (ej. “CUSTOM”, “FORM”). String
id El ID único de la plantilla en Meta. String
templateName Este campo representa el nombre identificador de la plantilla tal como se maneja internamente en Wolkvox Manager. Funciona como un alias o un nombre amigable para la plantilla dentro del ecosistema de Wolkvox. String
plantilla Este campo contiene el texto del cuerpo del mensaje de la plantilla. presenta el texto completo del mensaje, incluyendo las variables, de una manera más directa y consolidada. 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=list_templates',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "connector_id": ""
}',
  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": "Templates listed successfully",
    "data": {
        "meta_templates": [
            {
                "name": "",
                "previous_category": "",
                "parameter_format": "POSITIONAL",
                "components": [
                    {
                        "type": "",
                        "text": ""
                    },
                    {
                        "type": "BUTTONS",
                        "buttons": [
                            {
                                "type": "URL",
                                "text": "",
                                "url": ""
                            }
                        ]
                    }
                ],
                "language": "",
                "status": "",
                "category": "",
                "id": ""
            }
        ]
    }
}
				
			

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