Function Params

List all parameters or required parameters for a function¶

Role: Guest and above.

The same information, with descriptions and platform support, is on the Test Functions pages.

Parameters

Name	Description
function	Only return the parameters of this function, for example `CALL_HOLD`. Type: string (query)

Responses

Code Description

200

The parameters of every function (or of one), keyed by function name. type is ENUM, TEXT or FOREIGN (a reference to another item, named in foreignTable); values lists the allowed values of an ENUM; required applies to this function. defaultValue is what applies when an optional parameter is left out.

Media type: application/json

Example Value:

{
"params": {
    "CALL_HOLD": [
        {
            "name": "STATUS",
            "type": "ENUM",
            "values": [
                "ON",
                "OFF"
            ],
            "description": "Enable or disable setting",
            "defaultValue": "OFF",
            "foreignTable": "",
            "required": true
        }
    ]
}
}

404

Resource was not found.