Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral IVR API

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

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.0.3, 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.0.3
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
Terms of Service
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.

AudioPromptInfo
object
For 'Audio' mode only. Prompt media reference
2 properties
IvrMenuPromptInfo
object
Prompt metadata
4 properties
IvrPrompts
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…
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
EnumeratedPagingModel
object
6 properties 1 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
PageNavigationUri
object
1 property
PageNavigationModel
object
Links to other pages of the current result set
4 properties
IVRMenuList
object
2 properties
IVRMenuInfo
object
7 properties
IVRMenuActionsInfo
object
4 properties
IVRMenuExtensionInfo
object
For 'Connect' or 'Voicemail' actions only. Extension reference
3 properties
PromptInfo
object
5 properties
IvrMenuSiteInfo
object
Site data
2 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
UpdateIVRPromptRequest
object
1 property
PromptLanguageInfo
object
For 'TextToSpeech' mode only. Prompt language metadata
4 properties
IVRMenuListInfo
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
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API