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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RingCentral

RingCentral Multi-Site API

The Multi-Site API from RingCentral — 5 operation(s) for multi-site.

Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 5 paths, and defines 29 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 5 paths 29 schemas 1 DELETE4 GET2 POST2 PUT

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
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

RingCentral Multi-Site 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 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Multi-Site 9
GET
/restapi/v1.0/account/{accountId}/sites
List Sites
listSites 1 param → 200
POST
/restapi/v1.0/account/{accountId}/sites
Create Site
createSite 1 param body → 200
GET
/restapi/v1.0/account/{accountId}/sites/{siteId}
Get Site
readSite 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/sites/{siteId}
Update Site
updateSite 2 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/sites/{siteId}
Delete Site
deleteSite 2 params → 204
POST
/restapi/v1.0/account/{accountId}/sites/{siteId}/bulk-assign
Edit Sites
assignMultipleSites 2 params body → 204
GET
/restapi/v1.0/account/{accountId}/sites/{siteId}/members
List Site Members
listSiteMembers 2 params → 200
GET
/restapi/v1.0/account/{accountId}/sites/{siteId}/ivr
Get Site IVR Settings
readSiteIvrSettings 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/sites/{siteId}/ivr
Update Site IVR Settings
updateSiteIvrSettings 2 params body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are SiteInfo (10 properties), CreateSiteRequest (8 properties), SiteUpdateRequest (7 properties), EnumeratedPagingModel (6 properties). Each schema is shown below with its type and property counts.

SiteIVRActionsExtensionInfoUpdate
object
Extension information
1 property
SiteInfo
object
10 properties
RegionalSettings
object
Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings
6 properties
SiteMembersList
object
4 properties
SiteIVRTopMenuUpdate
object
Top IVR Menu extension
1 property
ContactBusinessAddressInfo
object
User's business address. The default is Company (Auto-Receptionist) settings
5 properties
SiteUpdateRequest
object
7 properties 1 required
SiteIVRTopMenu
object
Top IVR Menu extension. Mandatory for MultiLevel mode
3 properties
SiteOperatorReference
object
Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled
1 property
CountryInfoMinimalModel
object
2 properties
SiteMemberInfo
object
5 properties
EnumeratedPagingModel
object
6 properties 1 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
OperatorInfo
object
Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled
4 properties
SiteIVRSettingsUpdate
object
2 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
SitesList
object
4 properties
CreateSiteRequest
object
8 properties
CountryInfoBasicModel
SiteIVRSettings
object
2 properties
TimezoneInfo
object
Extension timezone information
5 properties
RegionalLanguageInfo
object
Information on a language set as regional
3 properties
SiteIvrActionsUpdate
object
Keys handling settings
3 properties
SiteIvrActions
object
Keys handling settings
3 properties
SiteMembersBulkUpdate
object
2 properties
CountryInfoShortModel
SiteIVRActionsExtensionInfo
object
Extension information
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-multi-site-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
AE Profile APIs.io
RingCentral Team Messaging API
AE Profile APIs.io
RingCentral Video API
AE Profile APIs.io
RingCentral Fax API
AE Profile APIs.io
RingCentral Data API
AE Profile APIs.io
RingCentral Audio and Video AI API
AE Profile APIs.io
RingCentral Call Log API
AE Profile APIs.io
RingCentral Call Analytics API
AE Profile APIs.io
RingCentral Presence API
AE Profile APIs.io
RingCentral Voicemail API
AE Profile APIs.io
RingCentral Provisioning API
AE Profile APIs.io
RingCentral Webhooks and Subscriptions API
AE Profile APIs.io
#Multi-Site
← Back to R APIs
API Details
ID
ringcentral:ringcentral-multi-site-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network