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

< / >

APIs

8. Reporte en tiempo real de chats

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats

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 entrega información completa y en tiempo real de todos los chats que están activos en su operación al momento de la consulta.

Beneficio:

Permite a los administradores monitorear y gestionar las interacciones en tiempo real, asegurando que los agentes estén respondiendo de manera oportuna y efectiva, lo que mejora la eficiencia operativa y la satisfacción del cliente.

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

Response

NAME DESCRIPTION TYPE
agent_id Número de extensión del agente. String
active_chats Chats activos del agente. String
conn_id Número de identificación del chat. String
channel Tipo de canal donde está sucediendo el chat. String
connector_id Número de identificación del conector de WhatsApp. String
customer_phone Número de teléfono del cliente. String
conversation Conjunto de datos acerca de un mensaje enviado en la conversación. String
from Indica quién fue el remitente del mensaje. String
msg Mensaje que envió el remitente. String
date Fecha en que se envió el mensaje. String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats',
  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": [
        {
            "agent_id": "",
            "active_chats": [
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                },
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                }
            ]
        },
        {
            "agent_id": "",
            "active_chats": [
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                }
            ]
        }
    ]
}
				
			

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