Create IVRMenu

Add a new IVRMenu to an account.

Notes

label

Name/Label for the IVRMenu.

options

An object with options 0 to 9 and * settings. Settings for all options:

  • destination_type - Destination type for the option.
  • destination - Destination ID for the option.

digit_timeout

Digit timeout in seconds. IVRMenu will wait for an input for seconds mentioned in here. After that IVRMenu will execute failover option.

menu_repeat

IVRMenu will repeat the number of time mentioned in this option.

menu_timeout

IVRMenu timeout in seconds. IVRMenu will timeout after seconds mentioned here. After that IVRMenu will execute failover option.

menu_timeout_options

An object with the following options:

  • destination_type - Destination type for the option.
  • destination - Destination ID for the option.

enable_speed_dials

Enable speed dials or not. If this option is enabled, IVRMenu will accept speed dials as an input.

soundfile

SoundFile ID or Text to speech. SoundFile or text to be played in the IVRMenu.

Sample Response

{
    "ivrmenu": {
        "id": "IVR3792462920",
        "label": "Test IVR",
        "options": {
            "option0": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "option1": {
                "destination": "Invalid",
                "destination_type": "Hangup"
            },
            "option2": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "option3": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "option4": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "option5": {
                "destination": "Invalid",
                "destination_type": "Hangup"
            },
            "option6": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "option7": {
                "destination": "8559633307",
                "destination_type": "FoneNumber"
            },
            "option8": {
                "destination": "1004",
                "destination_type": "SpeedDial"
            },
            "option9": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            },
            "optionStar": {
                "destination": "Invalid",
                "destination_type": "Invalid"
            }
        },
        "digit_timeout": "0.5",
        "menu_repeat": "3",
        "menu_timeout": "8",
        "menu_timeout_options": {
            "destination": "1004",
            "destination_type": "SpeedDial"
        },
        "enable_speed_dials": true,
        "soundfile": ""
    }
}

Response Properties

PropertyTypeDescription
IVRMenuobjectIVRMenu
Language
Authentication
Header
Click Try It! to start a request and see the response here!