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 Call Forwarding API

The Call Forwarding API from RingCentral — 2 operation(s) for call forwarding.

RingCentral Call Forwarding 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 Forwarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 2 paths, and defines 15 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.

6 operations 2 paths 15 schemas 2 DELETE2 GET1 POST1 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 Call Forwarding 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 6

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

Call Forwarding 6
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number
List Forwarding Numbers
listForwardingNumbers 4 params → 200400404500503
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number
Create Forwarding Number
createForwardingNumber 2 params body → 200400404500503
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number
Delete Forwarding Numbers
deleteForwardingNumbers 2 params body → 204404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
Get Forwarding Number
readForwardingNumber 3 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
Update Forwarding Number
updateForwardingNumber 3 params body → 200400404500503
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
Delete Forwarding Number
deleteForwardingNumber 3 params → 204404500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ForwardingNumberInfo (9 properties), ForwardingNumberResource (7 properties), EnumeratedPagingModel (6 properties), CreateForwardingNumberRequest (5 properties). Each schema is shown below with its type and property counts.

ForwardingNumberId
object
1 property
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…
CreateForwardingNumberDeviceInfo
object
Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter
1 property
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
PageNavigationUri
object
1 property
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
CreateForwardingNumberRequest
object
5 properties
EnumeratedPagingModel
object
6 properties 1 required
PageNavigationModel
object
Links to other pages of the current result set
4 properties
GetExtensionForwardingNumberListResponse
object
4 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
ForwardingNumberResource
object
7 properties
ForwardingNumberInfo
object
9 properties
UpdateForwardingNumberRequest
object
4 properties
DeleteForwardingNumbersRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-call-forwarding-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