API - Queues Stats¶
API Queues Stats se foloseste pentru a extrage statistici despre cozile din centrala
API URL¶
https://[YOUR-PBX-URL]/api/queues
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => stats
[data] => Array
(
[queue_status] => true
)
[filters] => Array
(
[queues] => Array
(
[0] => demo-queue
[1] => sales-queue
)
[date_between] => Array
(
[0] => 2023-01-01 00:00:00
[1] => 2023-01-01 23:59:59
)
)
[api_hash] => 07112231a9c89f5b108af08608a97b07
)
Parametrul action trebuie sa aiba valoarea stats.
Parametrul queue_status din data trebuie sa fie true pentru a primi statisticile (altfel results este gol). Statisticile sunt calculate din apelurile intrate in cozi (pozitia in coada, timp de asteptare, timp de sunat, durata convorbirii).
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Filtre:¶
- queues: numele cozilor (array sau o singura coada ca text); fara filtru, toate cozile
- date_between: array(de la, pana la). Format: Y-m-d H:i:s (ex: 2023-01-01 00:00:00); se aplica doar daca are exact 2 valori. Fara filtru, toata perioada
Orice alt filtru (ex: project_id) intoarce eroarea Invalid filter: ...
Exemplu generare parametri:
$params = array(
'action' => 'stats',
'data' => array(
'queue_status' => true
),
'filters' => array(
'queues' => array('demo-queue', 'sales-queue'),
'date_between' => array('2023-01-01 00:00:00', '2023-01-01 23:59:59'), // array(from, to)
)
);
Exemplu generare hash:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
Exemplu trimitere date:
$url = 'https://[YOUR-PBX-URL]/api/queues';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));
Date trimise JSON¶
{
"action": "stats",
"data": {
"queue_status": true
},
"filters": {
"queues": [
"demo-queue",
"sales-queue"
],
"date_between": [
"2023-01-01 00:00:00",
"2023-01-01 23:59:59"
]
},
"api_hash": "27a081a1267f30fe7261c99f6a50b9ca"
}
Raspuns¶
In caz de succes (avg = medie pe apel, sum = total; timpii sunt in secunde):
{
"has_error": false,
"messages": [ ],
"results": {
"queue_status": {
"avg_position": "1.0055",
"avg_original_position": "0.9746",
"avg_hold_time": "14.4917",
"sum_hold_time": "26201",
"avg_ring_time": "7.0902",
"sum_ring_time": "12819",
"avg_call_duration": "174.9082",
"sum_call_duration": "316234"
}
}
}
Sau in caz de eroare:
{
"has_error": true,
"messages": [
"Invalid filter: project_id"
],
"results": [ ]
}
Disponibil si in alte limbi: EN