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

< / >

APIs Real Time

5. Reporte de latencia

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

Descripción:

Esta API arroja la información de la medición de los paquetes perdidos, el Jitter, Ploss entre otros datos que permiten conocer la latencia de cada uno de los agentes de la operación.

Beneficio:

Esta API permite medir las condiciones de la red y así hacer descarte de la misma cuando tienen algún inconveniente en 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

Response

NAME DESCRIPTION TYPE
by_agent Agrupa estadísticas por agente.  
agent_id Número de extensión del agente. String
latency_ms Es el tiempo exacto que tarda en transmitirse un paquete dentro de la red. int
ip Hace referencia a la dirección IP pública donde está conectado a internet el asesor. String
version Indica la versión del aplicativo wolkvox Agent que tiene el asesor en el momento de la consulta. String
agent_status Detalla el estado del agente. String
tx_jitter Variación en el tiempo de retardo de paquetes enviados. int
rx_jitter Variación en el tiempo de retardo de paquetes recibidos. int
tx_ploss Porcentaje de paquetes enviados perdidos. int
rx_ploss Porcentaje de paquetes recibidos perdidos. int
network_rejection Corresponde al porcentaje de rechazos que una extensión de agentes realiza cuando wolkvox intenta entregarle una llamada. Todas las llamadas entrantes para un asesor son las que afectan el indicador (inbound, internalcall, Out_pre). Este valor no debe ser superior del 1% int
connection_type Indica el tipo de conexión a Internet. Puede arrojar el valor “Ethernet” o “Wifi”. String
platform Indica desde qué versión de wolkvox Agent ha iniciado sesión. Puede arrojar el valor “app” para wolkvox Agent en su versión de escritorio y “web” para wolkvox Agent en su versión. String
last_date Última fecha de llamada. String
by_ip Agrupa estadísticas por ip.  
ip Es la dirección ip a la que se hace referencia. String
total_agents Número total de agentes que conectados en la ip. String
average_latency Latencia promedio en la ip. String
maximum Latencia máxima que se ha registrado en la ip. String
minimum Latencia mínima que se ha registrado en la ip. String
by_pbx Agrupa estadísticas por pbx.  
user Indica el usuario del pbx de referencia. String
status Indica el estado del usuario al momento de la consulta. 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=latency',
  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": "x records were found",
    "data": [
        {
            "by_agent": [
                {
                    "agent_id": "",
                    "latency_ms": "",
                    "ip": "",
                    "version": "",
                    "agent_status": "",
                    "tx_jitter": "",
                    "rx_jitter": "",
                    "tx_ploss": "",
                    "rx_ploss": "",
                    "network_rejection": "",
                    "connection_type": "",
                    "platform": "",
                    "last_date": ""
                }
            ],
            "by_ip": [
                {
                    "ip": "",
                    "total_agents": "",
                    "average_latency": "",
                    "maximum": "",
                    "minimum": "",
                    "network_rejection": ""
                }
            ],
            "by_pbx": [
                {
                    "user": "",
                    "status": "",
                    "tx_jitter": "",
                    "rx_jitter": "",
                    "tx_ploss": "",
                    "rx_ploss": ""
                }
            ]
        }
    ]
}
				
			

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