Zoom¶

Overview¶

Zoom is a video conferencing platform. This connector supports fetching users, fetching meetings, fetching metadata for past meetings, and fetching participants of past meetings via the Zoom API.

Authentication

The Zoom class uses server-to-server Zoom Server-to-Server OAuth to authenticate queries to the Zoom API. You must create a server-to-server application at Zoom App Marketplace - Create App to obtain an account_id, client_id, and client_secret key. You will use this OAuth application to define your scopes, which gives your Zoom connector read permission on endpoints of your choosing (meetings, webinars, reports, etc.)

Quickstart¶

To instantiate the Zoom class, you can either store your Zoom account ID, client ID, and client secret as environmental variables (ZOOM_ACCOUNT_ID, ZOOM_CLIENT_ID, ZOOM_CLIENT_SECRET) or pass them in as arguments.

Pass credentials via environmental variables¶

from parsons import Zoom
zoom = Zoom(parsons_version="v2")

Pass credentials as arguments¶

from parsons import Zoom
zoom = Zoom(
  account_id="my_account_id",
  client_id="my_client_id",
  client_secret="my_client_secret",
  parsons_version="v2",
)

You can then call class methods:

Get a table of host’s meetings via their email or user id¶

meetings_tbl = zoom.get_meetings('my_name@mail.com')

Get the list of participants in a past meeting¶

participants_tbl = zoom.get_past_meeting_participants('my_meeting_id')

API¶

class parsons.zoom.zoom.Zoom(account_id: str | None = None, client_id: str | None = None, client_secret: str | None = None, parsons_version: Literal['v1', 'v2'] | None = None)[source]¶

Parameters:

account_id (str | None)
client_id (str | None)
client_secret (str | None)
parsons_version (Literal['v1', 'v2'] | None)

Return type:

ZoomV1 | ZoomV2

class parsons.zoom.zoom.ZoomV2(account_id: str | None = None, client_id: str | None = None, client_secret: str | None = None)[source]¶

Version 2 implementation of a Parsons connector.

Designed to involve minimal transformation logic and clearer naming conventions.

Inherits the following methods from version 1: - get_users - get_meetings - get_past_meeting - get_meeting_registrants - get_past_webinar_report - get_webinar_registrants

Overwrites the following methods from version 1: - get_past_meeting_participants - get_past_webinar_participants

Renames/refactors the following methods (and raises error if original function called): - get_user_webinars - get_meeting_poll_metadata - get_meeting_all_polls_metadata - get_past_meeting_poll_metadata - get_webinar_poll_metadata - get_webinar_all_polls_metadata - get_past_webinar_poll_metadata - get_meeting_poll_results - get_webinar_poll_results

Parameters:

account_id (str | None)
client_id (str | None)
client_secret (str | None)

get_webinars(user_id: int) → Table[source]¶

Get webinars scheduled by or on behalf of a webinar host.

Parameters:

user_id (int) – str The user id

Returns:

Table: See Table for output options.

Return type:

Type	Notes
`scheduled`	This includes all valid past meetings, live meetings and upcoming scheduled meetings. It is the equivalent to the combined list of “Previous Meetings” and “Upcoming Meetings” displayed in the user’s Meetings page.
`live`	All the ongoing meetings.
`upcoming`	All upcoming meetings including live meetings.

Zoom¶

Overview¶

Quickstart¶

API¶

Legacy API¶