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 trasmit prin POST sau GET si trebuie sa fie de forma:¶

Array
(
    [action] => read
    [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 read.

Headere HTTP:¶

Content-Type: text/xml
Authorization: Bearer <token>

Filtre:¶

• project_id: ID proiect in centrala
• queues: numele cozilor

Exemplu generare parametri:

$params = array(
    'action' => 'info',
    '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(http_build_query($params) . 'your_api_key'); // make hash

Exemplu trimitere date:

$url = 'https://[YOUR-PBX-URL]/api/queues';
$token = 'your_api_token';
echo curlPost($url, http_build_query($params), array("Authorization: Bearer {$token}"));

Date trimise JSON¶

{
  "action": "info",
  "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:

{

    "has_error": false,
    "messages": [ ],
    "results": [ ]

}

Sau in caz de eroare:

{

    "has_error": true,
    "messages": [
        "No Queues found" 
    ],
    "results": [ ]

}

---

Disponibil si in alte limbi: EN