RingCentral Call Handling Rules API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Call Handling Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
12 operations
across 5 paths,
and defines 62 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.
12 operations5 paths62 schemas2 DELETE5 GET1 PATCH2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
RingCentral Call Handling Rules 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 12
Across 5 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are AnsweringRuleInfo (18 properties), UpdateAnsweringRuleRequest (17 properties), CustomAnsweringRuleInfo (17 properties), CreateAnsweringRuleRequest (15 properties). Each schema is shown below with its type and property counts.
CustomGreetingInfoRequest
object
1 property
TimeInterval
object
2 properties
CompanyAnsweringRuleExtensionInfo
object
1 property
ForwardingRuleInfo
object
4 properties
TransferredExtension
object
Transfer extension settings, set/returned if callHandlingAction is specified as TransferToExtension
2 properties
ForwardingRuleCreateRequest
object
4 properties
VoicemailInfo
object
Specifies whether to take a voicemail and who should do it
2 properties
IvrCallHandlingActionEnum
string
Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' -…
GreetingInfo
object
3 properties
RangesInfo
object
2 properties
CompanyAnsweringRuleRequest
object
9 properties
MissedCallInfo
object
Specifies behavior for the missed call scenario. Returned only if enabled parameter of a voicemail is set to 'false'
2 properties
UserAnsweringRuleList
object
4 properties
GreetingTypeEnum
string
Type of greeting, specifying the case when the greeting is played.
CompanyAnsweringRuleInfo
object
11 properties
CompanyAnsweringRuleCallersInfoRequest
object
2 properties
CallersInfo
object
2 properties
ListCompanyAnsweringRuleInfo
object
7 properties
WeeklyScheduleInfo
object
Weekly schedule
7 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property1 required
CalledNumberInfo
object
1 property
UpdateAnsweringRuleRequest
object
17 properties
CompanyAnsweringRuleUpdate
object
9 properties
ExtensionShortInfoResource
object
3 properties
ForwardingInfo
object
Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will…
8 properties
FixedOrderAgents
object
2 properties
CallersInfoRequest
object
2 properties
PageNavigationUri
object
1 property
FixedOrderAgentsExtensionInfo
object
4 properties
RecipientInfo
object
Recipient data
2 properties
SharedLinesInfo
object
SharedLines call handling action settings
1 property
CompanyAnsweringRuleCalledNumberInfo
object
2 properties
ForwardAllCompanyCallsRequest
object
1 property1 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
CompanyAnsweringRuleWeeklyScheduleInfoRequest
object
Weekly schedule. If specified, ranges cannot be specified
7 properties
AnsweringRuleInfo
object
18 properties
CustomAnsweringRuleInfo
object
17 properties
MissedCallExtensionInfoExternalNumber
object
Specifies an external PSTN number which should be used for the missed call transfer. Returned only if the actionType is set to ConnectToExternalNumber
1 property
TransferInfo
object
2 properties
ScheduleInfo
object
Schedule when an answering rule should be applied
3 properties
CreateAnsweringRuleRequest
object
15 properties2 required
PresetInfo
object
3 properties
MissedCallExtensionInfo
object
Specifies an extension (a calling group) which should be used for the missed call transfer. Returned only if the actionType is set to 'ConnectToExtension'
2 properties
ForwardAllCallsReason
object
2 properties
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property1 required
EnumeratedPagingModel
object
6 properties1 required
CompanyAnsweringRuleScheduleInfoRequest
object
Schedule when an answering rule should be applied
3 properties
ForwardingNumberInfoRulesCreateRuleRequest
object
4 properties
CompanyAnsweringRuleExtensionInfoRequest
object
Extension to which the call is forwarded in 'Bypass' mode
1 property
PageNavigationModel
object
Links to other pages of the current result set
4 properties
CompanyAnsweringRuleList
object
4 properties
ForwardingInfoCreateRuleRequest
object
Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will…
7 properties
CompanyAnsweringRuleScheduleInfo
object
Schedule when an answering rule should be applied
3 properties
CompanyAnsweringRuleCalledNumberInfoRequest
object
2 properties
ForwardAllCompanyCallsInfo
object
5 properties
TransferredExtensionInfo
object
1 property
CompanyAnsweringRuleTimeIntervalRequest
object
2 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…
UnconditionalForwardingInfo
object
Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' value is specified for the callHandlingAction parameter
2 properties
QueueInfo
object
Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action
13 properties
CreateAnsweringRuleForwardingNumberInfo
object
5 properties
TransferExtensionInfo
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Call Handling Rules 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.