Sign in

v1

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

List Historical Webinar Sessions across Multiple Webinars / Hosts

Returns the list of historical Webinar Sessions hosted by particular user(s) or all company users sorted by 'endTime' in the descending order. Depending on a session status 'endTime' can represent actual end time or scheduled end time. The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

get/webinar/history/v1/company/sessions

Query parameters

hostUserIdstring[]

Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be returned)

statusRcwSessionStatusModel[]

Filter to return only webinar sessions in certain status. Multiple values are supported.

[
  "Finished"
]
endTimeFromstring date-time required

The beginning of the time window by 'endTime' .

endTimeTostring date-time required

The end of the time window by 'endTime' .

perPageinteger

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied

pageTokenstring

The token indicating the particular page of the result set to be retrieved. If omitted the first page will be returned.

Response

Successful response

Example response

{
  "records": [
    {
      "id": "78654321",
      "webinar": {
        "id": "78654321",
        "title": "All-Hands Webinar",
        "description": "Quarterly All-hands event to present recent news about our company to employees",
        "host": {
          "firstName": "John",
          "lastName": "Doe"
        }
      },
      "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"
      },
      "livestreams": [
        {
          "livestreamId": "40740e06-4eec-4458-a86e-8578e192274q",
          "livestreamStatus": "Error",
          "previousLivestreamStatus": "Initialized",
          "serviceProvider": "YouTube",
          "error": {
            "errorCode": "WLA-123",
            "message": "Authorization invalid"
          }
        }
      ]
    }
  ],
  "paging": {
    "perPage": 100
  }
}