RingCentral Historical Webinars API

Historical webinars and sessions information

RingCentral Historical Webinars 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 Webinars. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

8 operations 8 paths 51 schemas 8 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

Contact

RingCentral Developers Support

License

RingCentral API License Agreement

View terms

Resource Areas

Authentication & Security 1

RingCentral Historical Webinars 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 8

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

Historical Webinars 8

Historical webinars and sessions information

GET

/webinar/history/v1/webinars/{webinarId}

Get Historical Webinar

rcwHistoryGetWebinar 1 param → 200400403404500

GET

/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}

Get Historical Webinar Session

rcwHistoryGetSession 2 params → 200403404500

GET

/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}/participants

List Session Participants

rcwHistoryListParticipants 6 params → 200400403404500

GET

/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}/participants/self

Get Participant Information

rcwHistoryGetParticipantInfo 2 params → 200400403404500

GET

/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}/invitees

List Session Invitees

rcwHistoryListInvitees 6 params → 200400403404500

GET

/webinar/history/v1/webinars/{webinarId}/sessions/{sessionId}/invitees/{inviteeId}

Get Session Invitee

rcwHistoryGetInvitee 3 params → 200400403404500

GET

/webinar/history/v1/company/sessions

List Historical Webinar Sessions across Multiple Webinars / Hosts

rcwHistoryListAllCompanySessions 6 params → 200400403500

GET

/webinar/history/v1/sessions

List Historical Webinar Sessions across Multiple Webinars

rcwHistoryListAllSessions 6 params → 200400500

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are WebinarSettingsModel (23 properties), SessionLivestreamMinimalModel (6 properties), SessionMinimalModel (5 properties), RecordingBaseModel (5 properties). Each schema is shown below with its type and property counts.

WebinarHostModel

object

1 property 1 required

WebinarSettingsModel

object

Various settings which define behavior of this Webinar's Sessions

23 properties

RecordingExtendedModel

RecordingSharedStatusModel

boolean

Indicates if Host or Admin has shared a recording. Can be set to true only then recording status is 'Available'.

WebinarTitleModel

object

2 properties 1 required

SessionLivestreamListModel

object

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…

ParticipantBaseModel

ApiError

object

Generalized API error structure suitable for any error type

2 properties 2 required

SessionGlobalListResource

object

2 properties 2 required

RcwEmailModel

string

User's contact email

ApiErrorResponseModel

object

Standard error response model which is returned in case of any unsuccessful operation

1 property 1 required

HostModel

SessionGlobalResource

RecordingSharingModel

object

1 property 1 required

RcwDomainUserModel

RcwPagingForwardModel

object

4 properties 2 required

RcwUserModel

object

2 properties 2 required

RcwResourceBaseModel

AvatarOwnerModel

object

1 property

SessionRuntimeStatusModel

string

Session runtime status (for 'Active' Sessions only). It is omitted (or null) if the status is not Active

RcwRoleEnum

string

The role of the webinar session participant/invitee. See also: [Understanding Webinar Roles](https://support.ringcentral.com/webinar/getting-started/understand…

RecordingBaseModel

object

5 properties 1 required

RcwImmutableResourceIdModel

object

1 property

RcwRoleAttributeModel

object

The attribute declaration to indicate webinar session participant/invitee role

1 property 1 required

RcwResourceIdModel

object

1 property

InviteeModel

RecordingStatusModel

string

Recording status

ParameterizedErrorResponseModel

object

Standard error response which may include parameterized errors

1 property 1 required

RcwSessionStatusModel

string

Webinar session status

SessionLivestreamMinimalModel

object

6 properties 3 required

WebinarResource

WebinarRefModel

RecordingSharedLinkExpiryModel

string

Time after which recording shared link cannot be accessed by recipients.

ParticipantReducedModel

SessionBaseModel

SessionGeneratedModel

object

1 property

RcwBaseContactModel

object

2 properties

SessionRecordingExtendedModel

object

1 property

InviteeListResource

object

2 properties 2 required

RcwLinkedUserModel

object

The internal IDs of RC-authenticated users.

1 property

RcwPagingModel

ParticipantTypeModel

object

1 property 1 required

SessionLivestreamStatusModel

string

Last known state of the livestream as notified by Webinar Livestreaming Controller Service (WLCS). Value may not be consistent with latest state, especially fo…

SessionRecordingModel

object

1 property

SessionResource

OriginalRoleModel

object

Role assigned to participant when invite was sent or during join time (if an invite was not sent)

1 property 1 required

ParticipantExtendedModel

RecordingModel

SessionMinimalModel

object

5 properties

ParticipantListResource

object

2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

#Historical Webinars

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Historical Webinars API

Metadata

Authentication & Security 1

Paths & Operations 8

Schemas 51

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Historical Webinars API

Metadata

Authentication & Security 1

Paths & Operations 8

Schemas 51

Specification

Source

More from RingCentral 12

API Details

Provider

Explore more