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 Greetings API

The Greetings API from RingCentral — 7 operation(s) for greetings.

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

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

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

7 operations 7 paths 15 schemas 5 GET2 POST

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

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

Greetings 7
GET
/restapi/v1.0/account/{accountId}/greeting/{greetingId}/content
Get Account Greeting Media Content
readAccountGreetingContent 4 params → 200404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}/content
Get Extension Greeting Media Content
readGreetingContent 5 params → 200404500503
POST
/restapi/v1.0/account/{accountId}/greeting
Create Company Greeting
createCompanyGreeting 1 param body → 200400404500503
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting
Create Custom User Greeting
createCustomUserGreeting 3 params body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}
Get Custom Greeting
readCustomGreeting 3 params → 200404500503
GET
/restapi/v1.0/dictionary/greeting
List Standard Greetings
listStandardGreetings 4 params → 200500503
GET
/restapi/v1.0/dictionary/greeting/{greetingId}
Get Standard Greeting
readStandardGreeting 1 param → 200404500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DictionaryGreetingInfo (10 properties), CustomCompanyGreetingInfo (7 properties), CustomUserGreetingInfo (6 properties), EnumeratedPagingModel (6 properties). Each schema is shown below with its type and property counts.

CustomGreetingAnsweringRuleInfo
object
Information on an answering rule that the greeting is applied to
2 properties
DictionaryGreetingInfo
object
10 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…
CustomCompanyGreetingLanguageInfo
object
Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording'
4 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
EnumeratedPagingModel
object
6 properties 1 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
PageNavigationUri
object
1 property
DictionaryGreetingList
object
4 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
GreetingTypeEnum
string
Type of greeting, specifying the case when the greeting is played.
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
AnsweringRuleQueryRequest
object
1 property
CustomCompanyGreetingInfo
object
7 properties
CustomUserGreetingInfo
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-greetings-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