---
title: "Create IVRMenu"
method: POST
path: "/ivrmenu"
tags: ["IVRMenus", "ivrmenus"]
---

# Create IVRMenu

`POST /ivrmenu`

## Request

- Base URL: `https://api.fonestorm.com/v2`
- URL: `https://api.fonestorm.com/v2/ivrmenu`
- Auth: API key in header `token`

Add a new IVRMenu to an account.

## Request body

- object
  - `label` string, required: Human-readable label used for ivrmenu.
  - `options` object, required
    - `option0` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 0 Destination Type
      - `destination` string: Option 0 Destination
    - `option1` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 1 Destination Type
      - `destination` string: Option 1 Destination
    - `option2` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 2 Destination Type
      - `destination` string: Option 2 Destination
    - `option3` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 0 Destination Type
      - `destination` string: Option 0 Destination
    - `option4` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 4 Destination Type
      - `destination` string: Option 4 Destination
    - `option5` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 5 Destination Type
      - `destination` string: Option 5 Destination
    - `option6` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 6 Destination Type
      - `destination` string: Option 6 Destination
    - `option7` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 7 Destination Type
      - `destination` string: Option 7 Destination
    - `option8` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 8 Destination Type
      - `destination` string: Option 8 Destination
    - `option9` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option 9 Destination Type
      - `destination` string: Option 9 Destination
    - `optionStar` object
      - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Option Star Destination Type
      - `destination` string: Option Star Destination
  - `digit_timeout` string: Digit timeout.
  - `menu_repeat` string: Menu repeat.
  - `menu_timeout` string: Menu timeout.
  - `menu_timeout_options` object
    - `destination_type` 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector', required: Menu Timeout Destination Type
    - `destination` string: Menu Timeout Destination
  - `enable_speed_dials` boolean: Enable speed dials on IVRMenu.
  - `soundfile` string: SoundFile ID or Text to speech.

## Response `201`

Created

- object
  - `ivrmenu` IVRMenu
    - `id` string: Unique identifier for ivrmenu.
    - `label` string: Human-readable label used for ivrmenu.
    - `options` object
      - `option0` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 0 Destination Type
        - `destination` string: Option 0 Destination
      - `option1` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 1 Destination Type
        - `destination` string: Option 1 Destination
      - `option2` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 2 Destination Type
        - `destination` string: Option 2 Destination
      - `option3` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 0 Destination Type
        - `destination` string: Option 0 Destination
      - `option4` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 4 Destination Type
        - `destination` string: Option 4 Destination
      - `option5` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 5 Destination Type
        - `destination` string: Option 5 Destination
      - `option6` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 6 Destination Type
        - `destination` string: Option 6 Destination
      - `option7` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 7 Destination Type
        - `destination` string: Option 7 Destination
      - `option8` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 8 Destination Type
        - `destination` string: Option 8 Destination
      - `option9` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option 9 Destination Type
        - `destination` string: Option 9 Destination
      - `optionStar` object
        - `destination_type` 'Invalid' | 'Ignore' | 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Option Star Destination Type
        - `destination` string: Option Star Destination
    - `digit_timeout` integer: Digit timeout.
    - `menu_repeat` integer: Menu repeat.
    - `menu_timeout` integer: Menu timeout.
    - `menu_timeout_options` object
      - `destination_type` 'Hangup' | 'Busy' | 'Reject' | 'Forward' | 'SpeedDial' | 'Announcement' | 'Conference' | 'Device' | 'DigitQuery' | 'IVRMenu' | 'RingGroup' | 'Scheduler' | 'Voicemail' | 'Directory' | 'PageGroup' | 'RingAllPhones' | 'SIPURI' | 'Queue' | 'WebHook' | 'WebRequest' | 'FoneStormConnector': Menu Timeout Destination Type
      - `destination` string: Menu Timeout Destination
    - `enable_speed_dials` boolean: Enable speed dials on IVRMenu.
    - `soundfile` string: SoundFile ID or Text to speech.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `default`: Error

---

[API](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail.md) · [All operations](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/llms.txt) · [OpenAPI document](https://skmtc.dev/fonestorm/apis/fractel-api-2-12-87c-hail/revisions/9738d9b806d4?raw)