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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RingCentral

RingCentral Phone Numbers API

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

Provider Profile APIs.io OpenAPI GitHub

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.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 9 paths 44 schemas 1 DELETE5 GET1 PATCH3 POST

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
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
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 UserPhoneNumberInfo (15 properties), CompanyPhoneNumberInfo (15 properties), PhoneNumberInfoNumberParser (13 properties), AccountPhoneNumberInfo (8 properties). Each schema is shown below with its type and property counts.

PhoneNumberId
string
Internal unique identifier of a phone number
UserPhoneNumberInfo
object
15 properties
ReplacePhoneNumberRequest
object
1 property
GetCountryInfoNumberParser
object
5 properties
AccountPhoneNumberList
object
2 properties 2 required
AccountPhoneNumbers
object
4 properties
AddPhoneNumbersResponse
object
1 property 1 required
DeletePhoneNumbersRequestItem
object
The indication of a number to be deleted - either "id" or "phoneNumber" must be specified.
2 properties
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
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
CountryInfoMinimalModel
object
2 properties
AddPhoneNumbersTask
object
3 properties
DeletePhoneNumbersResponse
object
1 property 1 required
GetExtensionPhoneNumbersResponse
object
4 properties 3 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
PageNavigationUri
object
1 property
AddPhoneNumberRequestItem
object
2 properties 2 required
PhoneNumberType
string
Type of phone number
ExtensionStatus
string
Extension status
ParsePhoneNumberResponse
object
3 properties 2 required
PageNavigationModel
object
Links to other pages of the current result set
4 properties
ExtensionNumber
string
Short number of an extension. Actual max length depends on system length limit for extension.
PhoneNumberUsageType
string
Usage type of phone number
ParsePhoneNumberRequest
object
1 property
AssignPhoneNumberRequest
object
4 properties 1 required
AccountPhoneNumberInfo
object
8 properties 5 required
CompanyPhoneNumberInfo
object
15 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
PhoneNumberInfoNumberParser
object
13 properties
PlatformPaymentType
string
Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
CountryInfoBasicModel
BulkItemResultModel
object
2 properties 1 required
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
PhoneNumberE164
string
Phone number in e.164 format (with '+' prefix)
DeletePhoneNumbersRequest
object
1 property 1 required
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
AddPhoneNumbersResponseItem
PhoneNumberTollType
string
Indicates if a number is toll or toll-free
DeletePhoneNumbersResponseItem
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
AddPhoneNumbersRequest
object
1 property 1 required
TemporaryNumberInfo
object
Temporary phone number, if any. Returned for phone numbers in Pending porting status only
2 properties

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
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
#Phone Numbers
← Back to R APIs
API Details
ID
ringcentral:ringcentral-phone-numbers-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network