Struct zoom_api::webinars::Webinars

pub struct Webinars {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Webinars

pub async fn get( &self, user_id: &str, page_size: i64, page_number: i64 ) -> Result<Response<Domains>, ClientError>

List webinars.

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

Use this API to list all the webinars that are scheduled by or on-behalf a user (webinar host). For user-level apps, pass the me value instead of the userId parameter.

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees.

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

Prerequisites:

• Pro or higher plan with a Webinar Add-on.

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.

• 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.

pub async fn create( &self, user_id: &str ) -> Result<Response<WebinarCreateResponseAllOf>, ClientError>

Create a webinar.

This function performs a POST to the /users/{userId}/webinars endpoint.

Use this API to schedule a webinar for a user (host). For user-level apps, pass the me value instead of the userId parameter.

Zoom users with a Webinar Plan have access to creating and managing webinars. Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees.

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

Prerequisites:

• Pro or higher plan with a Webinar add-on.

Parameters:

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

pub async fn webinar( &self, webinar_id: i64, occurrence_id: &str, show_previous_occurrences: bool ) -> Result<Response<WebinarResponseAllOf>, ClientError>

Get a webinar.

This function performs a GET to the /webinars/{webinarId} endpoint.

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to get details of a scheduled webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Light
Prerequisites:

• Pro or higher plan with a Webinar Add-on.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• occurrence_id: &str – Unique Identifier that identifies an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences. When you create a recurring Webinar using Create a Webinar API, you can retrieve the Occurrence ID from the response of the API call.
• show_previous_occurrences: 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.

pub async fn delete( &self, webinar_id: i64, occurrence_id: &str, cancel_webinar_reminder: &str ) -> Result<Response<()>, ClientError>

Delete a webinar.

This function performs a DELETE to the /webinars/{webinarId} endpoint.

Delete a Webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

• Pro or higher plan with a Webinar Add-on.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

• occurrence_id: &str – The meeting occurrence ID.

• cancel_webinar_reminder: &str – true: Notify panelists and registrants about the webinar cancellation via email.

  false: Do not send any email notification to webinar registrants and panelists.

  The default value of this field is false.

pub async fn update( &self, webinar_id: i64, occurrence_id: &str ) -> Result<Response<()>, ClientError>

Update a webinar.

This function performs a PATCH to the /webinars/{webinarId} endpoint.

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to make updates to a scheduled Webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

• Pro or higher plan with a Webinar Add-on.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• occurrence_id: &str – Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}.

pub async fn list_participants( &self, webinar_id: &str, page_size: i64, next_page_token: &str ) -> Result<Response<Vec<Participants>>, ClientError>

List webinar participants.

This function performs a GET to the /past_webinars/{webinarId}/participants endpoint.

Use this API to list all the participants who attended a webinar hosted in the past.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  Scopes: webinar:read:admin webinar:read
  
  Rate Limit Label: Medium
  

Parameters:

• webinar_id: &str – Unique identifier of the webinar. You can retrieve the value of this field by calling the list webinars API.
• 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.

pub async fn list_all_participants( &self, webinar_id: &str ) -> Result<Response<Vec<Participants>>, ClientError>

List webinar participants.

This function performs a GET to the /past_webinars/{webinarId}/participants endpoint.

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

Use this API to list all the participants who attended a webinar hosted in the past.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  Scopes: webinar:read:admin webinar:read
  
  Rate Limit Label: Medium
  

pub async fn status( &self, webinar_id: i64, body: &WebinarStatusRequest ) -> Result<Response<()>, ClientError>

Update webinar status.

This function performs a PUT to the /webinars/{webinarId}/status endpoint.

Update a webinar’s status. Use this API to end an ongoing webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

• The account must hold a valid Webinar plan.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn panelist( &self, webinar_id: i64 ) -> Result<Response<Domains>, ClientError>

List panelists.

This function performs a GET to the /webinars/{webinarId}/panelists endpoint.

Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar.

Use this API to list all the panelists of a Webinar.

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Medium
Prerequisites:

• Pro or a higher plan with Webinar Add-on.
  

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn panelist_create( &self, webinar_id: i64, body: &WebinarPanelist ) -> Result<Response<()>, ClientError>

Add panelists.

This function performs a POST to the /webinars/{webinarId}/panelists endpoint.

Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
Use this API to add panelists to a scheduled webinar.

Scopes: webinar:write:admin webinar:write
Rate Limit Label: Medium

Prerequisites:

• Pro or a higher plan with Webinar Add-on.
  

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn panelists_delete( &self, webinar_id: i64 ) -> Result<Response<()>, ClientError>

Remove panelists.

This function performs a DELETE to the /webinars/{webinarId}/panelists endpoint.

Remove all the panelists from a Webinar.
Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

• Pro or a higher plan with Webinar Add-on.
  

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn panelist_delete( &self, webinar_id: i64, panelist_id: i64 ) -> Result<Response<()>, ClientError>

Remove a panelist.

This function performs a DELETE to the /webinars/{webinarId}/panelists/{panelistId} endpoint.

Remove a single panelist from a webinar.
You can retrieve the panelistId by calling List Panelists API.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light

Prerequisites:

• Pro or a higher plan with Webinar Add-on.
  

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• panelist_id: i64 – The panelist ID or panelist email.

pub async fn registrant( &self, webinar_id: &str, occurrence_id: &str, status: MeetingRegistrantsStatus, tracking_source_id: &str, page_size: i64, page_number: i64, next_page_token: &str ) -> Result<Response<Domains>, ClientError>

List webinar registrants.

This function performs a GET to the /webinars/{webinarId}/registrants endpoint.

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to list all the users that have registered for a webinar.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  Scopes: webinar:read:admin webinar:read
  Rate Limit Label: Medium
  

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

• occurrence_id: &str – The meeting occurrence ID.

• 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.

• tracking_source_id: &str – The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details.

• 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 registrant_create( &self, webinar_id: &str, occurrence_ids: &str ) -> Result<Response<WebinarRegistrantCreateResponse>, ClientError>

Add a webinar registrant.

This function performs a POST to the /webinars/{webinarId}/registrants endpoint.

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to create and submit the registration of a user for a webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

• Pro or higher plan with a Webinar Add-on.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• occurrence_ids: &str – Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.

pub async fn add_batch_registrants( &self, webinar_id: &str, body: &AddBatchRegistrantsRequest ) -> Result<Response<AddBatchRegistrantsResponse>, ClientError>

Perform batch registration.

This function performs a POST to the /webinars/{webinarId}/batch_registrants endpoint.

Use this API to register up to 30 registrants at once for a scheduled webinar that requires registration.

Prerequisites:

• The webinar host must be a Licensed user.
• The webinar should be of type 5, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API.
  
  Scope: webinar:write, webinar:write:admin
  Rate Limit Label: Heavy
  

Parameters:

• webinar_id: &str – Unique identifier of the webinar.

pub async fn registrant_status( &self, webinar_id: i64, occurrence_id: &str, body: &RegistrantStatus ) -> Result<Response<()>, ClientError>

Update registrant’s status.

This function performs a PUT to the /webinars/{webinarId}/registrants/status endpoint.

Update a webinar registrant’s status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Medium

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• occurrence_id: &str – The meeting occurrence ID.

pub async fn past( &self, webinar_id: i64 ) -> Result<Response<Domains>, ClientError>

List past webinar instances.

This function performs a GET to the /past_webinars/{webinarId}/instances endpoint.

List past webinar instances.

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn poll( &self, webinar_id: i64 ) -> Result<Response<Domains>, ClientError>

List a webinar’s polls .

This function performs a GET to the /webinars/{webinarId}/polls endpoint.

List all the polls of a Webinar.

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn poll_create( &self, webinar_id: i64, body: &Poll ) -> Result<Response<MeetingPollGetResponseAllOf>, ClientError>

Create a webinar’s poll.

This function performs a POST to the /webinars/{webinarId}/polls endpoint.

Create a poll for a webinar.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn poll_get( &self, webinar_id: i64, poll_id: &str ) -> Result<Response<MeetingPollGetResponseAllOf>, ClientError>

Get a webinar poll.

This function performs a GET to the /webinars/{webinarId}/polls/{pollId} endpoint.

Get a webinar’s poll details.

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• poll_id: &str – User’s first name.

pub async fn poll_update( &self, webinar_id: i64, poll_id: &str, body: &Poll ) -> Result<Response<()>, ClientError>

Update a webinar poll.

This function performs a PUT to the /webinars/{webinarId}/polls/{pollId} endpoint.

Update a webinar’s poll.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• poll_id: &str – User’s first name.

pub async fn poll_delete( &self, webinar_id: i64, poll_id: &str ) -> Result<Response<()>, ClientError>

Delete a webinar poll.

This function performs a DELETE to the /webinars/{webinarId}/polls/{pollId} endpoint.

Delete a webinar’s poll.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• poll_id: &str – User’s first name.

pub async fn registrants_questions_get( &self, webinar_id: i64 ) -> Result<Response<WebinarRegistrantQuestions>, ClientError>

List registration questions.

This function performs a GET to the /webinars/{webinarId}/registrants/questions endpoint.

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
Prerequisites:

• Pro or higher plan with a Webinar Add-on. Scopes: webinar:read:admin webinar:read
  

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn registrant_question_update( &self, webinar_id: i64, body: &WebinarRegistrantQuestions ) -> Result<Response<()>, ClientError>

Update registration questions.

This function performs a PATCH to the /webinars/{webinarId}/registrants/questions endpoint.

Scheduling a Webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
• Registration option for Webinar should be set as required to use this API. Scopes: webinar:write:admin webinar:write
  

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn registrant_get( &self, webinar_id: &str, registrant_id: &str, occurrence_id: &str ) -> Result<Response<Domains>, ClientError>

Get a webinar registrant.

This function performs a GET to the /webinars/{webinarId}/registrants/{registrantId} endpoint.

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to get details on a specific user who has registered for the Webinar.

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Light
Prerequisites:

• The account must have a Webinar plan.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .
• registrant_id: &str – User’s first name.
• occurrence_id: &str – The meeting occurrence ID.

pub async fn delete_registrant( &self, webinar_id: &str, registrant_id: &str, occurrence_id: &str ) -> Result<Response<()>, ClientError>

Delete a webinar registrant.

This function performs a DELETE to the /webinars/{webinarId}/registrants/{registrantId} endpoint.

Delete a webinar registrant.

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light

Parameters:

• webinar_id: i64 – Account seats.
• registrant_id: &str – User’s first name.
• occurrence_id: &str – The webinar occurence ID.

pub async fn absentee( &self, occurrence_id: &str, page_size: i64, next_page_token: &str, webinar_uuid: &str ) -> Result<Response<Domains>, ClientError>

Get webinar absentees.

This function performs a GET to the /past_webinars/{WebinarUUID}/absentees endpoint.

List absentees of a webinar.

Scopes: webinar:read:admin webinar:read
Rate Limit Label: Heavy

Parameters:

• occurrence_id: &str – The meeting occurrence ID.
• 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.
• webinar: &str – The Webinar UUID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Please double encode your UUID when using it for API calls if the UUID begins with a ‘/’ or contains ‘//’ in it.

pub async fn get_tracking_sources( &self, webinar_id: &str ) -> Result<Response<GetTrackingSourcesResponse>, ClientError>

Get webinar tracking sources.

This function performs a GET to the /webinars/{webinarId}/tracking_sources endpoint.

Webinar Registration Tracking Sources allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
Use this API to list information on all the tracking sources of a Webinar.
Scopes: webinar:read:admin, webinar:read

Rate Limit Label: Medium
Prerequisites:

• Webinar license.
• Registration must be required for the Webinar.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn list_past_poll_results( &self, webinar_id: &str ) -> Result<Response<ReportMeetingPollsResponse>, ClientError>

List past webinar poll results.

This function performs a GET to the /past_webinars/{webinarId}/polls endpoint.

The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar.

Prerequisites:

• Webinar license
  Scopes: webinar:read:admin, webinar:read
  Rate Limit Label: Medium

Parameters:

• webinar_id: &str – The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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 list_past_qa( &self, webinar_id: &str ) -> Result<Response<ReportWebinarQaResponse>, ClientError>

List Q&A of past webinar.

This function performs a GET to the /past_webinars/{webinarId}/qa endpoint.

The Question & Answer (Q&A) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
Use this API to list Q&A of a specific Webinar.

Prerequisites:

• Webinar license
  Scopes: webinar:read:admin, webinar:read
  
  

Rate Limit Label: Medium

Parameters:

• webinar_id: &str – The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a 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 list_templates( &self, user_id: &str ) -> Result<Response<ListWebinarTemplatesResponse>, ClientError>

List webinar templates.

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

Use this API to list a user’s existing webinar templates’ information. For user-level apps, pass the me value instead of the userId parameter.

When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars.

Prerequisites:

• Pro or a higher account with Webinar plan enabled.

pub async fn get_live_stream_details( &self, webinar_id: &str ) -> Result<Response<GetLiveStreamDetailsResponse>, ClientError>

Get live stream details.

This function performs a GET to the /webinars/{webinarId}/livestream endpoint.

Zoom allows users to live stream a webinar to a custom platform. Use this API to get a webinar’s live stream configuration details such as Stream URL, Stream Key and Page URL.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  
• Live streaming details must have been configured for the webinar.
  
  Scopes: webinar:read:admin webinar:read
  Rate Limit Label: Light

Parameters:

• webinar_id: &str – The webinar’s unique ID.

pub async fn live_stream_update( &self, webinar_id: &str, body: &MeetingLiveStream ) -> Result<Response<()>, ClientError>

Update a live stream.

This function performs a PATCH to the /webinars/{webinarId}/livestream endpoint.

Zoom allows users to live stream a webinar to a custom platform. Use this API to update a webinar’s live stream information.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  
• Live streaming details must have been configured for the webinar.
  
  Scopes: webinar:write:admin webinar:write
  Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn live_stream_status_update( &self, webinar_id: i64, body: &WebinarLiveStreamStatus ) -> Result<Response<()>, ClientError>

Update Live Stream Status.

This function performs a PATCH to the /webinars/{webinarId}/livestream/status endpoint.

Zoom allows users to live stream a webinar to a custom platform. Use this API to update the status of a webinar’s live stream.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.
  
• Live streaming details must have been configured for the webinar.
  
  Scopes: webinar:write:admin webinar:write
  Rate Limit Label: Light

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .

pub async fn invite_links_create( &self, webinar_id: i64, body: &InviteLink ) -> Result<Response<InviteLinks>, ClientError>

Create webinar’s invite links.

This function performs a POST to the /webinars/{webinarId}/invite_links endpoint.

Use this API to create a batch of invitation links for a webinar.

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

Prerequisites:

• Business, Education or API Plan with Webinar add-on.

Parameters:

• webinar_id: i64 – The webinar ID in “long” format(represented as int64 data type in JSON). .