fbpx

< / >

APIs Real Time

5. Reporte de latencia

URL:

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 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.
REQUEST
NAME DESCRIPTION TYPE
api Tipo de reporte requerido String
RESPONSE
NAME DESCRIPTION TYPE
agent_id Se refiere a la identificación numerica de cada uno de los usuarios de wolkvox 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 auxiliar 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   String
last_date   String
total_agents   String
average_latency   String
maximum   String
minimum   String
user   String
status Indica el estado del asesor al momento de la consulta String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=latency',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; 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": 300,
                    "ip": "",
                    "version": "",
                    "agent_status": "",
                    "tx_jitter": 0,
                    "rx_jitter": 0,
                    "tx_ploss": 0,
                    "rx_ploss": 0,
                    "network_rejection": 0,
                    "connection_type": "",
                    "last_date": ""
                }
            ],
            "by_ip": [
                {
                    "ip": "",
                    "total_agents": "",
                    "average_latency": "",
                    "maximum": "",
                    "minimum": "",
                    "network_rejection": 0
                }
            ],
"by_pbx": [
                {
                    "user": "",
                    "status": "",
                    "tx_jitter": "",
                    "rx_jitter": "",
                    "tx_ploss": "",
                    "rx_ploss": "0"
                }
            ]
        }
    ]
}
				
			

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