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 Webinars and Sessions API

External APIs for webinar and session management

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

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

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

11 operations 6 paths 28 schemas 2 DELETE5 GET2 PATCH2 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 Webinars and Sessions 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 11

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

Webinars and Sessions 11

External APIs for webinar and session management

POST
/webinar/configuration/v1/webinars
Create Webinar
rcwConfigCreateWebinar body → 201400403500
GET
/webinar/configuration/v1/webinars
List User's Webinars
rcwConfigListWebinars 3 params → 200400500
GET
/webinar/configuration/v1/webinars/{webinarId}
Get Webinar
rcwConfigGetWebinar 1 param → 200400403404500
PATCH
/webinar/configuration/v1/webinars/{webinarId}
Update Webinar
rcwConfigUpdateWebinar 1 param body → 200400403404500
DELETE
/webinar/configuration/v1/webinars/{webinarId}
Delete Webinar
rcwConfigDeleteWebinar 1 param → 204403404500
POST
/webinar/configuration/v1/webinars/{webinarId}/sessions
Create Webinar Session
rcwConfigCreateSession 1 param body → 201400403404500
PATCH
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}
Update Webinar Session
rcwConfigUpdateSession 2 params body → 200400403404500
GET
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}
Get Webinar Session
rcwConfigGetSession 2 params → 200403404500
DELETE
/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}
Delete Webinar Session
rcwConfigDeleteSession 2 params → 204403404500
GET
/webinar/configuration/v1/company/sessions
List Sessions across Multiple Webinars/Hosts
rcwConfigListAllCompanySessions 5 params → 200400500
GET
/webinar/configuration/v1/sessions
List Sessions across Multiple Webinars
rcwConfigListAllSessions 5 params → 200400500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are WcsWebinarSettingsModel (23 properties), WcsSessionBaseModel (9 properties), WcsSessionGeneratedModel (5 properties), RcwPagingForwardModel (4 properties). Each schema is shown below with its type and property counts.

WcsSessionWithLocaleCodeModel
WebinarGeneratedModel
object
1 property 1 required
WcsWebinarResource
WcsSessionGlobalListResource
object
2 properties 2 required
WcsWebinarRefModel
WcsWebinarSettingsModel
object
Various settings which define behavior of this Webinar's Sessions
23 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…
WcsSessionBaseModel
object
9 properties 3 required
WcsSessionStatusModel
string
Session status (for the purposes of Configuration service)
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
WcsSessionResource
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
WebinarListResource
object
2 properties 2 required
RcwDomainUserModel
WcsSessionGeneratedModel
object
5 properties
RcwPagingForwardModel
object
4 properties 2 required
RcwUserModel
object
2 properties 2 required
RcwResourceBaseModel
WebinarCreationRequest
RcwImmutableResourceIdModel
object
1 property
RcwResourceIdModel
object
1 property
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
WebinarBaseModel
WcsHostModel
object
1 property 1 required
WebinarInfoModel
object
2 properties
RcwLinkedUserModel
object
The internal IDs of RC-authenticated users.
1 property
RcwPagingModel
SessionGlobalListEntry

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-webinars-and-sessions-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