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.

Note

Authentication: The Zoom class supports JSON Web Token Authentication. You must Create a JWT App to obtain an API Key and API Secret for authentication.

Quick Start¶

To instantiate the Zoom class, you can either store your Zoom API key and secret as environmental variables (ZOOM_API_KEY and ZOOM_API_SECRET, respectively) or pass them in as arguments:

from parsons import Zoom

# If environmental variables ZOOM_API_KEY and ZOOM_API_SECRET
# are set, no need for arguments
zoom = Zoom()

# If providing authentication credentials via arguments
zoom = Zoom(api_key='my_api_key', api_secret='my_api_secret')

# 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(account_id=None, client_id=None, client_secret=None)[source]¶

Instantiate the Zoom class.

Args:

api_key: str: A valid Zoom api key. Not required if ZOOM_API_KEY env variable set.
api_secret: str: A valid Zoom api secret. Not required if ZOOM_API_SECRET env variable set.

get_users(status='active', role_id=None)[source]¶

Get users.

Args:

status: str: Filter by the user status. Must be one of following: active, inactive, or pending.
role_id: str: Filter by the user role.

Returns:

Parsons Table: See Parsons Table for output options.

get_meetings(user_id, meeting_type='scheduled')[source]¶

Get meetings scheduled by a user.

Args:

user_id: str: A user id or email address of the meeting host.

meeting_type: str

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.

Returns:

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.

Parsons Table: See Parsons Table for output options.

get_past_meeting(meeting_uuid)[source]¶

Get metadata regarding a past meeting.

Args:

meeting_id: str: The meeting id

Returns:

Parsons Table: See Parsons Table for output options.

get_past_meeting_participants(meeting_id)[source]¶

Get past meeting participants.

Args:

meeting_id: str: The meeting id

Returns:

Parsons Table: See Parsons Table for output options.

get_meeting_registrants(meeting_id)[source]¶

Get meeting registrants.

Args:

meeting_id: str: The meeting id

Returns:

Parsons Table: See Parsons Table for output options.

get_user_webinars(user_id)[source]¶

Get meeting registrants.

Args:

user_id: str: The user id

Returns:

Parsons Table: See Parsons Table for output options.

get_past_webinar_participants(webinar_id)[source]¶

Get past meeting participants

Args:

webinar_id: str: The webinar id

Returns:

Parsons Table: See Parsons Table for output options.

get_webinar_registrants(webinar_id)[source]¶

Get past meeting participants

Args:

webinar_id: str: The webinar id

Returns:

Parsons Table: See Parsons Table for output options.