RingCentral Extensions API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Extensions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 5 paths,
and defines 59 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.
6 operations5 paths59 schemas4 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
RingCentral Extensions 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 6
Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ExtensionBulkUpdateInfo (20 properties), ExtensionCreationResponse (20 properties), GetExtensionListInfoResponse (15 properties), ExtensionCreationRequest (15 properties). Each schema is shown below with its type and property counts.
ExtensionServiceFeatureInfo
object
3 properties
CustomFieldInfo
object
3 properties
SetupWizardStateForUpdateEnum
string
Initial configuration wizard state
ExtensionBulkUpdateRequest
object
List of extensions to be updated
1 property1 required
SiteInfo
object
10 properties
ProfileImageInfoURI
object
1 property
RegionalSettings
object
Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings
6 properties
GetExtensionListResponse
object
4 properties1 required
ExtensionUpdateShortResult
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…
ReferenceInfo
object
3 properties
ExtensionCreationResponse
object
20 properties
ContactBusinessAddressInfo
object
User's business address. The default is Company (Auto-Receptionist) settings
5 properties
CountryInfoMinimalModel
object
2 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
ExtensionBulkUpdateTaskResult
object
Result record on multiple extension update task
2 properties
ExtensionLanguageInfoRequest
object
1 property
EnumeratedPagingModel
object
6 properties1 required
PageNavigationUri
object
1 property
FormattingLocaleInfo
object
Formatting language preferences for numbers, dates and currencies
3 properties
GreetingLanguageInfo
object
Information on language used for telephony greetings
3 properties
CostCenterInfo
object
Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
2 properties
ExtensionGreetingLanguageInfoRequest
object
1 property
UserTransitionInfo
object
For NotActivated extensions only. Welcome email settings
2 properties
OperatorInfo
object
Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled
4 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
TemplateInfo
object
Text message template information
1 property1 required
ContactInfo
object
Detailed contact information
12 properties
ExtensionTimezoneInfoRequest
object
1 property
ExtensionCurrencyInfoRequest
object
1 property
PronouncedNameInfo
object
3 properties
CallQueueExtensionInfo
object
For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product te…
4 properties
ProvisioningSiteInfo
object
Site data. If multi-site feature is turned on for an account, then ID of a site must be specified. In order to assign a wireless point to the main site (compan…
4 properties
ExtensionStatusInfo
object
Status information (reason, comment). Returned for 'Disabled' status only
3 properties
ExtensionListEventBody
object
Notification payload body
3 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property1 required
ExtensionListEvent
object
5 properties
CallQueueInfoRequest
object
For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product te…
4 properties
GetExtensionListInfoResponse
object
15 properties
PronouncedNamePromptInfo
object
3 properties
PermissionInfoAdmin
object
Admin permission
1 property
CountryInfoBasicModel
AssignedCountryInfo
object
Information on a country assigned to an extension user. Returned for the User extension type only
4 properties
ExtensionCountryInfoRequest
object
1 property
TimezoneInfo
object
Extension timezone information
5 properties
ContactInfoCreationRequest
object
Contact Information
11 properties
RegionalLanguageInfo
object
Information on a language set as regional
3 properties
ContactInfoUpdateRequest
object
11 properties
ExtensionFormattingLocaleInfoRequest
object
1 property
ExtensionPermissions
object
Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'
2 properties
PermissionInfoInt
object
International Calling permission
1 property
ExtensionBulkUpdateTaskResource
object
Information on a task for updating multiple extensions
6 properties5 required
ExtensionRegionalSettingRequest
object
7 properties
ProfileImageInfo
object
Information on profile image
5 properties1 required
CountryInfoShortModel
ExtensionCreationRequest
object
15 properties
UserTemplates
object
4 properties3 required
ExtensionBulkUpdateInfo
object
20 properties
ErrorEntity
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
