Skip to main content

Queue Access - Get queue list

Get queue list

Interface Description:

Get the list of task groups owned by the current user。

request parameters

parameter name type Is it necessary illustrate
service string yes App.Sip_Queue.GetQueueList
token string yes The token obtained through the authorization interface
queuename string no Task group name, if not passed, get all task groups

Interface request example(PHP)

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Queue.GetQueueList',
        'token'     => 'ABCDEFG',
        'queuename'     => 'ABCDEFG'
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

return data structure example

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "get success",
        "result": [
            {
                "queuename":"autocall_test-1101",
                "remark":"test-1101-edit",
                "strategy":8,
                "announce":"announce.wav",
                "announcefreq":1,
                "ringdelay":1,
                "maxwaittime":1,
                "withnoagenttime":1,
                "noagentrejoiningtime":1,
                "discardtime":1,
                "autocall":"busy"
            }
        ],
        "reqtime": 1581419353,
        "rsptime": 1581419353
    },
    "msg": ""
}

Return parameter description

parameter name type illustrate
result array returned result array
—queuename string task group name
—remark string task group ID
—strategy string Ring strategy 1, longest idle time ring 2, shortest call time ring 3, simultaneous ring 4, round robin ring 5, sequential ring 6, random ring 7, least answer ring 8, priority ring bell
—announce string announcement voice
—announcefreq string Notification frequency (unit: second)
—ringdelay string Ringing delay (unit: second)
—maxwaittime string maximum waiting time
—withnoagenttime string No seat waiting timeout
—noagentrejoiningtime string Call re-entering task group time when there are no agents
—discardtime string Maximum discard time
—autocall string Predicted outbound call status busy: indicates busy, idle: indicates idle, unavailable: predicts outbound call is unavailable