fbpx

< / >

APIs WhatsApp

7. Crear plantilla (Autenticación)

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

 

Descripción:

API que permite la creación de plantillas de mensajes de WhatsApp de tipo Autenticación. Estas plantillas están optimizadas para enviar códigos de un solo uso (OTP – One-Time Password) o información de verificación similar a los usuarios, garantizando un proceso seguro y eficiente para la autenticación de identidades o transacciones.

 

Beneficio:

  • Autenticación Segura y Eficiente: Facilita la implementación de procesos de autenticación robustos y rápidos mediante el envío de códigos de un solo uso vía WhatsApp.
  • Mejora de la Experiencia del Usuario: Los botones de “Copiar Código” simplifican la interacción del usuario al ingresar códigos, reduciendo la fricción y posibles errores.
  • Automatización de Flujos de Verificación: Permite integrar la autenticación por WhatsApp en sistemas automatizados (por ejemplo, inicio de sesión, confirmación de transacciones).
  • Cumplimiento con Estándares: La estructura de la plantilla se alinea con los requisitos específicos de Meta para mensajes de autenticación, lo que contribuye a un proceso de aprobación más fluido.
  • Versatilidad: Aunque está optimizada para OTP, se puede adaptar para otras necesidades de verificación de identidad que requieran un mensaje claro y una acción directa.

 

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 “AUTHENTICATION“. Puedes ir a la documentación oficial de Meta Business acerca de las plantillas de autenticación dando [clic aquí]. String
components Un arreglo de objetos que definen las secciones de la plantilla (encabezado, cuerpo, pie de página, botones). Array
type Componente “BODY”. String
text El contenido principal del mensaje. Debe incluir una variable para el código de autenticación. (Ej. “Your verification code for SuperApp is: {{1}}. Do not share it with anyone.”). Este texto no debe cambiarse ya que está preestablecido por Meta Business. El texto se traducirá al idioma establecido en el campo “language”. 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
button_type (One-Time Password). Este es un tipo de botón específico para plantillas de autenticación. String
otp_type El tipo de acción del botón OTP. “COPY_CODE”: Permite al usuario copiar el código de autenticación al portapapeles con un solo toque. String
text El texto que se mostrará en el botón. (Ej. “Copy Code”). 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_auth_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": "AUTHENTICATION",
    "components": [
        {
            "type": "BODY",
            "text": "Your verification code for SuperApp is: {{1}}. Do not share it with anyone.",
            "example": {
                "body_text": [
                    [
                        "123456"
                    ]
                ]
            }
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "button_type": "OTP",
                    "otp_type": "COPY_CODE",
                    "text": "Copy Code"
                }
            ]
        }
    ]
}',
  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