Call Groups

List all call groups

This method allows you to list all call groups created within your unit.

URL

/api/v2/call_groups/list

Supported Paramaters

There are no supported parameters for this method.

Example JSON

{
    "status":"success",
    "time":0.03,"flags":{},
    "data":
    [
        {
            "id":862,
            "name":"Group",
            "extension_ids":[2902],
            "contact_ids":[],
            "created_at":"2015-08-13T10:48:17.000Z",
            "updated_at":"2015-08-13T10:48:17.000Z",
            "noanswer_timeout":null,
            "paging_enabled":false,
            "pickup_group":
                {
                    "id":298,
                    "name":"Test"
                },
            "noanswer_destination":
                {
                    "type":"VoicemailBox",
                    "object":
                        {
                            "id":1375,
                            "number":"1000",
                            "name":"Alex"
                        }
                }
        }
    ]
}

Get call group properties

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

URL

/api/v2/call_groups/info

Supported Paramaters

• id - the ID of the call group (required)

Example JSON

{
    "status":"success",
    "time":0.03,"flags":{},
    "data":
        {
            "id":862,
            "name":"Group",
            "extension_ids":[2902],
            "contact_ids":[],
            "created_at":"2015-08-13T10:48:17.000Z",
            "updated_at":"2015-08-13T10:48:17.000Z",
            "noanswer_timeout":null,
            "paging_enabled":false,
            "pickup_group":
                {
                    "id":298,
                    "name":"Test"
                },
            "noanswer_destination":
                {
                    "type":"VoicemailBox",
                    "object":
                        {
                            "id":1375,
                            "number":"1000",
                            "name":"Alex"
                        }
                }
        }
}

Add or update a call group

This method allows you to add or update a call group in your unit.

URL

/api/v2/call_groups/save

Supported Parameters

• id - The ID of the call group (required if you're updating an existing call group)
• name - The name of the call group (required)
• extension_ids - The IDs of extensions that you wish to assign to the group
• contact_ids - The IDs of contacts that you wish to assign to the group
• noanswer_destination_id - The ID of the no answer destination
• noanswer_destination_type - The type of no answer destination, for example VoicemailBox
• paging_enabled - Whether or not paging is enabled
• pickup_group_id - The ID of a pickup group you wish to associate with the call group

Example JSON

```json { "status":"success", "time":0.08, "flags":{}, "data": { "id":862, "name":"Call Group #1", "extension_ids":[2902], "contact_ids":[] } }