Project

General

Profile

API - Queues Save

API Queues Save se foloseste pentru a actualiza membrii cozilor din centrala.

API URL

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

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

Array
(
    [action] => save
    [data] => Array
        (
            [demo-queue] => Array
                (
                    [members] => Array
                        (
                            [john-doe] => Array
                                (
                                    [type] => sip
                                    [penalty] => 0
                                    [order] => 0
                                    [is_active] => 1
                                )

                            [jane-doe] => Array
                                (
                                    [type] => fallback
                                    [penalty] => 0
                                    [order] => 0
                                    [is_active] => 1
                                )

                            [+40123456789] => Array
                                (
                                    [type] => remote
                                    [penalty] => 0
                                    [order] => 0
                                    [is_active] => 1
                                )

                        )

                )

        )

    [api_hash] => 07112231a9c89f5b108af08608a97b07
)

Parametrul action trebuie sa aiba valoarea save (implicit). In data cheia este numele cozii, iar in members cheia este membrul: username-ul pentru tipurile sip si fallback, numarul de telefon pentru remote.

Parametri membru:
  • type: obligatoriu, sip (telefonul userului), fallback (numarul de fallback al userului) sau remote (numar extern)
  • is_active: obligatoriu; 1 = membru in coada, 0 = scos din coada
  • penalty: optional, implicit 0
  • order: optional, implicit 0
  • name: optional; pentru useri se ia implicit numele userului

ATENTIE: lista trimisa inlocuieste membrii cozii. Orice membru existent care nu este trimis, este trimis cu is_active = 0 sau are date invalide este sters din coada. Daca lista members este goala, sunt stersi toti membrii.

Dupa salvare, configurarea cozilor este regenerata si reincarcata in centrala.

Headere HTTP:

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

Exemplu generare parametri:

$params = array(
    'action' => 'save',
    'data' => array(
        'demo-queue' => array(
            'members' => array(
                'john-doe' => array(
                    'type' => 'sip',
                    'penalty' => 0,
                    'order' => 0,
                    'is_active' => 1
                ),
                'jane-doe' => array(
                    'type' => 'fallback',
                    'penalty' => 0,
                    'order' => 0,
                    'is_active' => 1
                ),
                '+40123456789' => array(
                    'type' => 'remote',
                    'penalty' => 0,
                    'order' => 0,
                    'is_active' => 1
                )
            )
        )
    )
);

Exemplu generare hash:

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

Exemplu trimitere date:

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

Date trimise JSON

{
  "action": "save",
  "data": {
    "demo-queue": {
      "members": {
        "john-doe": {
          "type": "sip",
          "penalty": 0,
          "order": 0,
          "is_active": 1
        },
        "jane-doe": {
          "type": "fallback",
          "penalty": 0,
          "order": 0,
          "is_active": 1
        },
        "+40123456789": {
          "type": "remote",
          "penalty": 0,
          "order": 0,
          "is_active": 1
        }
      }
    }
  },
  "api_hash": "d8f317d9c98cfa2b14e5049ca4b1af81" 
}

Raspuns

In caz de succes, results are ca cheie numele cozii si contine membrii salvati, cu ID-ul lor si ID-ul userului asociat (user_id este null pentru remote):

{
    "has_error": false,
    "messages": [ ],
    "results": {
        "demo-queue": {
            "john-doe": {
                "id": "151",
                "user_id": "12",
                "alias": "john-doe",
                "name": "John Doe",
                "type": "sip",
                "penalty": 0,
                "order": 0,
                "is_active": 1
            },
            "jane-doe": {
                "id": "152",
                "user_id": "14",
                "alias": "jane-doe",
                "name": "Jane Doe",
                "type": "fallback",
                "penalty": 0,
                "order": 0,
                "is_active": 1
            },
            "+40123456789": {
                "id": 153,
                "user_id": null,
                "alias": "+40123456789",
                "name": null,
                "type": "remote",
                "penalty": 0,
                "order": 0,
                "is_active": 1
            }
        }
    }
}

Daca se trimit mai multe cozi, fiecare este procesata separat: cozile valide sunt salvate chiar daca altele au erori.

Erori posibile: Request data array is missing, Members are missing from Queue ..., skipping update, Invalid Queue name: ..., Invalid parameters for user ..., Queue ... (lipseste is_active sau type invalid), Duplicate alias ... for member ..., You can't use same Queue extension (...) as a remote number, You can't use a Trunk identity (...) as a remote number.

Sau in caz de eroare:

{

    "has_error": true,
    "messages": [
        "Invalid Queue name: demo-queuex" 
    ],
    "results": [ ]

}

Disponibil si in alte limbi: EN