RingCentral Devices API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Devices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
10 operations
across 8 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.
10 operations8 paths62 schemas2 DELETE3 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
RingCentral Devices 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 8 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 3 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 DeviceResource (22 properties), EmergencyServiceAddressResource (22 properties), ShippingAddressInfo (19 properties), CommonEmergencyLocationAddressInfoDefault (13 properties). Each schema is shown below with its type and property counts.
ShippingMethodInfo
BulkAddDevicesSuccessItem
object
4 properties4 required
ShippingMethodIdModel
object
Devices shipping method. It is required if devices are ordered. Availability of different shipping methods depends on package definition.
1 property1 required
PhoneNumberInfoIntId
object
Phone number information
10 properties
DeviceProvisioningExtensionInfo
object
Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list
4 properties
PhoneLinesInfo
object
4 properties
CommonEmergencyLocationAddressInfoDefault
object
13 properties
BulkAddDevicesResponse
object
1 property1 required
UpdateDevicePhoneInfo
object
1 property
PhoneNumberDefinitionTollType
object
To use as selection criteria when a number to be selected from the number pool.
To be used for direct number assignment in case number pool is not supported
2 properties1 required
ModelInfo
object
HardPhone model information
6 properties
GetExtensionDevicesResponse
object
4 properties3 required
EmergencyServiceAddressResource
object
Address for emergency cases. The same emergency address is assigned to all the numbers of one device
22 properties
AddonInfo
object
3 properties
PhoneNumberE164
string
Phone number in e.164 format (with '+' prefix)
AddDeviceToInventoryResponse
object
2 properties2 required
ShippingInfo
object
Shipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer
5 properties
PhoneLineTypeEnum
string
The type of phone line
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property1 required
RemoveLineResponse
object
4 properties3 required
BillingStatementFees
object
3 properties
DeviceFeatureEnum
string
Device feature
PageNavigationUri
object
1 property
PostalAddress
object
Postal address/location
6 properties4 required
AddDeviceToInventoryRequest
object
3 properties2 required
DeviceSiteInfo
object
Site data
2 properties
BulkAddDevicesRequest
object
1 property1 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
RemoveLineRequest
object
1 property1 required
PhoneNumberTollType
string
Indicates if a number is toll or toll-free
PhoneNumberDefinitionNumberId
object
To be used to assign a number by ID
1 property1 required
PhoneNumberCountryInfo
object
Brief information on a phone number country
3 properties
DeviceDefinition
object
3 properties3 required
DeviceUpdateExtensionInfo
object
Information on extension that the device is assigned to
1 property
BulkAddDevicesErrorItem
object
2 properties2 required
AccountDeviceUpdate
object
6 properties
LinePoolingEnum
string
Pooling type of device: - Host - device with a standalone paid phone line which can be linked to soft phone client instance; - Guest - device with a linked pho…
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property1 required
PhoneNumberDefinitionPreferredAreaCode
object
To use as selection hint when a "toll" number to be selected from the number pool.
1 property1 required
ShippingStatus
string
Order item shipping status. It is set to Initial when the order is submitted. Then it is changed to Accepted when a distributor starts processing the order. Fi…
ExtensionInfoIntId
object
This attribute can be omitted for unassigned devices
4 properties
EnumeratedPagingModel
object
6 properties1 required
BulkOperationExtensionReference
object
Information about an extension this device is assigned to
1 property1 required
SiteBasicInfo
object
2 properties2 required
PageNavigationModel
object
Links to other pages of the current result set
4 properties
SipInfoResource
object
5 properties
OutboundProxyInfo
object
3 properties
DeviceEmergencyLocationInfo
object
Company emergency response location details
3 properties
EmergencyServiceAddressResourceRequest
object
Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in emergency…
9 properties
DeleteDeviceFromInventoryResponse
object
1 property1 required
DeviceUpdatePhoneLinesInfo
object
Information on phone lines added to a device
1 property
ShippingAddressInfo
object
Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default, the same value as the emergencyServiceAddr…
19 properties
BillingStatementInfo
object
Billing information. Returned for device update request if prestatement query parameter is set to 'true'
8 properties
SwapDeviceRequest
object
Swap device request
1 property
EmergencyAddress
object
3 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…
DeviceEmergencyInfo
object
Device emergency settings
7 properties
BulkAddDevicesItem
DeleteDeviceFromInventoryRequest
object
1 property1 required
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 Devices 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.
