fbpx

< / >

APIs Billing

4. Subir archivo

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

 

Descripción:

Esta API permite enviar un archivo multimedia (imagen, video o documento) a Meta Business Suite para que sirva como ejemplo visual o de contenido al crear una plantilla de WhatsApp que requerirá adjuntos.

Es crucial entender que este archivo subido a través de la API es solamente un ejemplo y no se incluirá directamente en la plantilla final. Cuando un agente de Wolkvox Agent (en su versión web o de escritorio) envíe un mensaje utilizando una plantilla de WhatsApp con archivo multimedia, deberá proporcionar la URL pública del archivo real que desea adjuntar en el campo ‘Enlace de archivo de WhatsApp’ (versión web) o ‘URL archivo’ (versión de escritorio).

Esta API optimiza el proceso de creación de plantillas en Meta Business Suite, que obligatoriamente solicita un archivo multimedia de ejemplo al diseñar plantillas que van a incluir este tipo de contenido.

El archivo enviado a Meta mediante esta API servirá para crear muchas plantillas en su operación. Puedes usar el mismo handle obtenido en un consumo de esta API para usarlo posteriormente en varias APIs de creación de plantillas.

Nota: Es obligatorio que el archivo a enviar mediante esta API esté alojado en wolkvox Storage y se haga uso de su URL pública.

 

Beneficio:

  • Simplificación de la Creación de Plantillas: Agiliza el proceso de diseño de plantillas de WhatsApp con archivos multimedia en Meta Business Suite, al proporcionar un método programático para cumplir con el requisito de ejemplo de archivo.
  • Automatización: Permite automatizar la preparación de los activos necesarios para la creación de plantillas, reduciendo la intervención manual.
  • Eficiencia Operativa: Facilita a las empresas la gestión de sus comunicaciones por WhatsApp a gran escala, al tener los ejemplos de archivos multimedia listos para ser referenciados en las plantillas.
  • Compatibilidad: Asegura que las plantillas creadas en Wolkvox Manager sean compatibles con los requisitos de Meta Business Suite para el envío de mensajes con contenido multimedia.

 

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.
  • Se debe tener en cuenta que solo se puede usar luego de haber iniciado la conversación previamente con el cliente y dentro de las 24 horas que la conversación se encuentra abierta.
  • 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  Identificador único del conector de WhatsApp asociado a tu cuenta. String
file_url La URL pública del archivo multimedia (imagen, video o documento) que deseas subir como ejemplo. Esta URL debe ser accesible desde internet para que Meta pueda descargar el archivo. 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
0 Mensaje interno de confirmación String
handle Este es el valor clave. Es un identificador único generado por Meta para el archivo multimedia subido. Este handle debe ser guardado y utilizado posteriormente en las APIs de creación de plantillas de WhatsApp de Meta Business Suite cuando se requiera un ejemplo de archivo multimedia. Es la referencia que Meta usará para identificar el contenido de ejemplo. 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=upload_media',
  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": "",
    "file_url": ""
}',
  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": "Media uploaded successfully",
    "data": {
        "0": "media_uploaded_successfully",
        "handle": ""
    }
}
				
			

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