Skip to main content

Predictive outbound - Get extension status interface

Get extension status interface

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.GetQueueSipStatus
token string yes The token obtained through the authorization interface
queuename string no Task group name, get all if empty
extnumber string no Extension number, if empty get all
state int no Agent status: 0, unlimited 1, idle 2, waiting 3, receiving 4, talking

Interface request example(PHP)

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Queue.GetQueueSipStatus',
        'token'     => 'ABCDEFG',
        'queuename'     => 'queue-1',
        'extnumber'     => '100001',
        'state'     =>0,
    ];
    $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": "queue-1",
                "seatsname": "9026004_9026004_autocall-9026",
                "extnumber": "100001",
                "status": 1213,
                "state": 1213,
                "lastanswertime": "2020-02-05 21:03:36",
                "lastassigntime": "2020-02-05 21:03:34",
                "seatschangetime": "2020-02-05 21:03:29",
                "noanswercount": 0,
                "callsanswered": 1,
                "externalcallscount": 0,
                "wrapuptime": 0,
                "maxnoanswer": 0
            }
        ],
        "reqtime": 1581488746,
        "rsptime": 1581488746
    },
    "msg": ""
}

Return parameter description

parameter name type illustrate
result array returned result array
—queuename string task group name
—seatsname string Agent name
—extnumber string Ext
—extnumber string Ext
—status int Extension Status
—state int Agent status
—lastanswertime string last answer time
—lastassigntime string Last allocation time
—seatschangetime string Agent change time
—noanswercount int Missed call statistics
—callsanswered int Answer Statistics
—externalcallscount string Number of external calls, non-predictive task call statistics, can be ignored
—wrapuptime string Call finishing time, that is, the interval between answering a call and dialing a new number
—maxnoanswer string The maximum number of no responses, temporarily invalid, can be ignored