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:
Cómo funciona:
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:
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 |
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 |
$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;
curl --location --globoff 'https://wv{{wolkvox-server}}.wolkvox.com/api/v2/whatsapp.php?api=create_auth_template' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--header 'Content-Type: application/json' \
--data '{
"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"
}
]
}
]
}'
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"connector_id\": \"\",\r\n \"name\": \"\",\r\n \"language\": \"\",\r\n \"category\": \"AUTHENTICATION\",\r\n \"components\": [\r\n {\r\n \"type\": \"BODY\",\r\n \"text\": \"Your verification code for SuperApp is: {{1}}. Do not share it with anyone.\",\r\n \"example\": {\r\n \"body_text\": [\r\n [\r\n \"123456\"\r\n ]\r\n ]\r\n }\r\n },\r\n {\r\n \"type\": \"BUTTONS\",\r\n \"buttons\": [\r\n {\r\n \"button_type\": \"OTP\",\r\n \"otp_type\": \"COPY_CODE\",\r\n \"text\": \"Copy Code\"\r\n }\r\n ]\r\n }\r\n ]\r\n}");
Request request = new Request.Builder()
.url("https://wv{{wolkvox-server}}.wolkvox.com/api/v2/whatsapp.php?api=create_auth_template")
.method("POST", body)
.addHeader("wolkvox-token", "{{wolkvox-token}}")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
import requests
import json
url = "https://wv{{wolkvox-server}}.wolkvox.com/api/v2/whatsapp.php?api=create_auth_template"
payload = json.dumps({
"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"
}
]
}
]
})
headers = {
'wolkvox-token': '{{wolkvox-token}}',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"code": "200",
"error": null,
"msg": "Template created successfully",
"data": {
"template_id": "",
"name": "",
"status": ""
}
}
Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34
Sao Paulo
+55 (11) 521 75 933
Madrid
+34 (910) 601 691
Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610
Ciudad de México
+52 (55) 8526 36 34
Santo Domingo
+1 (829) 249 69 68
Copyright © 2025 WOLKVOX MICROSYSLABS. Todos los derechos reservados. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34
ARGENTINA
Buenos Aires +54 (11) 5217 5933
ESPAÑA
Madrid +34 (910) 601 691
MÉXICO
Ciudad de México +52 (55) 8526 36 34
BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83
ESTADOS UNIDOS
New York +1 (914) 373 71 36
REPÚBLICA DOMINICANA
Santo Domingo +1 (829) 249 69 68
CHILE
Santiago de Chile +56 (2) 240 533 89
GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344
PERÚ
Lima +51 (1) 644 91 39
Copyright © 2025 WOLKVOX MICROSYSLABS.
Todos los derechos reservados.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
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