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

< / >

APIs Reports Manager

4. Detalle interacciones

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

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.

 

Descripción:

Este reporte permite consultar el detalle de las interacciones, especificando la información del mensaje (remitente, quien gestiona la atención, mensaje y respuesta), el skill, la fecha (creación y cierre), el agente, evaluación y comentarios.

Beneficio:

Identifique la trazabilidad de la atención de interacciones por medio de la información detallada y evalúe si la manera de gestionar la conversación está alineada con los atributos de calidad de la operación.

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.
  • 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.

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
channel Indica el canal de contacto entre el cliente y el agente. Esta columna puede arrojar alguno de los siguientes valores, Email, facebook_page, instagram, y twitter. String
agent_name Nombre del agente String
skill_id Es la identificación numérica del grupo de la skill              String
case_id Corresponde al número de identificación del caso           String
subject  Indica el asunto del email para el caso de una interacción de tipo email o el nombre de quien escribió en el muro de Facebook, Instagram o Twitter. String
from Indica el remitente del mensaje, para el caso de email si es un correo electrónico o el número de ID y su nombre si es un perfil de Facebook, Instagram o Twitter. String
to Indica el destinatario del mensaje, para el caso de email si es un correo electrónico o el número de ID y su nombre si es un perfil de Facebook, Instagram o Twitter. String
body Hace referencia al cuerpo del mensaje String
answer Hace referencia a la respuesta que recibe el remitente sobre su mensaje String
date_creation Indica la fecha y hora de creación del mensaje String
close_date Indica la fecha de cierre de la interacción String
evaluation_survey Indica la evaluación que obtuvo la interacción en caso de haber respondido la encuesta String
cod_act Es el ID del código de tipificación o codificación usado por el agente String
cod_description Descripción del código de tipificación String
comments Texto tipo comentario de la interacción String
attachments Archivos adjuntos String
status Indica el estado de la interacción. Puede arrojar los valores, open (interacción abierta), close (interacción cerrada) y archived (interacción archivada). 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_4&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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "channel": "",
            "agent_name": "",
            "skill_id": "",
            "case_id": "",
            "subject": "",
            "from": "",
            "to": "",
            "body": "",
            "answer": "",
            "date_creation": "",
            "close_date": "",
            "evaluation_survey": "",
            "cod_act": "",
            "comments": "",
            "attachments": "",
            "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