API - Inbound Routes Read¶
API Inbound Routes se foloseste pentru a citi rutele Inbound active din centrala (numerele de intrare si destinatia lor).
API URL¶
https://[YOUR-PBX-URL]/api/inbound-routes
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => read
[page] => 1
[filters] => Array
(
[project_id] =>
[search] =>
)
[api_hash] => 07112231a9c89f5b108af08608a97b07
)
Parametrul action trebuie sa aiba valoarea read (implicit). Parametrul page este implicit 1 si se incrementeaza pana la pagination.max_page (o pagina mai mare decat max_page intoarce tot ultima pagina). Rutele se intorc cate 100 pe pagina, ordonate dupa numere.
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 rutele fara proiect
- search: Cautare dupa numar, comentarii, destinatie, descriere
Orice alt filtru intoarce eroarea Invalid filter: ...
Exemplu generare parametri:
$params = array(
'action' => 'read',
'page' => 1,
'filters' => array(
'project_id' => null,
'search' => null,
)
);
Exemplu generare hash:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
Exemplu trimitere date:
$url = 'https://[YOUR-PBX-URL]/api/inbound-routes';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));
Date trimise JSON¶
{
"action": "read",
"page": 1,
"filters": {
"project_id": null,
"search": null
},
"api_hash": "de1b56d49bf027503ef3ecee05b9c59d"
}
Raspuns¶
In caz de succes:
{
"has_error": false,
"messages": [ ],
"pagination": {
"row_count": 1,
"page_size": 100,
"current_page": 1,
"max_page": 1,
"first_displayed_page": 1,
"last_displayed_page": 1
},
"results": [
{
"id": 2,
"type": "queue",
"destination": "sales",
"trunk_id": null,
"outbound_number": "0212345000",
"description": "Vanzari",
"project_id": 1,
"variables": "SKIP_WELCOME=1",
"comments": null,
"status": "active",
"numbers": [
"0212345000",
"0212345001"
],
"project_name": "Test project",
"project_alias": "test-project",
"trunk_name": null,
"schedule_cnt": 7,
"variables_arr": {
"SKIP_WELCOME": "1"
},
"destination_id": 3,
"destination_link": "/pbx/queues?edit=3"
}
]
}
Sau in caz de eroare:
{
"has_error": true,
"messages": [
"Invalid filter: xxx"
],
"results": [ ]
}
Disponibil si in alte limbi: EN