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 Regional Settings API

The Regional Settings API from RingCentral — 9 operation(s) for regional settings.

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

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

This API exposes 9 operations across 9 paths, and defines 17 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.

9 operations 9 paths 17 schemas 9 GET

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 Regional Settings 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 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

Regional Settings 9
GET
/restapi/v1.0/dictionary/state
List States
listStates 5 params → 200
GET
/restapi/v1.0/dictionary/state/{stateId}
Get State
readState 1 param → 200
GET
/restapi/v1.0/dictionary/location
List Locations
listLocations 5 params → 200
GET
/restapi/v1.0/dictionary/language
List Languages
listLanguages → 200
GET
/restapi/v1.0/dictionary/language/{languageId}
Get Language
readLanguage 1 param → 200
GET
/restapi/v1.0/dictionary/timezone
List Timezones
listTimezones 2 params → 200
GET
/restapi/v1.0/dictionary/timezone/{timezoneId}
Get Timezone
readTimezone 1 param → 200
GET
/restapi/v1.0/dictionary/country
List Countries
listCountries 6 params → 200
GET
/restapi/v1.0/dictionary/country/{countryId}
Get Country
readCountry 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are LanguageInfo (10 properties), EnumeratedPagingModel (6 properties), LocationInfo (6 properties), GetTimezoneInfoResponse (5 properties). Each schema is shown below with its type and property counts.

EnumeratedPagingModel
object
6 properties 1 required
PageNavigationUri
object
1 property
CountryListDictionaryModel
object
4 properties 3 required
LanguageList
object
4 properties
GetLocationListResponse
object
4 properties 2 required
GetStateListResponse
object
4 properties
LocationInfo
object
6 properties
LocationStateInfo
object
Information on a state this location belongs to
2 properties
CountryInfoShortModel
CountryInfoBasicModel
GetTimezoneInfoResponse
object
5 properties
GetTimezoneListResponse
object
4 properties 3 required
CountryInfoDictionaryModel
PageNavigationModel
object
Links to other pages of the current result set
4 properties
LanguageInfo
object
User interface language data
10 properties
CountryInfoMinimalModel
object
2 properties
GetStateInfoResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-regional-settings-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