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

< / >

APIs Reports Manager

2. Conversaciones

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=chat_2&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 conocer el contenido de las conversaciones por chat gestionadas por los asesores, indicando de manera específica los mensajes compartidos durante la atención, la fecha de la conversación y la identificación del cliente y asesor.

Beneficio:

Al conocer el contenido de los mensajes compartidos por lo clientes puede verificar si la atención por chat está alineada a los estándares de calidad de la operación, si obtuvo una respuesta en primer contacto e identificar para qué trámites los clientes prefieren los canales de chat.

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
conn_id Número de identificación del chat el cual es asignado automáticamente por el sistema. String
agent_name Nombre del agente. String
customer_name Nombre del cliente. 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
from Indica el remitente del mensaje, puede arrojar los valores AGENT (agente) o CUSTOMER (cliente). String
from_name Indica el nombre del remitente. String
to_name Indica el nombre de quien recibe el mensaje. Puede arrojar el valor “chat bot” para cuando un mensaje de un cliente ha sido enviado a un chat bot. String
date Indica la fecha con formato año-mes -día-Hora. String
message Detalla los mensajes enviados y recibidos por el agente y cliente. String
customer_id Corresponde al número de identificación del cliente. String
customer_phone Número de teléfono del 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_2&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": [
        {
            "conn_id": "",
            "agent_name": "",
            "customer_name": "",
            "conversation": [
                {
                    "channel": "",
                    "from": "",
                    "from_name": "",
                    "to_name": "",
                    "date": "",
                    "message": "",
                    "customer_id": "",
                    "customer_phone": ""
                }
            ]
        }
    ]
}
				
			

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