RIringcentral
Historical Recordings

List Webinar Recordings (Admin)

Returns the list of webinar recordings (Administrator's interface). The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

get/webinar/history/v1/company/recordings

Request

Query parameters

nameFragmentstring

Filter to return only webinar recordings containing particular substring within their names

creationTimeFromstring date-time required

The beginning of the time window by 'creationTime' .

creationTimeTostring date-time required

The end of the time window by 'creationTime' .

statusRecordingStatusModel[]

The status of the recording.

[
  "Available"
]
hostUserIdstring[]

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

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",
      "status": "Available",
      "failureReason": {
        "errorCode": "XXX-123",
        "message": "Something went wrong"
      },
      "duration": 3600,
      "shared": true,
      "sharedUriExpirationTime": "2023-10-01T10:05:00.000Z",
      "session": {
        "id": "78654321",
        "duration": 3600,
        "title": "Live Broadcasting US",
        "description": "Live session for US-based participants",
        "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"
          }
        }
      }
    }
  ],
  "paging": {
    "perPage": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.