Menus

List all IVR Menus

The following method allows you to retrieve a list of all IVR menus in your unit.

URL

/api/v2/menus/list

Supported Parameters

There are no supported parameters for this method.

Example JSON

{
    "status":"success"
    "time":0.05,
    "flags":{},
    "data":
    [
        {
            "id":262,
            "name":"Main Menu",
            "created_at":"2015-05-06T13:53:29.000Z",
            "updated_at":"2015-10-05T14:10:16.000Z",
            "extension_access":true,
            "background_file":
                {
                    "id":2293,
                    "name":"Hold Music - July 2015",
                    "category":"ivr"
                },
            "items":
                {
                    "name":"Main",
                    "destination":
                        {
                            "type":"CallGroup",
                            "object":
                                {
                                    "id":862,
                                    "name":"Call Group #1",
                                    "extension_ids":[2902],
                                    "contact_ids":[]
                                }
                        }
                }
        }
    ]
}

IVR Menu properties

This method allows you to retrieve information about a specific IVR menu in your unit.

URL

/api/v2/menus/info

Supported Parameters

• id - the ID of the menu you wish to view (required)

Example JSON

{
    "status":"success"
    "time":0.05,
    "flags":{},
    "data":
        {
            "id":262,
            "name":"Main Menu",
            "created_at":"2015-05-06T13:53:29.000Z",
            "updated_at":"2015-10-05T14:10:16.000Z",
            "extension_access":true,
            "background_file":
                {
                    "id":2293,
                    "name":"Hold Music - July 2015",
                    "category":"ivr"
                },
            "items":
                {
                    "name":"Main",
                    "destination":
                        {
                            "type":"CallGroup",
                            "object":
                                {
                                    "id":862,
                                    "name":"Call Group #1",
                                    "extension_ids":[2902],
                                    "contact_ids":[]
                                }
                        }
                }
        }
}