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

RingCentral Phone Numbers API

The Phone Numbers API from RingCentral — 9 operation(s) for phone numbers.

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

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

This API exposes 10 operations across 9 paths, and defines 44 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 9 paths 44 schemas 1 DELETE5 GET1 PATCH3 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Phone Numbers 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 9 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Phone Numbers 10
GET
/restapi/v2/accounts/{accountId}/phone-numbers
List Account Phone Numbers
listAccountPhoneNumbersV2 10 params → 200400403429404500503
DELETE
/restapi/v2/accounts/{accountId}/phone-numbers
Delete Numbers from Inventory
deleteNumbersFromInventoryV2 1 param body → 200400403429404500503
PATCH
/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}
Assign Phone Number
assignPhoneNumberV2 2 params body → 200400403429404500503
POST
/restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId}/replace
Replace Phone Number
replacePhoneNumberV2 2 params body → 200400403429404500503
POST
/restapi/v2/accounts/{accountId}/phone-numbers/bulk-add
Add Numbers to Inventory
addNumbersToInventoryV2 1 param body → 200202400403429404500503
GET
/restapi/v2/accounts/{accountId}/phone-numbers/bulk-add/{taskId}
Get Add Numbers Task Results
getBulkAddTaskResultsV2 2 params → 200403429404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number
Get Extension Phone Number List
listExtensionPhoneNumbers 6 params → 200
GET
/restapi/v1.0/account/{accountId}/phone-number
List Company Phone Numbers
listAccountPhoneNumbers 6 params → 200
GET
/restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}
Get Phone Number
readAccountPhoneNumber 2 params → 200
POST
/restapi/v1.0/number-parser/parse
Parse Phone Number(s)
parsePhoneNumber 2 params body → 200400500503

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are CompanyPhoneNumberInfo (15 properties), UserPhoneNumberInfo (15 properties), PhoneNumberInfoNumberParser (13 properties), AccountPhoneNumberInfo (8 properties). Each schema is shown below with its type and property counts.

DeletePhoneNumbersResponseItem
PhoneNumberUsageType
string
Usage type of phone number
PhoneNumberInfoNumberParser
object
13 properties
AddPhoneNumbersRequest
object
1 property 1 required
AccountPhoneNumberList
object
2 properties 2 required
AddPhoneNumbersTask
object
3 properties
ExtensionStatus
string
Extension status
AssignPhoneNumberRequest
object
4 properties 1 required
PhoneNumberE164
string
Phone number in e.164 format (with '+' prefix)
BulkItemResultModel
object
2 properties 1 required
CountryInfoBasicModel
DeletePhoneNumbersRequestItem
object
The indication of a number to be deleted - either "id" or "phoneNumber" must be specified.
2 properties
UserPhoneNumberInfo
object
15 properties
ParsePhoneNumberRequest
object
1 property
PhoneNumberId
string
Internal unique identifier of a phone number
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
CountryInfoMinimalModel
object
2 properties
UserPhoneNumberExtensionInfo
object
Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list
7 properties
DeletePhoneNumbersResponse
object
1 property 1 required
AddPhoneNumberRequestItem
object
2 properties 2 required
PageNavigationUri
object
1 property
PhoneNumberStatus
string
Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral
ReplacePhoneNumberRequest
object
1 property
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
PhoneNumberTollType
string
Indicates if a number is toll or toll-free
PhoneNumberType
stringnull
Type of phone number
ExtensionNumber
string
Short number of an extension. Actual max length depends on system length limit for extension.
ContactCenterProvider
object
CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'
2 properties
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
CompanyPhoneNumberInfo
object
15 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
GetCountryInfoNumberParser
object
5 properties
ParsePhoneNumberResponse
object
3 properties 2 required
GetExtensionPhoneNumbersResponse
object
4 properties 3 required
AccountPhoneNumbers
object
4 properties
ExtensionInfo
object
Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list
5 properties
DeletePhoneNumbersRequest
object
1 property 1 required
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…
PlatformPaymentType
string
Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
AddPhoneNumbersResponseItem
TemporaryNumberInfo
object
Temporary phone number, if any. Returned for phone numbers in Pending porting status only
2 properties
AccountPhoneNumberInfo
object
8 properties 5 required
AddPhoneNumbersResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-phone-numbers-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
Where this information came from

This is an independent, third-party profile of RingCentral Phone Numbers 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.