How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
RingCentral

RingCentral IVR API

The IVR API from RingCentral — 5 operation(s) for ivr.

Provider Profile APIs.io OpenAPI GitHub

RingCentral IVR API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IVR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

10 operations 5 paths 19 schemas 1 DELETE5 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

RingCentral IVR API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

IVR 10
GET
/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content
Get IVR Prompt Content
readIVRPromptContent 4 params → 200
GET
/restapi/v1.0/account/{accountId}/ivr-prompts
List IVR Prompts
listIvrPrompts 1 param → 200404500503
POST
/restapi/v1.0/account/{accountId}/ivr-prompts
Create IVR Prompts
createIVRPrompt 1 param body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
Get IVR Prompt
readIVRPrompt 2 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
Update IVR Prompt
updateIVRPrompt 2 params body → 200400404500503
DELETE
/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
Delete IVR Prompt
deleteIVRPrompt 2 params → 204404500503
GET
/restapi/v1.0/account/{accountId}/ivr-menus
Get IVR Menu list
readIVRMenuList 1 param → 200404500503
POST
/restapi/v1.0/account/{accountId}/ivr-menus
Create IVR Menu
createIVRMenu 1 param body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}
Get IVR Menu
readIVRMenu 2 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}
Update IVR Menu
updateIVRMenu 2 params body → 200400404500503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are IVRMenuInfo (7 properties), EnumeratedPagingModel (6 properties), PromptInfo (5 properties), IVRMenuListInfo (4 properties). Each schema is shown below with its type and property counts.

IVRMenuList
object
2 properties
AudioPromptInfo
object
For 'Audio' mode only. Prompt media reference
2 properties
PromptInfo
object
5 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
IVRMenuExtensionInfo
object
For 'Connect' or 'Voicemail' actions only. Extension reference
3 properties
PromptLanguageInfo
object
For 'TextToSpeech' mode only. Prompt language metadata
4 properties
UpdateIVRPromptRequest
object
1 property
PageNavigationUri
object
1 property
IvrMenuSiteInfo
object
Site data
2 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
EnumeratedPagingModel
object
6 properties 1 required
IVRMenuInfo
object
7 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
IVRMenuListInfo
object
4 properties
IVRMenuActionsInfo
object
4 properties
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
IvrMenuPromptInfo
object
Prompt metadata
4 properties
IvrPrompts
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-ivr-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
AE Profile APIs.io
RingCentral Team Messaging API
AE Profile APIs.io
RingCentral Video API
AE Profile APIs.io
RingCentral Fax API
AE Profile APIs.io
RingCentral Data API
AE Profile APIs.io
RingCentral Audio and Video AI API
AE Profile APIs.io
RingCentral Call Log API
AE Profile APIs.io
RingCentral Call Analytics API
AE Profile APIs.io
RingCentral Presence API
AE Profile APIs.io
RingCentral Voicemail API
AE Profile APIs.io
RingCentral Provisioning API
AE Profile APIs.io
RingCentral Webhooks and Subscriptions API
AE Profile APIs.io
#IVR
← Back to R APIs
API Details
ID
ringcentral:ringcentral-ivr-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ringcentral-ivr-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ringcentral-ivr-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of RingCentral IVR API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.