API - Tools¶
API Tools se foloseste pentru diverse actiuni in centrala: restart, oprirea unor procese, rularea unui task. Parametrul action este obligatoriu.
Datele se transmit prin POST sau GET¶
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Exemplu generare hash si trimitere date:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
$url = 'https://[YOUR-PBX-URL]/api/tools';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));
API URL¶
https://[YOUR-PBX-URL]/api/tools
Restart / Abort PBX¶
Parametrul action poate avea valorile:- restart_now: restart imediat, apelurile in curs sunt inchise
- restart_gracefully: nu mai accepta apeluri noi si face restart dupa ce se termina cele in curs
- restart_when_convenient: restart cand nu mai sunt apeluri in curs (apelurile noi sunt acceptate in continuare)
- abort_shutdown: anuleaza un restart programat
Raspuns: Asterisk restart command executed successfully sau eroarea Unable to execute Asterisk restart command / Manager error: ...
Array
(
[action] => restart_now
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Kill process¶
Parametrul action trebuie sa aiba valoarea kill, iar process din data poate fi: push-server.php, events-watcher.php sau events-watcher-push.php.
Raspuns: Process successfully killed sau una din erorile Invalid process, No matching process, Could not get process list, Could not kill process
Array
(
[action] => kill
[data] => Array
(
[process] => push-server.php
)
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Execute task¶
Parametrul action trebuie sa aiba valoarea execute_task, iar task_id din data este ID-ul task-ului (din Setari - Task-uri). Task-ul este rulat imediat, fara sa se modifice urmatoarea rulare programata.
Raspuns: Executed successfully! sau una din erorile Invalid task (task_id lipsa), Invalid ID (task inexistent), Task already running, Task exec error: ...
Array
(
[action] => execute_task
[data] => Array
(
[task_id] => 1
)
[api_hash] => 0f25e797e72d0dbba96d2c571a7bd6ba
)
Raspuns¶
In caz de succes:
{
"has_error": false,
"messages": [ ],
"results": [
"Executed successfully!"
]
}
Sau in caz de eroare (Request action is missing, Invalid action: ... sau erorile de mai sus):
{
"has_error": true,
"messages": [
"Invalid process"
],
"results": [ ]
}
Disponibil si in alte limbi: EN