Struct zoom_api::cloud_recording::CloudRecording

pub struct CloudRecording {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CloudRecording

pub async fn recordings_list( &self, user_id: &str, page_size: i64, next_page_token: &str, mc: &str, trash: bool, from: NaiveDate, to: NaiveDate, trash_type: &str ) -> Result<Response<Domains>, ClientError>

List all recordings.

This function performs a GET to the /users/{userId}/recordings endpoint.

Use this API to list all cloud recordings of a user. For user-level apps, pass the me value instead of the userId parameter.

Note: To access a user's password protected cloud recording, add an access_token parameter to the download URL and provide either the JWT or the user's OAuth access token as the value of the access_token parameter.

When a user records a meeting or a webinar by choosing the Record to the Cloud option, the video, audio, and chat text are recorded in the Zoom cloud.

Scopes: recording:read:admin, recording:read
Rate Limit Label: Medium

Prerequisites:

• Pro or a higher plan.
• Cloud Recording must be enabled on the user’s account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

• page_size: i64 – The number of records returned within a single API call.

• next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

• mc: &str – Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.

• trash: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.

• from: chrono::NaiveDate – The start date in ‘yyyy-mm-dd’ UTC format for the date range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of ‘from’ field will be “2020-06-30” and the value of the ‘to’ field will be “2020-07-01”.

  Note: The “trash” files cannot be filtered by date range and thus, the “from” and “to” fields should not be used for trash files.

• to: chrono::NaiveDate – End date in ‘yyyy-mm-dd’ ‘yyyy-mm-dd’ UTC format. .

• trash_type: &str – The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:
  meeting_recordings: List all meeting recordings from the trash.
  recording_file: List all individual recording files from the trash. .

pub async fn recording_get( &self, meeting_id: &str, include_fields: &str, ttl: u64 ) -> Result<Response<RecordingGetResponseAllOf>, ClientError>

Get meeting recordings.

This function performs a GET to the /meetings/{meetingId}/recordings endpoint.

Get all the recordings from a meeting or Webinar instance. The recording files can be downloaded via the download_url property listed in the response.

To access a password-protected cloud recording, add an access_token parameter to the download URL and provide OAuth access token or JWT as the access_token value.

Scopes: recording:read:admin, recording:read
Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

• include_fields: &str – Get the download_access_token field for downloading meeting recordings.

• ttl: u64 – Time to live (TTL) of the download_access_token. This is only valid if the include_fields query parameter contains download_access_token. The range is between 0-604800.

pub async fn recording_delete( &self, meeting_id: &str, action: RecordingDeleteAction ) -> Result<Response<()>, ClientError>

Delete meeting recordings.

This function performs a DELETE to the /meetings/{meetingId}/recordings endpoint.

Delete all recording files of a meeting.

Scopes: recording:write:admin recording:write
Rate Limit Label: Light
Prerequisites:

• Cloud Recording should be enabled on the user’s account.
  

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

• action: crate::types::RecordingDeleteAction – The recording delete actions:
  trash - Move recording to trash.
  delete - Delete recording permanently.

pub async fn recording_delete_one( &self, meeting_id: &str, recording_id: &str, action: RecordingDeleteAction ) -> Result<Response<()>, ClientError>

Delete a meeting recording file.

This function performs a DELETE to the /meetings/{meetingId}/recordings/{recordingId} endpoint.

Delete a specific recording file from a meeting.

Note: To use this API, you must enable the The host can delete cloud recordings setting. You can find this setting in the Recording tab of the Settings interface in the Zoom web portal.

Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

• recording_id: &str – User’s first name.

• action: crate::types::RecordingDeleteAction – The recording delete actions:
  trash - Move recording to trash.
  delete - Delete recording permanently.

pub async fn recording_status_update( &self, meeting_id: &str, body: &RecordingStatusUpdateBodyRequest ) -> Result<Response<()>, ClientError>

Recover meeting recordings.

This function performs a PUT to the /meetings/{meetingId}/recordings/status endpoint.

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted Cloud Recordings of a specific meeting.

Scopes: recording:write:admin recording:write

Rate Limit Label: Light
Prerequisites:

• A Pro user with Cloud Recording enabled.

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

pub async fn recording_status_update_one( &self, meeting_id: &str, recording_id: &str, body: &RecordingStatusUpdateBodyRequest ) -> Result<Response<()>, ClientError>

Recover a single recording.

This function performs a PUT to the /meetings/{meetingId}/recordings/{recordingId}/status endpoint.

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
Scopes: recording:write:admin recording:write

Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

• recording_id: &str – User’s first name.

pub async fn recording_setting_update( &self, meeting_id: &str ) -> Result<Response<RecordingSettings>, ClientError>

Get meeting recording settings.

This function performs a GET to the /meetings/{meetingId}/recordings/settings endpoint.

Retrieve settings applied to a meeting’s Cloud Recording.

Scopes: recording:read:admin recording:read

Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

pub async fn recording_settings_update( &self, meeting_id: &str, body: &RecordingSettings ) -> Result<Response<()>, ClientError>

Update meeting recording settings.

This function performs a PATCH to the /meetings/{meetingId}/recordings/settings endpoint.

Update settings applied to a meeting’s Cloud Recording

Scopes: recording:write:admin recording:write

Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

pub async fn meeting_recording_registrant( &self, meeting_id: i64, status: MeetingRegistrantsStatus, page_size: i64, page_number: i64, next_page_token: &str ) -> Result<Response<Domains>, ClientError>

List recording registrants.

This function performs a GET to the /meetings/{meetingId}/recordings/registrants endpoint.

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered to view these recordings.

Use this API to list registrants of On-demand Cloud Recordings of a past meeting.
Scopes: recording:read:admin, recording:read.

Rate Limit Label: Medium

Parameters:

• meeting_id: i64 – The meeting ID in long format. The data type of this field is “long”(represented as int64 in JSON).

  While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits.

• status: crate::types::MeetingRegistrantsStatus – The registrant status:
  pending - Registrant’s status is pending.
  approved - Registrant’s status is approved.
  denied - Registrant’s status is denied.

• page_size: i64 – The number of records returned within a single API call.

• page_number: i64 – Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use “next_page_token” for pagination instead of this field.

  The page number of the current page in the returned records.

• next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

pub async fn meeting_recording_registrant_create( &self, meeting_id: i64 ) -> Result<Response<MeetingRecordingRegistrantCreateResponse>, ClientError>

Create a recording registrant.

This function performs a POST to the /meetings/{meetingId}/recordings/registrants endpoint.

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered to view these recordings.

Use this API to register a user to gain access to On-demand Cloud Recordings of a past meeting.
Scopes: recording:write:admin, recording:write.

Rate Limit Label: Light

Parameters:

• meeting_id: i64 – The meeting ID in long format. The data type of this field is “long”(represented as int64 in JSON).

  While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits.

pub async fn meeting_recording_registrant_status( &self, meeting_id: i64, body: &RecordingRegistrantStatus ) -> Result<Response<()>, ClientError>

Update registrant’s status.

This function performs a PUT to the /meetings/{meetingId}/recordings/registrants/status endpoint.

A registrant can either be approved or denied from viewing the on-demand recording. Use this API to update a registrant’s status.

Scopes: recording:write:admin, recording:write

Rate Limit Label: Medium

Parameters:

• meeting_id: i64 – The meeting ID in long format. The data type of this field is “long”(represented as int64 in JSON).

  While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits.

pub async fn recording_registrants_questions_get( &self, meeting_id: &str ) -> Result<Response<RecordingRegistrantQuestionsData>, ClientError>

Get registration questions.

This function performs a GET to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.

Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
Scopes: recording:read:admin, recording:read

Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

pub async fn recording_registrant_question_update( &self, meeting_id: &str, body: &RecordingRegistrantQuestionsData ) -> Result<Response<()>, ClientError>

Update registration questions.

This function performs a PATCH to the /meetings/{meetingId}/recordings/registrants/questions endpoint.

For on-demand meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.

Use this API to update registration questions that are to be answered by users while registering to view a recording.
Scopes: recording:write:admin, recording:write
Rate Limit Label: Light

Parameters:

• meeting_id: &str – To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

  To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

  If a UUID starts with “/” or contains “//” (example: “/ajXp112QmuoKj4854875==”), you must double encode the UUID before making an API request. .

pub async fn get_account( &self, account_id: &str, page_size: i64, next_page_token: &str, from: Option<DateTime<Utc>>, to: Option<DateTime<Utc>> ) -> Result<Response<Vec<GetAccountCloudRecordingResponseMeetings>>, ClientError>

List recordings of an account.

This function performs a GET to the /accounts/{accountId}/recordings endpoint.

List Cloud Recordings available on an Account.

To access a password protected cloud recording, add an “access_token” parameter to the download URL and provide JWT as the value of the “access_token”.
Prerequisites:

• A Pro or a higher paid plan with Cloud Recording option enabled.
  Scopes: recording:read:admin or account:read:admin

If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts.

To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
Rate Limit Label: Medium

Parameters:

• page_size: i64 – The number of records returned within a single API call.
• next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
• from: chrono::DateTime<chrono::Utc> – The start date in UTC for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of ‘from’ field will be “2020-06-30” and the value of the ‘to’ field will be “2020-07-01”.
• to: chrono::DateTime<chrono::Utc> – The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month.
• account_id: &str – Unique identifier of the account.

pub async fn get_all_account( &self, account_id: &str, from: Option<DateTime<Utc>>, to: Option<DateTime<Utc>> ) -> Result<Response<Vec<GetAccountCloudRecordingResponseMeetings>>, ClientError>

List recordings of an account.

This function performs a GET to the /accounts/{accountId}/recordings endpoint.

As opposed to get_account, this function returns all the pages of the request at once.

List Cloud Recordings available on an Account.

To access a password protected cloud recording, add an “access_token” parameter to the download URL and provide JWT as the value of the “access_token”.
Prerequisites:

• A Pro or a higher paid plan with Cloud Recording option enabled.
  Scopes: recording:read:admin or account:read:admin

If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts.

To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
Rate Limit Label: Medium