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

< / >

APIs Reports Manager

1. Chats

URL:

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

Descripción:

Este reporte permite conocer a profundidad la gestión de los canales de chat atendidos por agentes humanos, pormenorizando los detalles del chat (ID chat, fecha, duración, codificación, skill y canal), del cliente (ID, nombre, email, teléfono, caracteres enviados), el agente (ID, nombre, caracteres enviados) y medidores de eficiencia (ASA y Last Participant).

Beneficio:

Brinda una visión completa de la interacción no automatizadas por chat entre cliente y asesor.

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 y el wolkvox-token: {{token}} generado desde wolkvox Manager para obtener la información de manera segura.
  • 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

REQUEST
NAME DESCRIPTION TYPE
api Tipo de reporte requerido. String
date_ini Fecha Inicial (YYYYmmddHHiiss). String
date_end Fecha Final (YYYYmmddHHiiss). String
agent_dni DNI del agente. String

Response

RESPONSE
NAME DESCRIPTION TYPE
conn_id Corresponde al número de identificación del chat. String
channel Indica el canal de contacto de la interacción. Esta columna puede arrojar alguno de los siguientes valores: facebook, instagram, web y whatsapp. String
date Indica la fecha con formato año-mes -día-Hora. String
customer_name Nombre del cliente. String
customer_email Es el correo electrónico del cliente. String
customer_phone Es el teléfono del cliente. String
customer_chars Indica la cantidad numérica de los caracteres digitados por el cliente. String
agent_id Número de extensión del agente. String
agent_name Nombre del agente. String
agent_chars Indica la cantidad numérica de los caracteres digitados por el agente. String
time_on_agent Indica el tiempo que el agente empleó en la atención. String
chat_duration Indica tiempo de duración de la interacción en unidades de segundos. String
cod_act Es el ID del código de tipificación o codificación usado por el agente. String
description_cod_act Indica la descripción del código de tipificación. String
comments Texto tipo comentario de la interacción. String
customer_id Corresponde al número de identificación del cliente. String
skill_id Es la identificación numérica del grupo de la skill. String
ASA El tiempo que transcurre desde que el chat es iniciado por el cliente y respondido por el agente. String
last_participant_who_spoke Indica quién envió el último mensaje. Esta columna arroja los siguientes valores, agent (agente), chat-bot (bot del chat) y customer (cliente). String
extra_field Campo adicional para guardar información. String
comment Texto tipo comentario de la interacción. String
user_id Identificación del usuario. String
feeling Sentimiento analizado e identificado. Los valores que arroja esta columna son: very negative (muy negativo), negative (negativo), neutral (normal), positive (positive) y very positive (muy positivo). String
agent_anwers Número de veces que escribe agente al cliente. 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_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "conn_id": "",
            "channel": "",
            "date": "",
            "customer_name": "",
            "customer_email": "",
            "customer_phone": "",
            "customer_chars": "",
            "agent_id": "",
            "agent_name": "",
            "agent_chars": "",
            "time_on_agent": "",
            "chat_duration": "",
            "cod_act": "",
            "description_cod_act": "",
            "comments": "test",
            "customer_id": "",
            "skill_id": "",
            "ASA": "",
            "last_participant_who_spoke": "",
            "extra_field": "",
            "comment": "",
            "user_id": "",
            "feeling": "",
            "agent_anwers ": ""
        }
    ]
}
				
			

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