How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Extensions API

The Extensions API from RingCentral — 5 operation(s) for extensions.

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.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.

6 operations 5 paths 59 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 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.

Extensions 6
POST
/restapi/v1.0/account/{accountId}/extension-bulk-update
Update Multiple Extensions
extensionBulkUpdate 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/extension-bulk-update/tasks/{taskId}
Get Extension Update Task Status
getExtensionBulkUpdateTask 2 params → 200
GET
/restapi/v1.0/account/{accountId}/templates
List User Templates
listUserTemplates 4 params → 200
GET
/restapi/v1.0/account/{accountId}/templates/{templateId}
Get User Template
readUserTemplate 2 params → 200
GET
/restapi/v1.0/account/{accountId}/extension
List Extensions
listExtensions 7 params → 200
POST
/restapi/v1.0/account/{accountId}/extension
Create Extension
createExtension 1 param body → 200400

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ExtensionBulkUpdateInfo (20 properties), ExtensionCreationResponse (20 properties), ExtensionCreationRequest (15 properties), GetExtensionListInfoResponse (15 properties). Each schema is shown below with its type and property counts.

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
RegionalSettings
object
Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings
6 properties
ExtensionCreationRequest
object
15 properties
ExtensionBulkUpdateRequest
object
List of extensions to be updated
1 property 1 required
PronouncedNamePromptInfo
object
3 properties
ExtensionBulkUpdateTaskResult
object
Result record on multiple extension update task
2 properties
ErrorEntity
object
4 properties
ContactInfoUpdateRequest
object
11 properties
GetExtensionListResponse
object
4 properties 1 required
ExtensionRegionalSettingRequest
object
7 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
ReferenceInfo
object
3 properties
TemplateInfo
object
Text message template information
1 property 1 required
ExtensionListEventBody
object
Notification payload body
3 properties
FormattingLocaleInfo
object
Formatting language preferences for numbers, dates and currencies
3 properties
ExtensionLanguageInfoRequest
object
1 property
ExtensionBulkUpdateTaskResource
object
Information on a task for updating multiple extensions
6 properties 5 required
CostCenterInfo
object
Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
2 properties
CountryInfoBasicModel
UserTransitionInfo
object
For NotActivated extensions only. Welcome email settings
2 properties
SiteInfo
object
10 properties
PermissionInfoAdmin
object
Admin permission
1 property
ProfileImageInfoURI
object
1 property
UserTemplates
object
4 properties 3 required
ExtensionServiceFeatureInfo
object
3 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
PronouncedNameInfo
object
3 properties
OperatorInfo
object
Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled
4 properties
RegionalLanguageInfo
object
Information on a language set as regional
3 properties
CountryInfoMinimalModel
object
2 properties
ExtensionListEvent
object
5 properties
PageNavigationUri
object
1 property
ExtensionStatusInfo
object
Status information (reason, comment). Returned for 'Disabled' status only
3 properties
ExtensionPermissions
object
Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'
2 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
ContactInfo
object
Detailed contact information
12 properties
ExtensionCurrencyInfoRequest
object
1 property
GetExtensionListInfoResponse
object
15 properties
ExtensionGreetingLanguageInfoRequest
object
1 property
CountryInfoShortModel
SetupWizardStateForUpdateEnum
string
Initial configuration wizard state
ExtensionTimezoneInfoRequest
object
1 property
GreetingLanguageInfo
object
Information on language used for telephony greetings
3 properties
ExtensionUpdateShortResult
object
3 properties
PermissionInfoInt
object
International Calling permission
1 property
EnumeratedPagingModel
object
6 properties 1 required
ContactBusinessAddressInfo
object
User's business address. The default is Company (Auto-Receptionist) settings
5 properties
PageNavigationModel
object
Links to other pages of the current result set
4 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
ExtensionCreationResponse
object
20 properties
ExtensionCountryInfoRequest
object
1 property
ContactInfoCreationRequest
object
Contact Information
11 properties
AssignedCountryInfo
object
Information on a country assigned to an extension user. Returned for the User extension type only
4 properties
ExtensionFormattingLocaleInfoRequest
object
1 property
TimezoneInfo
object
Extension timezone information
5 properties
ExtensionBulkUpdateInfo
object
20 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…
CustomFieldInfo
object
3 properties
ProfileImageInfo
object
Information on profile image
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-extensions-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
Where this information came from

This is an independent, third-party profile of RingCentral Extensions 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.