API - Queues Pause¶
API Queues Pause se foloseste pentru a pauza sau a dezactiva pauza agentilor din cozi
API URL¶
https://[YOUR-PBX-URL]/api/queues
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => pause
[data] => Array
(
[0] => Array
(
[agent_name] => john-doe
[reason] => other
[paused] => 1
)
)
[api_hash] => 07112231a9c89f5b108af08608a97b07
)
Parametrul action trebuie sa aiba valoarea pause. In data se trimite o lista de agenti; fiecare rand are parametrii obligatorii:
- agent_name: username-ul agentului (membru in cel putin o coada)
- paused: 1 = pauza, 0 = scoatere din pauza
- reason: motivul pauzei (text)
Agentul este pus in pauza (sau scos din pauza) in toate cozile in care este membru. Fiecare rand este procesat separat: randurile valide sunt executate chiar daca altele au erori.
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Exemplu generare parametri:
$params = array(
'action' => 'pause',
'data' => array(
array(
'agent_name' => 'john-doe',
'reason' => 'other',
'paused' => 1 // pause = 1, unpause = 0
)
)
);
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": "pause",
"data": [
{
"agent_name": "john-doe",
"reason": "other",
"paused": 1
}
],
"api_hash": "fb8423e2fbbe6178501e956f643f2e12"
}
Raspuns¶
In caz de succes, results are ca cheie indexul randului din data. result este 1 daca pauza a fost pornita / oprita si 0 daca agentul era deja in starea ceruta:
{
"has_error": false,
"messages": [ ],
"results": [
{
"agent_name": "john-doe",
"user_id": "1234",
"result": 1
}
]
}
Sau in caz de eroare (Request data array is missing, Invalid data for row ... daca lipseste un parametru, Queue pause error for row ...: ... daca agentul nu este in nicio coada sau centrala nu a executat comanda):
{
"has_error": true,
"messages": [
"Queue pause error for row 1: No interfaces could be matched"
],
"results": [ ]
}
Disponibil si in alte limbi: EN