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.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 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.
BillingStatementInfo
object
Billing information. Returned for device update request if prestatement query parameter is set to 'true'
8 properties
ExtensionInfoIntId
object
This attribute can be omitted for unassigned devices
4 properties
OutboundProxyInfo
object
3 properties
PhoneLinesInfo
object
4 properties
EmergencyAddress
object
3 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
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…
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
DeleteDeviceFromInventoryResponse
object
1 property1 required
BulkAddDevicesResponse
object
1 property1 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
EnumeratedPagingModel
object
6 properties1 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property1 required
PhoneNumberDefinitionTollType
object
To use as selection criteria when a number to be selected from the number pool.
1 property1 required
PageNavigationUri
object
1 property
DeviceResource
object
22 properties
PhoneLineTypeEnum
string
The type of phone line
AddDeviceToInventoryRequest
object
3 properties2 required
GetExtensionDevicesResponse
object
4 properties3 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
DeviceFeatureEnum
string
Device feature
DeviceUpdatePhoneLinesInfo
object
Information on phone lines added to a device
1 property
PageNavigationModel
object
Links to other pages of the current result set
4 properties
DeviceEmergencyLocationInfo
object
Company emergency response location details
3 properties
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…
PhoneNumberInfoIntId
object
Phone number information
10 properties
AddonInfo
object
3 properties
BulkAddDevicesItem
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…
ModelInfo
object
HardPhone model information
6 properties
RemoveLineResponse
object
4 properties3 required
RemoveLineRequest
object
1 property1 required
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property1 required
PhoneNumberDefinitionPreferredAreaCode
object
To use as selection hint when a "toll" number to be selected from the number pool.
1 property1 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
DeleteDeviceFromInventoryRequest
object
1 property1 required
PhoneNumberCountryInfo
object
Brief information on a phone number country
3 properties
DeviceEmergencyInfo
object
Device emergency settings
7 properties
BillingStatementFees
object
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…
