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

< / >

APIs Interacciones y Chats

14. Detalle clic a WhatsApp

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=chat_14&date_ini={{date_ini}}&date_end={{date_end}}

 

Descripción:

Permite obtener información detallada de cada interacción individual en el reporte “Detalle Clic a WhatsApp”. Esta API proporciona datos esenciales sobre las interacciones generadas a partir de anuncios o publicaciones, facilitando el análisis y la optimización de campañas.

Beneficio:

  • Análisis Detallado: Permite un análisis detallado de cada interacción, ayudando a identificar patrones y áreas de mejora.
  • Optimización de Campañas: Facilita la optimización de campañas al proporcionar datos específicos sobre el rendimiento de cada anuncio o publicación.
  • Integración Sencilla: La API es fácil de integrar con otras herramientas de análisis y reportes, mejorando la eficiencia operativa.
  • Seguridad: El uso del token de autorización asegura que solo usuarios autorizados puedan acceder a los datos.

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: {{token}} para hacer uso de el token de autorización.
  • Debe reemplazar {{date_ini}} por la fecha y hora de inicio a consultar (formato YYYYMMDDHHMMSS, por ejemplo, 20250201000000).
  • Debe reemplazar {{date_end}} por la fecha y hora de fin a consultar (formato YYYYMMDDHHMMSS, por ejemplo, 20250228235959).
  • 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.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.
  • 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
api Tipo de reporte requerido. String
date_ini Fecha inicial (YYYYmmddHHiiss). String
date_end Fecha final (YYYYmmddHHiiss). String

Response

NAME DESCRIPTION TYPE
code Código de estado de la respuesta. String
error Información detallada sobre cualquier error que pueda haber ocurrido durante la ejecución de la API. String
msg Mensaje informativo que describe la respuesta. String
data Arreglo que contiene los detalles de los chats cerrados por canal. String
source_url URL del anuncio o publicación que originó la interacción. String
source_type Tipo de origen (anuncio o publicación). String
source_id Identificador único del anuncio o publicación. String
chat_id Identificador único del chat. String
rp_id Punto de enrutamiento al que ingresó la interacción. String
agent_id Identificador del agente que recibió la interacción. String
media_type Tipo de medio en el anuncio (imagen o video). String
media_url Enlace a la imagen o video del anuncio. String
date Fecha y hora exacta en que se generó la interacción. String
cod_act Código de actividad usado para la tipificación del resultado final de la interacción registrada en Wolkvox. String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=chat_14&date_ini={{date_ini}}&date_end={{date_end}}',
  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_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "source_url": "",
            "source_type": "",
            "source_id": "",
            "chat_id": "",
            "rp_id": "",
            "agent_id": "",
            "media_type": "",
            "media_url": "",
            "date": "",
            "cod_act": ""
        }
    ]
}
				
			

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