API - Queues Read¶
API Queues Read se foloseste pentru a citi cozile din centrala, cu membrii si statisticile lor in timp real.
API URL¶
https://[YOUR-PBX-URL]/api/queues
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => read
[data] => Array
(
[get_info] => false
[get_db_reports] => false
)
[filters] => Array
(
[project_id] =>
[queues] => Array
(
[0] => demo-queue
[1] => sales-queue
)
)
[api_hash] => 07112231a9c89f5b108af08608a97b07
)
Parametrul action trebuie sa aiba valoarea read.
Optiuni in data (optionale, implicit false):- get_info: adauga in stats membrii cu statusul lor din centrala (members, inclusiv pauza activa), apelantii in asteptare (callers), available_members, paused_members, available_slots si setarile cozii (vars)
- get_db_reports: statisticile de azi (apeluri preluate / nepreluate, timp de asteptare / convorbire, apeluri transferate preluate, apelanti recuperati) se calculeaza din baza de date, nu din contoarele centralei (care se reseteaza la restart sau la Reset stats)
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Filtre:¶
- project_id: ID proiect in centrala sau array de ID-uri; -1 in lista include si cozile fara proiect
- queues: numele cozilor (array sau o singura coada ca text)
Orice alt filtru intoarce eroarea Invalid filter: ... Daca nu se gaseste nicio coada, eroarea este No Queues found.
Exemplu generare parametri:
$params = array(
'action' => 'read',
'data' => array(
'get_info' => false,
'get_db_reports' => false
),
'filters' => array(
'project_id' => null,
'queues' => array('demo-queue', 'sales-queue')
)
);
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": "read",
"data": {
"get_info": false,
"get_db_reports": false
},
"filters": {
"project_id": null,
"queues": [
"demo-queue",
"sales-queue"
]
},
"api_hash": "de1b56d49bf027503ef3ecee05b9c59d"
}
Raspuns¶
In caz de succes, results are ca cheie ID-ul cozii. members contine membrii configurati in aplicatie, iar stats statisticile din centrala (exemplu cu get_info = true; campurile vars si info_block sunt prescurtate):
{
"has_error": false,
"messages": [ ],
"results": {
"3": {
"id": 3,
"name": "sales-queue",
"extension": 501,
"project_id": 1,
"user_id": null,
"service_level": 60,
"critical_service_level": 30,
"outbound_number": null,
"reset_stats": null,
"vars": {
"maxlen": "15",
"strategy": "linear",
"timeout": "30"
},
"status": "active",
"project_name": "Test project",
"members_cnt": 2,
"max_penalty": 1,
"members": {
"john-doe": {
"id": 151,
"queue_id": 3,
"type": "sip",
"name": "John Doe",
"alias": "john-doe",
"user_id": 12,
"penalty": 0,
"order": 0,
"fallback_number": null,
"user_type": "sip",
"is_active": 1
}
},
"stats": {
"queue_name": "sales-queue",
"calls_no": "1",
"calls_max": "15",
"strategy": "linear",
"hold_time": "4",
"talk_time": "161",
"weight": "0",
"calls_answered": "3",
"calls_unanswered": "0",
"service_level": "100.0",
"service_level2": "100.0",
"service_time_period": "60",
"available_members": 1,
"paused_members": 0,
"available_slots": 14,
"callers": [ ],
"members": {
"john-doe": {
"type": "PJSIP",
"username": "john-doe",
"penalty": "",
"status": "Not in use",
"cnt_calls": "3",
"cnt_call_seconds": "1325",
"cnt_login_seconds": "16853",
"name": "John Doe",
"pause": [ ]
}
},
"info_block": "..."
}
}
}
}
Sau in caz de eroare:
{
"has_error": true,
"messages": [
"No Queues found"
],
"results": [ ]
}
Disponibil si in alte limbi: EN