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 Historical Recordings API

Historical webinar recordings management (host and admin interfaces)

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

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

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

5 operations 5 paths 35 schemas 5 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 Historical Recordings 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 5

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

Historical Recordings 5

Historical webinar recordings management (host and admin interfaces)

GET
/webinar/history/v1/company/recordings
List Webinar Recordings (Admin)
rcwHistoryAdminListRecordings 7 params → 200400403500
GET
/webinar/history/v1/company/recordings/{recordingId}
Get Webinar Recording (Admin)
rcwHistoryAdminGetRecording 1 param → 200400403404500
GET
/webinar/history/v1/recordings
List Webinar Recordings
rcwHistoryListRecordings 5 params → 200400403500
GET
/webinar/history/v1/recordings/{recordingId}
Get Webinar Recording
rcwHistoryGetRecording 1 param → 200400403404500
GET
/webinar/history/v1/recordings/{recordingId}/download
Get Webinar Recording Download Resource
rcwHistoryGetRecordingDownload 2 params → 200400403404500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are RecordingBaseModel (5 properties), SessionMinimalModel (5 properties), RcwPagingForwardModel (4 properties), RecordingDownloadModel (3 properties). Each schema is shown below with its type and property counts.

WebinarHostModel
object
1 property 1 required
RecordingItemModel
RecordingExtendedModel
WebinarTitleModel
object
2 properties 1 required
RecordingSharedStatusModel
boolean
Indicates if Host or Admin has shared a recording. Can be set to true only then recording status is 'Available'.
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…
RecordingListResource
object
2 properties 2 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
RecordingDownloadModel
object
3 properties 3 required
RecordingMediaType
string
Recording file media type. 'Video' implies multiplexed audio and video. 'Audio' refers to audio only.
HostModel
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
RecordingSharingModel
object
1 property 1 required
RcwDomainUserModel
RcwResourceBaseModel
RcwUserModel
object
2 properties 2 required
RcwPagingForwardModel
object
4 properties 2 required
RecordingBaseModel
object
5 properties 1 required
RcwImmutableResourceIdModel
object
1 property
RcwResourceIdModel
object
1 property
WebinarRefModel
RecordingStatusModel
string
Recording status
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
SessionRefAdminModel
SessionRefModel
RecordingSharedLinkExpiryModel
string
Time after which recording shared link cannot be accessed by recipients.
RecordingAdminModel
RcwBaseContactModel
object
2 properties
RecordingItemExtendedModel
RcwLinkedUserModel
object
The internal IDs of RC-authenticated users.
1 property
RcwPagingModel
RecordingAdminListResource
object
2 properties 2 required
RecordingModel
SessionMinimalModel
object
5 properties
RecordingAdminExtendedItemModel

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-historical-recordings-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