v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Historical Webinars

Get Historical Webinar Session

Returns a historical webinar Session by ID. Access allowed to participants with original role as Host or CoHost.

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

Response

Successful response

idstring

Internal object ID

creationTimestring date-time required

Object creation time

lastModifiedTimestring date-time required

Object last modification time

startTimestring date-time

Session start time. If a session hasn't been started this fields should be set to "scheduledStartTime"

endTimestring date-time

Session end time. If a session hasn't been finished this fields should be set to ("startTime"+"scheduledDuration")

durationinteger

Session duration in seconds rounded up (returned if 'startTime' and 'endTime' are not empty)

titlestring

Session title. If blank - derived from webinar title.

descriptionstring

User-friendly description of the Session. If blank - derived from webinar title.

scheduledStartTimestring date-time

Session scheduled start time.

scheduledDurationinteger

The scheduled duration of the Session in seconds.

timeZonestring

IANA-compatible time zone name (see https://www.iana.org/time-zones).

localeCodestring

Session locale code. Can't be blank or null.

panelJoinTimeOffsetinteger

The time offset (positive, in seconds) indicating how much in advance (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync

broadcastingStartTimestring date-time

The time when broadcasting started.

broadcastingEndTimestring date-time

The time when broadcasting ended.

status'Scheduled' | 'Active' | 'Finished'

Webinar session status

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

participantCountinteger

The number of participants (of all roles) who joined the webinar

attendeeCountinteger

The number of attendees who joined the webinar

uniqueParticipantCountinteger

Unique number of participants (of all roles) who joined the webinar

uniqueAttendeeCountinteger

Unique number of attendees who joined the webinar

videoBridgeIdstring

The RCV bridge id

Example response

{
  "id": "78654321",
  "duration": 3600,
  "title": "Live Broadcasting US",
  "description": "Live session for US-based participants",
  "scheduledDuration": 1800,
  "timeZone": "America/New_York",
  "localeCode": "en-US",
  "panelJoinTimeOffset": 900,
  "status": "Finished",
  "participantCount": 150,
  "attendeeCount": 145,
  "uniqueParticipantCount": 140,
  "uniqueAttendeeCount": 135,
  "videoBridgeId": "839874770",
  "recording": {
    "id": "78654321",
    "status": "Available",
    "failureReason": {
      "errorCode": "XXX-123",
      "message": "Something went wrong"
    },
    "duration": 3600,
    "shared": true,
    "sharedUriExpirationTime": "2023-10-01T10:05:00.000Z",
    "recordingSharedUri": "https://v.ringcentral.com/w/a/recording/de7yd8ew7yfsdfjh899843rgj?pw=a1b2c3d4"
  },
  "livestreams": [
    {
      "livestreamId": "40740e06-4eec-4458-a86e-8578e192274q",
      "livestreamStatus": "Error",
      "previousLivestreamStatus": "Initialized",
      "serviceProvider": "YouTube",
      "error": {
        "errorCode": "WLA-123",
        "message": "Authorization invalid"
      }
    }
  ]
}