5. Latency Report En - Wolkvox

< / >

APIs Real Time

5. Latency Report En

URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=latency Description: This API provides information on the measurement of lost packets, Jitter, Ploss, among other data that allow us to know the latency of each of the agents in the operation. Benefit: This API allows to measure the conditions of the network and thus to discard it when there is a problem in the operation. How it works:

The consumption of this API is done by GET method.
To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
The wolkvox-token header must be used to make use of the authorization token.
Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.

REQUEST

NAME	DESCRIPTION	TYPE
api	Type of report required	String

RESPONSE

NAME	DESCRIPTION	TYPE
agent_id	Refers to the numerical identification of each wolkvox Agent user.	String
latency_ms	The exact time it takes for a packet to be transmitted within the network.	int
ip	Refers to the public IP address where the consultant is connected to the Internet.	String
version	Indicates the version of the wolkvox Agent application that the consultant has at the time of the query.	String
agent_status	Details the agent’s auxiliary status	String
tx_jitter	Variation in the delay time of sent packets	int
rx_jitter	Variation in delay time of received packets	int
tx_ploss	Percentage of packets sent lost	int
rx_ploss	Percentage of packages received that were lost	int
network_rejection	Corresponds to the percentage of rejections that an agent extension makes when wolkvox tries to deliver a call to it. All inbound calls for an advisor are those that affect the indicator (inbound, internalcall, Out_pre). This value should not exceed 1%.	int
connection_type		String
last_date		String
total_agents		String
average_latency		String
maximum		String
minimum		String
user		String
status	Indicates the status of the advisor at the time of the query	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;

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=latency")
  .method("GET", null)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload={}
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response. Text)

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"
                }
            ]
        }
    ]
}