Skip to content

Call Queues

List all call queues

This method allows you to list all call queues in your unit.

URL

/api/v2/call_queues/list

Supported Parameters

There are no supported parameters for this method.

Example JSON

{
    "status":"success",
    "time":0.01,
    "flags":{},
    "data":
    [
        {
            "id":427,
            "name":"Call Queue 1",
            "maximum_size":20,
            "strategy":"ringall",
            "max_wait_time":300,
            "play_ringing":false,
            "created_at":"2015-10-07T13:00:23.000Z",
            "updated_at":"2015-10-07T13:00:23.000Z",
            "audio_file":null,
            "post_audio_file":null,
            "noanswer_destination":
                {
                    "type":"VoicemailBox",
                    "object":
                        {
                            "id":1375,
                            "number":"1000",
                            "name":"Alex"
                        }
                },
            "members":
            [
                {
                    "id":2902,
                    "name":"Alex",
                    "exten":"100"
                }
            ]
        }
    ]
}

Get call queue properties

This method allows you to retrieve information about a specific call queue in your unit.

URL

/api/v2/call_queues/info

Supported Parameters

  • id - The ID of the call queue (required)

Example JSON

{
    "status":"success",
    "time":0.01,
    "flags":{},
    "data":
        {
            "id":427,
            "name":"Call Queue 1",
            "maximum_size":20,
            "strategy":"ringall",
            "max_wait_time":300,
            "play_ringing":false,
            "created_at":"2015-10-07T13:00:23.000Z",
            "updated_at":"2015-10-07T13:00:23.000Z",
            "audio_file":null,
            "post_audio_file":null,
            "noanswer_destination":
                {
                    "type":"VoicemailBox",
                    "object":
                        {
                            "id":1375,
                            "number":"1000",
                            "name":"Alex"
                        }
                },
            "members":
            [
                {
                    "id":2902,
                    "name":"Alex",
                    "exten":"100"
                }
            ]
        }
}