Project

General

Profile

API - Reports

API Reports se foloseste pentru a extrage datele unui raport din centrala (raport standard sau raport custom definit in Rapoarte).

API URL

https://[YOUR-PBX-URL]/api/reports

Datele se transmit prin POST sau GET si trebuie sa fie de forma:

Array
(
    [page] => 1
    [data] => Array
        (
            [type] => custom
            [id] => 2
        )
    [filters] => Array
        (
            [date_between] => Array
                (
                    [0] => 2024-01-01 00:00:00
                    [1] => 2024-01-15 23:59:59
                )
        )

    [api_hash] => 07112231a9c89f5b108af08608a97b07
)
Parametrul data este obligatoriu si contine:
  • type: custom (raport salvat in Rapoarte, trebuie sa fie activ) sau standard (raport predefinit)
  • id: ID-ul raportului, numeric pentru custom, text pentru standard (ex: cdr_api - lista de apeluri cu toate detaliile)

Coloanele din results sunt cele definite in raport. La un raport custom asociat unui proiect se intorc doar datele proiectului respectiv.

Parametrul page este implicit 1 si se incrementeaza pana la pagination.max_page (o pagina mai mare decat max_page intoarce tot ultima pagina). Randurile se intorc cate 100 pe pagina.

Headere HTTP:

Content-Type: application/json
Authorization: Bearer <token>

Filtre:

  • date_between: array(de la, pana la). Format: Y-m-d H:i:s (ex: 2024-01-01 00:00:00). La rapoartele custom se aplica pe coloana de data aleasa in raport

Se pot trimite si celelalte filtre ale raportului; pentru rapoartele de apeluri (ex: cdr_api) sunt aceleasi ca in API CDR (ex: project_ids, direction, telephone, queue, from_id - apelurile cu ID mai mare sau egal, util pentru sincronizare incrementala).

Exemplu generare parametri:

$params = array(
    'page' => 1,
    'data' => array(
        'type' => 'custom', // standard
        'id' => 2 // cdr_api
    ),
    'filters' => array(
        'date_between' => array('2024-01-01 00:00:00', '2024-01-15 23:59:59'), // array(from, to)
    )
);

Exemplu generare hash:

$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash

Exemplu trimitere date:

$url = 'https://[YOUR-PBX-URL]/api/reports';
$token = 'your_api_token';
echo curlPost($url, json_encode($params), array("Authorization: Bearer {$token}", "Content-Type: application/json"));

Date trimise JSON

{
  "page": 1,
  "data": {
    "type": "custom",
    "id": 2
  },
  "filters": {
    "date_between": [
      "2024-01-01 00:00:00",
      "2024-01-15 23:59:59" 
    ]
  },
  "api_hash": "af4014d3db711e82cdcc74bb8c64fdc4" 
}

Raspuns

In caz de succes:

{

    "has_error": false,
    "messages": [ ],
    "pagination": {
        "row_count": 1,
        "page_size": 100,
        "current_page": 1,
        "max_page": 1
    },
    "results": [
        {
            "id": "29056",
            "uniqueid": "1710401324.480",
            "linkedid": "1710401324.480",
            "time": "2024-03-14 09:28:44",
            "time_end": "2024-03-14 09:31:02",
            "caller_id": "0712345678",
            "source": "0712345678",
            "destination": "0212345000",
            "direction": "IN",
            "user_username": "john-doe",
            "queue": "sales-queue",
            "call_status": "ANSWERED",
            "project": "Test project" 
        }
    ]

}

Sau in caz de eroare (Request data array is missing, Request data ID is missing / invalid, Request data Type is missing / invalid, Invalid report ID: ...):

{

    "has_error": true,
    "messages": [
        "Invalid report ID: 999" 
    ],
    "pagination": [ ],
    "results": [ ]

}

Disponibil si in alte limbi: EN