RingCentral icon

RingCentral

Interact with RingCentral API - SMS, Voice, Fax, Meetings, and more

IVR Menu → Get

AI-generated

Summary

Get details of a specific IVR menu by its ID.

Inputs

  • ivrMenuId (required) — The ID of the IVR menu to retrieve.
  • authMode — Authentication mode: use saved node credentials or pass a dynamic access token. Defaults to credentials when omitted.
  • accessToken — OAuth 2.0 access token (required when authMode is dynamic). Marked as password type in the UI.
  • serverUrl — RingCentral API environment (Production or Sandbox) used when authMode is dynamic. Defaults to Production.

Output shape

object

Returns the IVR menu object as defined by the RingCentral API, containing fields such as id, name, extensionId, greeting, prompt, and menu structure. Exact shape depends on the API response; refer to RingCentral's IVR Menu Get endpoint documentation for details.

Examples

Example 1: Retrieve an IVR menu using saved credentials

Set IVR Menu ID to the target menu's ID; leave Authentication Mode at its default (credentials).

Example 2: Retrieve an IVR menu using a dynamic token

Set Authentication Mode to Dynamic Access Token (Multi-Tenant), provide a valid Access Token, optionally select Server Environment, and supply the IVR Menu ID.

Links

Discussion