fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Customer

2. API WhatsApp para envío de plantillas

URL:

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

Descripción:

API para envío de campañas masivas a través de plantillas HSM

Beneficio:

Esta API permite el envío de campañas y mensajes masivos a través de plantillas HSM previamente aprobadas por Meta, que corresponden a una línea de WhatsApp Business o API Cloud, desde una aplicación externa.

Cómo funciona:

  • El consumo de esta API se realiza por método POST.
  • En el json se agregan los parametros de acuerdo a la operación o proceso a realizar.
  • 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 simultanea, 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.

Request

NAME DESCRIPTION TYPE
connector_id Hace referencia al número identificador del conector de whatsapp móvil creado para la línea String
telephone Es el número de teléfono celular al que se enviará el mensaje String
template_name Nombre de la plantilla String
template_vars Variables String
customer_id Numero de identificación del cliente String
url_attach Hace referencia a la URL pública donde está alojada la imagen String

Response

NAME DESCRIPTION TYPE
code Código de error Int
error Nombre del error String
msg Explicación del error 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=send_template_official',
  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": "1",
    "telephone": "9319xxxxxx",
    "template_name": "my_template",
    "template_vars": "var1;var2;var3",
    "customer_id": "110xxxx03",
    "url_attach": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Message has been sent successfully"
}
				
			

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