Presets

List all presets

This method allows you to retrieve a full list of all presets in your unit.

URL

/api/v2/presets/list

Supported Parameters

There are no supported parameters for this method.

Example JSON

{
    "status": "success",
    "time": 0.02,
    "flags": {
        "paginated": {
            "page": null,
            "per_page": 30,
            "total_pages": 1,
            "total_records": 1
        }
    },
    "data": [
        {
            "id": 1,
            "name": "Main Number",
            "status": "disabled",
            "numbers": {
                "03031237300": {
                    "destination": {
                        "type": "CallGroup",
                        "object": {
                            "id": 61,
                            "name": "Call Group for 03031237300",
                            "extension_ids": [],
                            "contact_ids": []
                        }
                    }
                }
            },
            "created_at": "2015-10-06T09:10:06.000Z",
            "updated_at": "2015-10-06T09:10:06.000Z"
        }
    ]
}

Get preset properties

This method allows you to retrieve information relating to a preset in your unit.

URL

/api/v2/presets/info

Supported Parameters

• id - the ID of the preset (required)

Example JSON

{
    "status": "success",
    "time": 0.02,
    "flags": {
        "paginated": {
            "page": null,
            "per_page": 30,
            "total_pages": 1,
            "total_records": 1
        }
    },
    "data": [
        {
            "id": 1,
            "name": "Main Number",
            "status": "disabled",
            "numbers": {
                "03031237300": {
                    "destination": {
                        "type": "CallGroup",
                        "object": {
                            "id": 61,
                            "name": "Call Group for 03031237300",
                            "extension_ids": [],
                            "contact_ids": []
                        }
                    }
                }
            },
            "created_at": "2015-10-06T09:10:06.000Z",
            "updated_at": "2015-10-06T09:10:06.000Z"
        }
    ]
}

Activate a preset

This method allows you to activate a preset in your unit.

URL

/api/v2/presets/activate

Supported Parameters

• id - the ID of the preset (required)

Example JSON

{
    "status": "success",
    "time": 1.32,
    "flags": {},
    "data": true
}

Deactivate a preset

This method allows you to deactivate a preset in your unit.

URL

/api/v2/presets/deactivate

Supported Parameters

• id - the ID of the preset (required)

Example JSON

{
    "status": "success",
    "time": 1.24,
    "flags": {},
    "data": true
}