Project

General

Profile

API - Users status

API Users status se foloseste pentru a monitoriza statusul userilor din centrala (inregistrare telefon, apeluri in curs, pauza).

API URL

https://[YOUR-PBX-URL]/api/users-status

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

Array
(
    [type] => sip
    [get_stats] => false
    [api_hash] => bb76587c4cc53d74fecbb189dd5dbbb8
)

Parametrul type este obligatoriu si trebuie sa aiba valoarea sip.

Parametrul get_stats este optional: daca este true, raspunsul contine si outbound_calls (numarul de apeluri iesite azi, in programul de lucru), last_status, last_status_time si last_status_diff (ultimul status de azi al userului: OK, offline, paused sau no_schedule, si de cat timp il are). In JSON trimiteti true / false; in form-data trimiteti 1 / 0 (orice valoare nevida, inclusiv textul "false", activeaza statisticile).

Headere HTTP:

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

Exemplu generare hash:

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

Exemplu trimitere date:

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

Raspuns

In caz de succes (cu get_stats = true):

Rezultatele au ca cheie username-ul. Apar toti userii configurati in centrala; id, extension, remote_id si pause_info apar doar pentru userii activi din aplicatie. registrar contine telefoanele inregistrate pe user (pot fi mai multe), iar pause_info pauza activa (gol daca userul nu este in pauza).

{
    "has_error": false,
    "messages": [ ],
    "results": {
        "john-doe": {
            "username": "john-doe",
            "dnid": "0212345000",
            "status": "OK",
            "in_use": 1,
            "limit": 3,
            "status_info": "In use",
            "registrar": [
                {
                    "uri": "sip:john-doe@203.0.113.10:5060;x-ast-orig-host=192.168.1.20:5060",
                    "ip": "203.0.113.10",
                    "port": "5060",
                    "info": "x-ast-orig-host=192.168.1.20:5060",
                    "useragent": "Yealink SIP-T46U 108.86.0.20",
                    "key": "@4f6c1d0a9b8e7f6a5b4c3d2e1f0a9b8c",
                    "status_info": "Avail (12.5 ms)" 
                }
            ],
            "outbound_calls": 14,
            "last_status": "paused",
            "last_status_time": "2024-03-14 09:12:31",
            "last_status_diff": "02:15:40",
            "id": "12",
            "extension": "101",
            "remote_id": null,
            "pause_info": {
                "id": "5310",
                "user_id": "12",
                "pause_start": "2024-03-14 11:20:05",
                "pause_time": "15",
                "reason": "Pauza masa",
                "paused_by": null
            }
        }
    }
}

Sau in caz de eroare (Invalid type: ... sau Manager error: ... daca centrala nu raspunde):

{

    "has_error": true,
    "messages": [
        "Invalid type: sipx" 
    ],
    "results": [ ]

}

Disponibil si in alte limbi: EN