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 Business Hours API

The Business Hours API from RingCentral — 2 operation(s) for business hours.

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

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

This API exposes 4 operations across 2 paths, and defines 14 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.

4 operations 2 paths 14 schemas 2 GET2 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
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Business Hours 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 4

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

Business Hours 4
GET
/restapi/v1.0/account/{accountId}/business-hours
Get Company Business Hours
readCompanyBusinessHours 1 param → 200404500503
PUT
/restapi/v1.0/account/{accountId}/business-hours
Update Company Business Hours
updateCompanyBusinessHours 1 param body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours
Get User Business Hours
readUserBusinessHours 2 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours
Update User Business Hours
updateUserBusinessHours 2 params body → 200400404500503

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are WeeklyScheduleInfo (7 properties), TimeInterval (2 properties), GetUserBusinessHoursResponse (2 properties), UserBusinessHoursUpdateResponse (2 properties). Each schema is shown below with its type and property counts.

CompanyBusinessHoursScheduleInfo
object
Schedule when an answering rule is applied
1 property
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…
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
CompanyBusinessHours
object
2 properties
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
WeeklyScheduleInfo
object
Weekly schedule
7 properties
ScheduleInfoUserBusinessHours
object
Schedule when an answering rule is applied
1 property
UserBusinessHoursScheduleInfo
object
Schedule when an answering rule is applied
1 property
CompanyBusinessHoursUpdateRequest
object
1 property
GetUserBusinessHoursResponse
object
2 properties
TimeInterval
object
2 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
UserBusinessHoursUpdateResponse
object
2 properties
UserBusinessHoursUpdateRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-business-hours-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