API - CallQueue Read¶
API CallQueue / Read se foloseste pentru a citi lista de apeluri programate via CallQueue / Save sau automat de centrala (Ex: missed calls)
API URL¶
https://[YOUR-PBX-URL]/api/call-queue
Datele se transmit prin POST sau GET si trebuie sa fie de forma:¶
Array
(
[action] => read
[page] => 1
[filters] => Array
(
[date_between] => Array
(
[0] => 2024-01-01 00:00:00
[1] => 2024-01-15 23:59:59
)
[schedule_lt] =>
[schedule_null] => 1
[caller_id] =>
[inbound_route] =>
[project_id] =>
[outbound_type] =>
[attend_type] =>
[external_id] =>
[assign_type] =>
[campaign] =>
[status] => pending
)
[api_hash] => b0f5e7f8c9164ff49951b87740d9e015
)
Parametrul action trebuie sa aiba valoarea read. Parametrul page este implicit 1 si se incrementeaza pana la pagination.max_page (o pagina mai mare decat max_page intoarce tot ultima pagina). Apelurile se intorc cate 100 pe pagina.
Headere HTTP:¶
Content-Type: application/json Authorization: Bearer <token>
Filtre:¶
- date_between: array(de la, pana la) pentru data crearii apelului. Format: Y-m-d H:i:s (ex: 2017-02-16 00:00:00); se aplica doar daca are exact 2 valori
- schedule_lt: data programarii <= datei setate. Format: Y-m-d H:i:s (ex: 2017-02-16 00:00:00)
- schedule_null: daca schedule_lt este setat, include si apelurile fara data programata (implicit true)
- caller_id: numarul de telefon apelat (potrivire exacta, doar cifre si +)
- inbound_route: ID-ul rutei Inbound (Inbound route) asociate apelului
- outbound_number: numarul care este afisat catre destinatar
- project_id: ID proiect in centrala sau lista de ID-uri; -1 in lista include si apelurile fara proiect
- outbound_type: tipul de campanie (auto sau manual)
- attend_type: apelul se realizeaza cu sau fara un agent (attended, unattended)
- external_id: ID din baza de date externa (ex: activity ID)
- assign_type: destinatia catre care apelul a fost asignat: user, no_user, queue, no_queue, context, no_context
- campaign: numele sau informatiile campaniei (campaign_name / campaign_info), sau ID-uri de campanii CRM separate prin virgula
- status: statusul (pending, inprogress, completed, cancelled, deleted) sau lista de statusuri (-1 = toate). Fara acest filtru sunt intoarse toate apelurile, inclusiv cele sterse
Orice alt filtru intoarce eroarea Invalid filter.
Exemplu generare parametri:
$params = array(
'action' => 'read',
'page' => 1,
'filters' => array(
'date_between' => array('2024-01-01 00:00:00', '2024-01-15 23:59:59'), // array(from, to)
'schedule_lt' => null, // datetime
'schedule_null' => true, // show NULL schedule if schedule_lt is applied
'caller_id' => null,
'inbound_route' => null,
'project_id' => null,
'outbound_type' => null, // auto, manual
'attend_type' => null, // attended, unattended
'external_id' => null,
'assign_type' => null, // queue, no_queue, user
'campaign' => null, // name or info
'status' => 'pending', // array(pending, inprogress, completed, cancelled, deleted)
)
);
Exemplu generare hash:
$params['api_hash'] = md5(json_encode($params) . 'your_api_key'); // make hash
Exemplu trimitere date:
$url = 'https://[YOUR-PBX-URL]/api/call-queue';
$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": {
"date_between": [
"2024-01-01 00:00:00",
"2024-01-15 23:59:59"
],
"schedule_lt": null,
"schedule_null": true,
"caller_id": null,
"inbound_route": null,
"project_id": null,
"outbound_type": null,
"attend_type": null,
"external_id": null,
"assign_type": null,
"campaign": null,
"status": "pending"
},
"api_hash": "03f0ddb81fdcd0a5a3aec64b36766290"
}
Raspuns¶
In caz de succes:
{
"has_error": false,
"messages": [ ],
"pagination": {
"row_count": 1,
"page_size": 100,
"current_page": 1,
"max_page": 1
},
"results": [
{
"id": "79",
"caller_id": "0123456789",
"caller_id_name": "John Doe",
"project_id": "1",
"source": "api",
"campaign_name": "Test campaign",
"campaign_info": "Some special info",
"inbound_route_id": null,
"outbound_number": "+40212345678",
"context": null,
"created": "2026-11-05 10:00:00",
"priority": "0",
"schedule": "2026-11-05 12:00:00",
"assigned_operator": null,
"assigned_queue": "test-queue",
"outbound_trunk": "default-trunk",
"last_retry": null,
"retries_no": "0",
"max_retries": "5",
"outbound_type": "auto",
"attend_type": "attended",
"resolution": null,
"crm_campaign_id": null,
"external_id": "asdf1234",
"external_info": null,
"status": "pending",
"project_name": "While1",
"project_alias": "while1",
"inbound_route_name": null,
"campaign_status": null
}
]
}
Sau in caz de eroare:
{
"has_error": true,
"messages": [
"Invalid filter: statusxxx"
],
"pagination": [ ],
"results": [ ]
}
Disponibil si in alte limbi: EN