ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRAZIL
Sao Paulo +55 (11) 521 75 933
CHILE
Santiago de Chile +56 (2) 240 533 89
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:
REQUEST
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| api | Type of report required. | String |
RESPONSE
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| by_agent | Groups statistics by agent. | |
| agent_id | Agent’s extension number. | String |
| latency_ms | This is the exact time it takes for a packet to be transmitted within the network. | int |
| ip | This refers to the public IP address where the advisor is connected to the internet. | String |
| version | Indicates the version of the wolkvox Agent application that the advisor has at the time of the query. | String |
| agent_status | Details the agent’s status. | String |
| tx_jitter | Variation in the time delay of sent packets. | int |
| rx_jitter | Variation in the time delay of received packets. | int |
| tx_ploss | Percentage of lost sent packets. | int |
| rx_ploss | Percentage of lost received packets. | int |
| network_rejection | This corresponds to the percentage of rejections that an agent extension makes when wolkvox attempts to deliver a call to them. All incoming calls for an advisor are the ones that affect this indicator (inbound, internalcall, Out_pre). This value should not exceed 1%. | int |
| connection_type | It indicates the type of internet connection. It can show the value “Ethernet” or “Wifi”. | String |
| platform | It indicates from which version of wolkvox Agent they have logged in. It can show the value “app” for the desktop version of wolkvox Agent, and “web” for the web version of wolkvox Agent. | String |
| last_date | Last call date. | String |
| by_ip | Groups statistics by IP. | |
| ip | It is the IP address being referred to. | String |
| total_agents | Total number of agents connected to the IP. | String |
| average_latency | Average latency on the IP. | String |
| maximum | Maximum latency recorded on the IP. | String |
| minimum | Minimum latency recorded on the IP. | String |
| by_pbx | Groups statistics by PBX. | |
| user | Indicates the user of the reference PBX. | String |
| status | Indicates the user’s status at the time of the query. | String |
$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;
{
"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": ""
}
]
}
]
}
Sao Paulo +55 (11) 521 75 933
Santiago de Chile +56 (2) 240 533 89
Medellín +57 (604) 322 98 80
Ciudad de Guatemala +502 (2) 3141344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326
Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia