---
title: "Get IVR Menu"
method: GET
path: "/restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}"
tags: ["IVR"]
---

# Get IVR Menu

`GET /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}`

Returns a company IVR menu by ID.

## Path parameters

- `accountId` string, required
- `ivrMenuId` string, required

## Response `200`

OK

- IVRMenuInfo
  - `id` string — Internal identifier of an IVR Menu extension
  - `uri` string, uri — Link to an IVR Menu extension resource
  - `name` string — First name of an IVR Menu user
  - `extensionNumber` string — Number of an IVR Menu extension
  - `site` IvrMenuSiteInfo — Site data
    - `id` string — Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used
    - `name` string — Site name
  - `prompt` IvrMenuPromptInfo — Prompt metadata
    - `mode` 'Audio' | 'TextToSpeech' — Prompt mode: custom media or text
    - `audio` AudioPromptInfo — For 'Audio' mode only. Prompt media reference
      - `uri` string, uri — Link to a prompt audio file
      - `id` string — Internal identifier of a prompt
    - `text` string — For 'TextToSpeech' mode only. Prompt text
    - `language` PromptLanguageInfo — For 'TextToSpeech' mode only. Prompt language metadata
      - `uri` string, uri — Link to a prompt language
      - `id` string — Internal identifier of a language
      - `name` string — Language name
      - `localeCode` string — Language locale code
  - `actions` IVRMenuActionsInfo[] — Keys handling settings
    - `input` string — Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput
    - `action` 'Connect' | 'Voicemail' | 'DialByName' | 'Transfer' | 'Repeat' | 'ReturnToRoot' | 'ReturnToPrevious' | 'Disconnect' | 'ReturnToTopLevelMenu' | 'DoNothing' | 'ConnectToOperator' — Internal identifier of an answering rule
    - `extension` IVRMenuExtensionInfo — For 'Connect' or 'Voicemail' actions only. Extension reference
      - `uri` string, uri — Link to an extension resource
      - `id` string — Internal identifier of an extension
      - `name` string — Name of an extension
    - `phoneNumber` string — For 'Transfer' action only. PSTN number in E.164 format

## Other responses

- `404` — General response with **HTTP 404 "Not found"** status.<br> Reasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible
- `500` — General response with **HTTP 500 "Internal Server Error"** status.<br> Reasons: general server-side error.
- `503` — General response with **HTTP 503 "Service not available"** status.<br> Reasons: server cannot process the request because of being overloaded, misconfiguration or other issues.

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/versions/8d602198ec97/schema)