API - Queues Save¶

API Queues se foloseste pentru a citi 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] => 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. Pentru fiecare user parametrul is_active este obligatoriu.

ATENTIE: daca nu se trimite niciun user in lista, vor fi stersi toti.

Headere HTTP:¶

Content-Type: text/xml
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(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": "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:

{

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

}

Sau in caz de eroare:

{

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

}

---

Disponibil si in alte limbi: EN