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 Device SIP Registration API

The Device SIP Registration API from RingCentral — 1 operation(s) for device sip registration.

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

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

This API exposes 1 operation across 1 path, and defines 31 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.

1 operations 1 paths 31 schemas 1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Device SIP Registration 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Device SIP Registration 1
POST
/restapi/v1.0/client-info/sip-provision
Register Device
createSIPRegistration body → 200400500503

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SipRegistrationDeviceInfo (20 properties), ShippingAddressInfo (19 properties), DeviceEmergencyServiceAddressResourceAu (17 properties), DeviceEmergencyServiceAddressResourceFr (16 properties). Each schema is shown below with its type and property counts.

SipRegistrationDeviceLocationInfo
object
Company emergency response location details
3 properties
SipInfoResponse
object
13 properties
DevicePhoneLinesEmergencyAddressInfo
object
2 properties
DeviceEmergencyServiceAddressResourceDefault
object
Address for emergency cases. The same emergency address is assigned to all the numbers of one device
14 properties
DeviceModelInfo
object
HardPhone model information
4 properties 1 required
DevicePhoneLinesInfo
object
4 properties
SipRegistrationDeviceEmergencyInfo
object
Emergency response location settings of a device
9 properties
SIPInfoRequest
object
1 property
DeviceEmergencyServiceAddressResourceAu
object
Address for emergency cases. The same emergency address is assigned to all the numbers of one device
17 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
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
DevicePhoneNumberCountryInfo
object
Brief information on a phone number country
3 properties
AuthorizationType
string
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
DeviceExtensionInfo
object
3 properties
CreateSipRegistrationRequest
object
3 properties
DeviceAddonInfo
object
3 properties
DeviceEmergencyServiceAddressResourceFr
object
Address for emergency cases. The same emergency address is assigned to all the numbers of one device
16 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…
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…
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
ShippingMethodIdModel
object
Devices shipping method. It is required if devices are ordered. Availability of different shipping methods depends on package definition.
1 property 1 required
DeviceInfoRequest
object
Device information
4 properties
CreateSipRegistrationResponse
object
6 properties 3 required
DeviceSiteInfo
object
Site data
2 properties
ShippingMethodInfo
SipFlagsResponse
object
SIP flags information
7 properties
SipRegistrationDeviceInfo
object
20 properties
DevicePhoneNumberInfo
object
Phone number information
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-device-sip-registration-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