ZoomMeetingsApi
Description: Tools that enable LLMs to interact directly with the Zoom Meetings API.
Author: Arcade
Auth: User authorization
ZoomMeetingsApi is a Starter MCP Server: each tool mirrors one HTTP endpoint and offers LLMs a way to interact with the low-level API.
Differently from Optimized MCP Servers, Starter tools are heavily influenced by the original API design, which is not usually optimized for LLM usage. For this reason, we recommend thoroughly evaluating the tools with your Agents or chatbots before using it in production. Read more about Optimized vs Starter tools.
The ZoomMeetingsApi MCP Server provides a comprehensive set of tools for managing Zoom meetings, webinars, recordings, devices, reports, and related resources. With these tools you can:
- Manage meetings and webinars: create, retrieve details, list upcoming/scheduled/past instances, delete meetings or occurrences, manage templates, invitations, livestream and archive tokens, auto-open apps, and meeting summaries.
- Handle recordings, transcripts, and archives: list and retrieve cloud/local recordings and archived files, get transcripts and analytics, obtain recording join/live-stream tokens, and delete recordings or transcripts.
- Administer registrants, polls, surveys, Q&A, and chat: list and manage meeting/webinar registrants and registration questions, fetch and delete polls/surveys, retrieve Q&A and poll results, and remove in-session chat messages.
- Manage devices and telephony: list, retrieve, assign, and remove Zoom devices (ZDM/ZPA/H.323/SIP), get device firmware/app versions, and manage TSP and SIP phone accounts.
- Access reporting and logs: generate meeting, webinar, host, participant, billing, cloud recording, telephone, daily, activity, operation, and audit reports; retrieve archived-file and recording statistics and meeting analytics summaries.
- Configure webinar branding and panelists: manage webinar branding (wallpaper, virtual backgrounds, name tags), list/remove panelists, and retrieve webinar-specific livestream/local-record tokens.
- Work with tracking fields and account-level data: list/manage tracking fields, billing invoices, and billing reports, and retrieve device/group manager info and account-level activity logs.
These tools require appropriate Zoom plans, account features (Pro/Business/Webinar add-ons, archiving/cloud recording, etc.), and OAuth/admin scopes as noted per operation.
Available Tools
Tool Name | Description |
---|---|
ZoomMeetingsApi.GetArchivedZoomFiles | Retrieve a Zoom account's archived meeting or webinar files. |
ZoomMeetingsApi.GetArchivedFileStatistics | Retrieve statistics about archived Zoom meeting files. |
ZoomMeetingsApi.GetZoomArchivedFiles | Retrieve archived files from a specific Zoom meeting. |
ZoomMeetingsApi.DeleteMeetingArchivedFiles | Deletes all archived files of a specified meeting. |
ZoomMeetingsApi.GetMeetingRecordings | Retrieve all recordings for a specified Zoom meeting. |
ZoomMeetingsApi.DeleteZoomRecordings | Delete a meeting or webinar's cloud recordings. |
ZoomMeetingsApi.GetZoomRecordingAnalytics | Retrieve analytics details for Zoom meeting or webinar recordings. |
ZoomMeetingsApi.GetMeetingAnalyticsSummary | Retrieve analytics summary of a Zoom meeting recording. |
ZoomMeetingsApi.GetMeetingRecordingRegistrants | Fetch registrants of past meeting recordings on Zoom. |
ZoomMeetingsApi.GetRecordingRegistrationQuestions | Retrieve questions for registering to view a Zoom meeting recording. |
ZoomMeetingsApi.GetZoomMeetingRecordingSettings | Retrieve a Zoom meeting's cloud recording settings and access info. |
ZoomMeetingsApi.DeleteZoomRecording | Delete a specific Zoom recording from a meeting or webinar. |
ZoomMeetingsApi.GetMeetingTranscript | Retrieve a Zoom meeting's transcript information. |
ZoomMeetingsApi.DeleteZoomMeetingTranscript | Delete a transcript for a Zoom meeting or webinar. |
ZoomMeetingsApi.ListZoomCloudRecordings | Retrieve a user's Zoom cloud recordings. |
ZoomMeetingsApi.ListZoomDevices | Retrieve a list of devices from Zoom. |
ZoomMeetingsApi.GetZoomDeviceManagerGroupInfo | Retrieve Zoom Device Manager group information for an account. |
ZoomMeetingsApi.GetZoomPhoneDeviceSettings | Retrieve user's Zoom Phone Appliance device settings. |
ZoomMeetingsApi.RemoveZoomDeviceByVendorAndMac | Remove a ZPA device from Zoom by vendor and MAC address. |
ZoomMeetingsApi.GetZoomZpaVersionInfo | Retrieve ZPA firmware and app versions for Zoom devices. |
ZoomMeetingsApi.RetrieveZoomDeviceDetails | Retrieve a Zoom device's details. |
ZoomMeetingsApi.RemoveZoomDevice | Removes a device from a Zoom account via ZMD. |
ZoomMeetingsApi.AssignZoomDeviceToGroup | Assign a Zoom device to a specified group. |
ZoomMeetingsApi.ListZoomH323SipDevices | Retrieve all H.323/SIP devices on a Zoom account. |
ZoomMeetingsApi.DeleteZoomDevice | Delete a H.323 or SIP device from your Zoom account. |
ZoomMeetingsApi.DeleteZoomMeetingChatMessage | Delete a live Zoom meeting chat message by ID. |
ZoomMeetingsApi.ListMeetingSummaries | Retrieve meeting and webinar summaries for an account. |
ZoomMeetingsApi.GetZoomMeetingDetails | Retrieve details of a specified Zoom meeting. |
ZoomMeetingsApi.DeleteZoomMeeting | Delete a specific Zoom meeting or occurrence. |
ZoomMeetingsApi.GetZoomMeetingInvitation | Retrieve the invitation note for a Zoom meeting. |
ZoomMeetingsApi.GetZoomMeetingLiveStreamToken | Obtain a join token for Zoom meeting live streaming. |
ZoomMeetingsApi.GetMeetingArchiveToken | Retrieve a meeting's archive token for local archiving. |
ZoomMeetingsApi.GetZoomMeetingRecordingJoinToken | Retrieve a join token for Zoom meeting local recording. |
ZoomMeetingsApi.GetMeetingLivestreamDetails | Get livestream configuration details for a Zoom meeting. |
ZoomMeetingsApi.GetMeetingSummary | Retrieve the summary of a Zoom meeting or webinar. |
ZoomMeetingsApi.DeleteMeetingOrWebinarSummary | Delete the summary of a meeting or webinar. |
ZoomMeetingsApi.AddAutoOpenAppToMeeting | Configure an app to auto-open in a scheduled Zoom meeting. |
ZoomMeetingsApi.DeleteMeetingAutoOpenApp | Delete a meeting auto-open app in Zoom. |
ZoomMeetingsApi.ListZoomMeetingPolls | Retrieve all polls for a specified Zoom meeting. |
ZoomMeetingsApi.GetZoomMeetingPollInfo | Retrieve details of a specific Zoom meeting poll. |
ZoomMeetingsApi.DeleteZoomMeetingPoll | Delete a poll from a Zoom scheduled meeting. |
ZoomMeetingsApi.ListZoomMeetingRegistrants | Retrieve registered users for a Zoom meeting. |
ZoomMeetingsApi.GetZoomMeetingRegistrationQuestions | Retrieve registration questions for a Zoom meeting. |
ZoomMeetingsApi.GetMeetingRegistrantDetails | Retrieve details of a Zoom meeting registrant. |
ZoomMeetingsApi.DeleteMeetingRegistrant | Remove a registrant from a Zoom meeting. |
ZoomMeetingsApi.GetMeetingSurveyInfo | Retrieve details about a Zoom meeting survey. |
ZoomMeetingsApi.DeleteZoomMeetingSurvey | Delete a scheduled Zoom meeting survey. |
ZoomMeetingsApi.GetZoomMeetingCaptionToken | Retrieve a closed caption token for a Zoom meeting. |
ZoomMeetingsApi.GetPastMeetingDetails | Fetch details of a past Zoom meeting. |
ZoomMeetingsApi.GetPastZoomMeetings | Retrieve past instances of Zoom meetings. |
ZoomMeetingsApi.GetPastMeetingParticipants | Retrieve participants from a past Zoom meeting. |
ZoomMeetingsApi.ListPastMeetingPolls | Retrieve poll results for a past Zoom meeting. |
ZoomMeetingsApi.GetZoomPastMeetingQa | Retrieve Q&A from a specific past Zoom meeting. |
ZoomMeetingsApi.ListZoomMeetingTemplates | Retrieve Zoom meeting templates for a user. |
ZoomMeetingsApi.ListZoomScheduledMeetings | Retrieve a Zoom user's scheduled meetings. |
ZoomMeetingsApi.ListUpcomingZoomMeetings | Fetches upcoming Zoom meetings for a user. |
ZoomMeetingsApi.GetUserAudioConferences | Retrieve a list of user's personal audio conference accounts. |
ZoomMeetingsApi.GetZoomUserActivityLogs | Retrieve Zoom user sign in and sign out activity reports. |
ZoomMeetingsApi.GetZoomBillingReport | Retrieve Zoom account department billing reports. |
ZoomMeetingsApi.FetchZoomBillingInvoices | Retrieve billing invoices reports for a specific billing period. |
ZoomMeetingsApi.GetZoomCloudRecordingReport | Retrieve Zoom cloud recording usage report for a date range. |
ZoomMeetingsApi.GetZoomDailyReport | Retrieve daily Zoom usage statistics for account-wide overview. |
ZoomMeetingsApi.GetZoomHistoryMeetings | Retrieve a list of historical Zoom meetings and webinars. |
ZoomMeetingsApi.GetMeetingActivityLogs | Retrieve a list of meeting activity logs from Zoom. |
ZoomMeetingsApi.GetZoomMeetingReport | Retrieve a detailed report for a past Zoom meeting. |
ZoomMeetingsApi.GetZoomMeetingParticipantsReport | Get a report of past Zoom meeting participants. |
ZoomMeetingsApi.GetZoomMeetingPollReport | Fetches a report of poll results for a past Zoom meeting. |
ZoomMeetingsApi.ZoomReportMeetingQa | Retrieve a report on past Zoom meeting Q&A sessions. |
ZoomMeetingsApi.GetZoomMeetingSurveyReport | Retrieve report details of a Zoom meeting survey. |
ZoomMeetingsApi.RetrieveZoomOperationLogs | Retrieve Zoom operation logs for auditing admin and user activity. |
ZoomMeetingsApi.GetZoomTelephoneReport | Retrieve Zoom telephone report for specified meetings. |
ZoomMeetingsApi.ListZoomUpcomingEvents | Retrieve upcoming Zoom meetings and webinars. |
ZoomMeetingsApi.GetZoomHostReport | Retrieve Zoom host activity reports for a specified period. |
ZoomMeetingsApi.GetZoomMeetingReports | Retrieve details of past Zoom meetings and webinars. |
ZoomMeetingsApi.GetZoomWebinarReport | Retrieve details of a past Zoom webinar. |
ZoomMeetingsApi.GetWebinarParticipantReport | Retrieve detailed report on webinar attendees. |
ZoomMeetingsApi.RetrieveZoomWebinarPollsReport | Retrieve report on past webinar polls for a Zoom webinar. |
ZoomMeetingsApi.GetZoomWebinarQaReport | Retrieve report on questions and answers from Zoom webinars. |
ZoomMeetingsApi.GetZoomWebinarSurveyReport | Retrieve a report on past webinar survey results. |
ZoomMeetingsApi.ListSipPhones | Retrieve a list of SIP phones on a Zoom account. |
ZoomMeetingsApi.DeleteZoomSipPhone | Delete a SIP phone from a Zoom account. |
ZoomMeetingsApi.GetTspInfo | Retrieve Telephony Service Provider (TSP) info for an account. |
ZoomMeetingsApi.ListUserTspAccounts | Retrieve a user's TSP accounts on Zoom. |
ZoomMeetingsApi.GetUserTspDetails | Retrieve TSP account details for a specific Zoom user. |
ZoomMeetingsApi.DeleteUserTspAccount | Delete a user's Telephony Service Provider account. |
ZoomMeetingsApi.ListZoomTrackingFields | Retrieve all tracking fields from your Zoom account. |
ZoomMeetingsApi.GetZoomTrackingFieldInfo | Retrieve details about a specific Zoom tracking field. |
ZoomMeetingsApi.DeleteZoomTrackingField | Delete a tracking field in Zoom. |
ZoomMeetingsApi.DeleteWebinarChatMessage | Delete a message from a live Zoom webinar by ID. |
ZoomMeetingsApi.GetWebinarAbsentees | Retrieve a list of absentees from a Zoom webinar. |
ZoomMeetingsApi.ListPastWebinars | Retrieve details of past Zoom webinar instances. |
ZoomMeetingsApi.RetrieveWebinarParticipants | Retrieve participants of a past Zoom webinar. |
ZoomMeetingsApi.GetWebinarPollResults | Retrieve poll results from a past webinar. |
ZoomMeetingsApi.ListWebinarQa | Retrieve Q&A from a past webinar on Zoom. |
ZoomMeetingsApi.ListZoomWebinarTemplates | Retrieve a list of a user's Zoom webinar templates. |
ZoomMeetingsApi.ListZoomWebinars | Retrieve all scheduled webinars for a Zoom user. |
ZoomMeetingsApi.GetZoomWebinarDetails | Retrieve details for a scheduled Zoom webinar. |
ZoomMeetingsApi.DeleteWebinar | Delete a Zoom webinar. |
ZoomMeetingsApi.GetWebinarBrandingInfo | Retrieve webinar session branding information. |
ZoomMeetingsApi.DeleteWebinarNameTag | Delete a Zoom webinar's branding name tag. |
ZoomMeetingsApi.DeleteWebinarVirtualBackground | Delete a webinar's virtual background. |
ZoomMeetingsApi.SetWebinarVirtualBackground | Set a webinar's virtual background branding. |
ZoomMeetingsApi.RemoveWebinarBrandingWallpaper | Remove a webinar's branding wallpaper file. |
ZoomMeetingsApi.GetWebinarLiveStreamingJoinToken | Retrieve a Zoom webinar's join token for live streaming. |
ZoomMeetingsApi.GetWebinarArchiveToken | Get a webinar's archive token for local archiving. |
ZoomMeetingsApi.GetZoomWebinarLocalRecordingToken | Retrieve Zoom webinar join token for local recording. |
ZoomMeetingsApi.GetWebinarLivestreamDetails | Retrieve live stream details for a Zoom webinar. |
ZoomMeetingsApi.ListZoomWebinarPanelists | Retrieve a list of panelists for a specific Zoom webinar. |
ZoomMeetingsApi.RemoveWebinarPanelists | Remove all panelists from a specified Zoom webinar. |
ZoomMeetingsApi.RemoveWebinarPanelist | Remove a panelist from a Zoom webinar. |
ZoomMeetingsApi.ListWebinarPollsZoom | Retrieve all polls from a Zoom webinar. |
ZoomMeetingsApi.GetWebinarPollDetails | Fetches details of a webinar poll from Zoom. |
ZoomMeetingsApi.DeleteWebinarPoll | Delete a poll from a specific webinar on Zoom. |
ZoomMeetingsApi.ListZoomWebinarRegistrants | Retrieve a list of registrants for a specified Zoom webinar. |
ZoomMeetingsApi.GetWebinarRegistrationQuestions | Retrieve registration questions for webinar attendees. |
ZoomMeetingsApi.GetWebinarRegistrantDetails | Retrieve details for a specific Zoom webinar registrant. |
ZoomMeetingsApi.RemoveWebinarRegistrant | Remove a registrant from a Zoom webinar. |
ZoomMeetingsApi.GetWebinarSurveyInfo | Retrieve details about a Zoom webinar survey. |
ZoomMeetingsApi.DeleteZoomWebinarSurvey | Delete a Zoom webinar survey. |
ZoomMeetingsApi.GetWebinarCaptionToken | Retrieve a closed caption token for a Zoom webinar. |
ZoomMeetingsApi.GetWebinarTrackingSources | List tracking sources for a Zoom webinar. |
If you need to perform an action that’s not listed here, you can get in touch with us to request a new tool, or create your own tools.
ZoomMeetingsApi.GetArchivedZoomFiles
Retrieve a Zoom account’s archived meeting or webinar files.
Parameters
- number_of_records_per_call (
integer
, optional) Specify the number of records to retrieve in a single API call. Use an integer value. - pagination_token (
string
, optional) Token used to fetch the next set of results when result exceeds current page size. Expires in 15 minutes. - query_start_date (
string
, optional) The starting date for the query inyyyy-MM-dd'T'HH:mm:ssZ
format. Must not exceed seven days from thequery_end_date
. - query_end_date (
string
, optional) The end date for the query inyyyy-MM-dd'T'HH:mm:ssZ
format, not exceeding seven days from the start date. - query_date_type (
string
, optional) Specifies the type of date to query: ‘meeting_start_time’ or ‘archive_complete_time’. Defaults to ‘meeting_start_time’. - deprecated_group_id (
string
, optional) This argument is deprecated. Please use ‘group_ids’ instead for querying Zoom group information. - filter_by_group_ids (
string
, optional) Comma-separated list of group IDs to filter archived files. Maximum 7 group IDs.
ZoomMeetingsApi.GetArchivedFileStatistics
Retrieve statistics about archived Zoom meeting files.
Parameters
- query_start_date (
string
, optional) The start date for querying archived files, formatted asyyyy-MM-dd'T'HH:mm:ssZ
. Must be within seven days ofquery_end_date
. - query_end_date (
string
, optional) The query end date for retrieving statistics, inyyyy-MM-dd'T'HH:mm:ssZ
format. Ensure the duration between this and the start date does not exceed seven days.
ZoomMeetingsApi.GetZoomArchivedFiles
Retrieve archived files from a specific Zoom meeting.
Parameters
- meeting_uuid (
string
, required) The universally unique identifier (UUID) of the Zoom meeting. Double encode if it starts with ’/’ or contains ’//’ when making other API calls.
ZoomMeetingsApi.DeleteMeetingArchivedFiles
Deletes all archived files of a specified meeting.
Parameters
- meeting_uuid (
string
, required) The universally unique identifier (UUID) of the meeting. Ensure double-encoding if the UUID begins with a ’/’ or contains ’//’.
ZoomMeetingsApi.GetMeetingRecordings
Retrieve all recordings for a specified Zoom meeting.
Parameters
- meeting_id_or_uuid (
string
, required) Provide the Zoom meeting ID or UUID to retrieve cloud recordings. If using UUID, double encode if needed. - include_download_access_token (
string
, optional) Set to ‘download_access_token’ to include this field in the response for downloading recordings. Requires ‘View the recording content’ permission. - download_access_token_ttl (
integer
, optional) The Time to Live value for the download access token. Only valid ifinclude_fields
includesdownload_access_token
.
ZoomMeetingsApi.DeleteZoomRecordings
Delete a meeting or webinar’s cloud recordings.
Parameters
- meeting_or_webinar_identifier (
string
, required) Provide the meeting or webinar ID/UUID to delete its cloud recordings. If using a UUID starting with ’/’ or containing ’//’, double encode it. - recording_delete_action (
string
, optional) Specify the action for deleting recordings:trash
to move to trash ordelete
for permanent removal.
ZoomMeetingsApi.GetZoomRecordingAnalytics
Retrieve analytics details for Zoom meeting or webinar recordings.
Parameters
- meeting_or_webinar_id (
string
, required) Provide the meeting or webinar ID/UUID to retrieve cloud recordings. Double encode UUIDs starting with ’/’ or containing ’//’. - records_per_page (
integer
, optional) The number of analytics records to return in one API call. Adjust for batch size. - pagination_token (
string
, optional) A token for navigating through pages of large result sets. It expires 15 minutes after retrieval. - start_date (
string
, optional) The start date for the monthly range to query, formatted as YYYY-MM-DD. Defaults to current date if not provided. - end_date (
string
, optional) The end date for the queried monthly range. Format: YYYY-MM-DD. The duration can’t exceed one month from the start date. - analytics_detail_type (
string
, optional) Specify the type of analytics details to retrieve: ‘by_view’ for view-based details or ‘by_download’ for download-based details.
ZoomMeetingsApi.GetMeetingAnalyticsSummary
Retrieve analytics summary of a Zoom meeting recording.
Parameters
- meeting_id_or_uuid (
string
, required) Provide the meeting or webinar ID/UUID to retrieve cloud recordings. Double encode UUIDs with special characters. - start_date (
string
, optional) The start date for the monthly range to query, in YYYY-MM-DD format. Defaults to the current date if not provided. - end_date_for_query (
string
, optional) The end date for the monthly range to query. Format as YYYY-MM-DD. The range must not exceed one month.
ZoomMeetingsApi.GetMeetingRecordingRegistrants
Fetch registrants of past meeting recordings on Zoom.
Parameters
- meeting_id (
integer
, required) The meeting’s ID, which can exceed 10 digits. Store as a long format integer to ensure compatibility. - registrant_status_filter (
string
, optional) Filter registrants by status: ‘pending’, ‘approved’, or ‘denied’. - records_per_page (
integer
, optional) Specify the number of registrant records to retrieve per API call. - use_next_page_token (
integer
, optional) Indicate whether to usenext_page_token
for pagination instead ofpage_number
. - pagination_token (
string
, optional) Token for paginating through large result sets. Expires in 15 minutes.
ZoomMeetingsApi.GetRecordingRegistrationQuestions
Retrieve questions for registering to view a Zoom meeting recording.
Parameters
- meeting_or_webinar_id (
string
, required) Provide the meeting or webinar ID/UUID to get the cloud recordings. Double encode UUIDs starting with ’/’ or containing ’//’.
ZoomMeetingsApi.GetZoomMeetingRecordingSettings
Retrieve a Zoom meeting’s cloud recording settings and access info.
Parameters
- zoom_meeting_id (
string
, required) The ID or UUID of the meeting/webinar for retrieving cloud recordings. Double encode UUIDs starting with ’/’ or containing ’//’.
ZoomMeetingsApi.DeleteZoomRecording
Delete a specific Zoom recording from a meeting or webinar.
Parameters
- meeting_or_webinar_id (
string
, required) Provide the meeting ID or UUID, or the webinar ID or UUID to access cloud recordings. UUIDs with/
or//
require double encoding. - recording_id (
string
, required) The unique identifier for the recording you wish to delete. - recording_delete_action (
string
, optional) Specify the action for recording deletion. Use ‘trash’ to move it to trash or ‘delete’ to remove permanently.
ZoomMeetingsApi.GetMeetingTranscript
Retrieve a Zoom meeting’s transcript information.
Parameters
- meeting_id_or_uuid (
string
, required) Provide the meeting or webinar ID/UUID to retrieve its transcript. Double encode UUIDs starting with ’/’ or containing ’//’ before requesting.
ZoomMeetingsApi.DeleteZoomMeetingTranscript
Delete a transcript for a Zoom meeting or webinar.
Parameters
- meeting_or_webinar_identifier (
string
, required) Provide the meeting ID or its unique universal identifier (UUID) to delete the transcript. For webinars, use the webinar ID or UUID. Ensure double encoding if the UUID starts with ’/’ or contains ’//’.
ZoomMeetingsApi.ListZoomCloudRecordings
Retrieve a user’s Zoom cloud recordings.
Parameters
- user_identifier (
string
, required) The user’s ID, email address, or ‘me’ for the current user context. - records_per_page (
integer
, optional) Specify the number of recordings to return in a single call. Adjust to limit response size. - pagination_next_page_token (
string
, optional) A token to paginate through large sets of results. It expires after 15 minutes. - meeting_connector_metadata (
string
, optional) Metadata for recordings using an on-premise meeting connector. - start_date (
string
, optional) The start date in ‘yyyy-mm-dd’ UTC format for retrieving recordings. Must be within a month range. Defaults to current date if not specified. Note: Not applicable for trash files. - end_date_utc (
string
, optional) The end date for retrieving recordings, in ‘yyyy-mm-dd’ UTC format. - cloud_recording_trash_type (
string
, optional) Specify the type of cloud recording to retrieve from trash: ‘meeting_recordings’ for meeting recordings, ‘recording_file’ for individual files. - meeting_id (
integer
, optional) The unique identifier for the Zoom meeting. Provide this to filter recordings by a specific meeting. - include_trash_recordings (
boolean
, optional) Set to true to include recordings from the trash. Defaults to false. Use trash_type for specific types.
ZoomMeetingsApi.ListZoomDevices
Retrieve a list of devices from Zoom.
Parameters
- filter_by_name_or_serial_number (
string
, optional) Filter devices by providing a name or serial number to narrow the search results. - filter_by_platform_os (
string
, optional) Filter devices by platform operating system. Options: ‘win’, ‘mac’, ‘ipad’, ‘iphone’, ‘android’, ‘linux’. - filter_by_device_type (
integer
, optional) Specify the integer code to filter devices by their type. The options are:-1
for all Zoom Room devices,0
for Zoom Rooms Computer,1
for Zoom Rooms Controller,2
for Zoom Rooms Scheduling Display,3
for Zoom Rooms Control System,4
for Zoom Rooms Whiteboard,5
for Zoom Phone Appliance, and6
for Zoom Rooms Computer (with Controller). - filter_by_device_vendor (
string
, optional) Specify the vendor to filter devices by their manufacturer or brand. - filter_device_by_model (
string
, optional) Filter results to include only devices matching a specific model. Provide the model name as a string. - device_status_filter (
integer
, optional) Filter devices by their status:0
for offline,1
for online,-1
for unlinked. - result_limit (
integer
, optional) Specify the maximum number of records to return in a single call, controlling the data volume retrieved. - pagination_token (
string
, optional) Token for retrieving the next page of device results. It expires after 15 minutes. - filter_by_zdm_enrollment (
boolean
, optional) Filter devices by their enrollment in Zoom Device Management (ZDM). Use true for enrolled and false for not enrolled.
ZoomMeetingsApi.GetZoomDeviceManagerGroupInfo
Retrieve Zoom Device Manager group information for an account.
Parameters
- records_per_page (
integer
, optional) The total number of records to return per API call. Default is 30, with a maximum of 100. - pagination_next_page_token (
string
, optional) Token to retrieve the next set of results for paginated Zoom Device Manager group data. Valid for 15 minutes.
ZoomMeetingsApi.GetZoomPhoneDeviceSettings
Retrieve user’s Zoom Phone Appliance device settings.
Parameters
- user_identifier (
string
, optional) The Zoom user’s ID or email address. Use ‘me’ for user-level apps to represent the current user.
ZoomMeetingsApi.RemoveZoomDeviceByVendorAndMac
Remove a ZPA device from Zoom by vendor and MAC address.
Parameters
- device_vendor (
string
, required) The manufacturer’s name of the device to be removed from Zoom’s device manager. - device_mac_address (
string
, required) The MAC address of the device to be removed. This identifier is a string and is required for the operation.
ZoomMeetingsApi.GetZoomZpaVersionInfo
Retrieve ZPA firmware and app versions for Zoom devices.
Parameters
- zoom_device_management_group_id (
string
, required) The ID of the Zoom Device Management (ZDM) group for which you want to retrieve ZPA firmware and app version info.
ZoomMeetingsApi.RetrieveZoomDeviceDetails
Retrieve a Zoom device’s details.
Parameters
- device_unique_identifier (
string
, required) The unique identifier of the Zoom device to retrieve details for.
ZoomMeetingsApi.RemoveZoomDevice
Removes a device from a Zoom account via ZMD.
Parameters
- device_id (
string
, required) The unique identifier of the device to be removed from the Zoom account. Ensure the device is enrolled in Zoom Device Management (ZMD) before calling.
ZoomMeetingsApi.AssignZoomDeviceToGroup
Assign a Zoom device to a specified group.
Parameters
- zoom_group_id (
string
, required) The unique identifier for the Zoom group to which the device will be assigned. - zoom_device_id (
string
, required) The unique identifier for the Zoom device to be assigned to a group.
ZoomMeetingsApi.ListZoomH323SipDevices
Retrieve all H.323/SIP devices on a Zoom account.
Parameters
- records_per_call (
integer
, optional) The number of records to return in a single API call when listing H.323/SIP devices. Adjust to manage response size. - use_page_number (
integer
, optional) Deprecated. Indicates if thepage_number
should be used for pagination. Usenext_page_token
instead. - pagination_token (
string
, optional) Token for paginating large result sets. Expires after 15 minutes.
ZoomMeetingsApi.DeleteZoomDevice
Delete a H.323 or SIP device from your Zoom account.
Parameters
- device_id_to_delete (
string
, required) The unique identifier of the H.323 or SIP device to be deleted from the Zoom account.
ZoomMeetingsApi.DeleteZoomMeetingChatMessage
Delete a live Zoom meeting chat message by ID.
Parameters
- zoom_meeting_id (
integer
, required) The unique identifier for the meeting. Store this value as a long-format integer since it can exceed 10 digits. - chat_message_uuid_base64 (
string
, required) The unique identifier for the live meeting chat message, encoded in base64 format. - chat_file_ids_base64 (
string
, optional) Base64-encoded IDs of live webinar chat files. Separate multiple values with commas.
ZoomMeetingsApi.ListMeetingSummaries
Retrieve meeting and webinar summaries for an account.
Parameters
- number_of_records_per_call (
integer
, optional) Specify the number of summaries to return in one API call. This controls the page size. - pagination_next_page_token (
string
, optional) Token to paginate through large result sets. Expires in 15 minutes. - start_date_utc (
string
, optional) The start date in UTC format (yyyy-MM-dd'T'HH:mm:ss'Z'
) to filter meeting summaries by creation date. - end_date_utc (
string
, optional) The end date inyyyy-MM-dd'T'HH:mm:ss'Z'
UTC format to retrieve meeting summaries within this date range.
ZoomMeetingsApi.GetZoomMeetingDetails
Retrieve details of a specified Zoom meeting.
Parameters
- zoom_meeting_id (
integer
, required) The unique ID of the Zoom meeting. Ensure it is stored as a long format integer due to potential lengths over 10 digits. - meeting_occurrence_id (
string
, optional) The ID of a specific occurrence of a recurring Zoom meeting. This is needed to retrieve details for that particular occurrence. - show_previous_occurrences (
boolean
, optional) Set to true to view details of all previous occurrences of a recurring meeting.
ZoomMeetingsApi.DeleteZoomMeeting
Delete a specific Zoom meeting or occurrence.
Parameters
- meeting_id (
integer
, required) The unique identifier for the Zoom meeting. Ensure to handle as a long integer due to potential size exceeding 10 digits. - meeting_occurrence_id (
string
, optional) The ID for a specific meeting or webinar occurrence. Necessary for deleting a single occurrence in a recurring series. - notify_host_via_email (
boolean
, optional) Set totrue
to notify the host and alternative host about the meeting cancellation via email. Set tofalse
to avoid sending notifications. - notify_registrants_of_cancellation (
boolean
, optional) Set to true to notify registrants via email about the meeting cancellation; false to send no notification. Defaults to false.
ZoomMeetingsApi.GetZoomMeetingInvitation
Retrieve the invitation note for a Zoom meeting.
Parameters
- zoom_meeting_id (
integer
, required) The ID of the Zoom meeting. Store as a long integer since it can exceed 10 digits.
ZoomMeetingsApi.GetZoomMeetingLiveStreamToken
Obtain a join token for Zoom meeting live streaming.
Parameters
- zoom_meeting_id (
integer
, required) The ID of the Zoom meeting for which a live stream join token is required. Store as a long integer as IDs can exceed 10 digits.
ZoomMeetingsApi.GetMeetingArchiveToken
Retrieve a meeting’s archive token for local archiving.
Parameters
- meeting_id (
integer
, required) The Zoom meeting’s ID, stored as a long format integer. Can exceed 10 digits.
ZoomMeetingsApi.GetZoomMeetingRecordingJoinToken
Retrieve a join token for Zoom meeting local recording.
Parameters
- meeting_id (
integer
, required) The unique ID of the Zoom meeting. This should be stored as a long format integer to accommodate IDs exceeding 10 digits. - bypass_waiting_room (
boolean
, optional) Set to true to allow bypassing the waiting room and joining the meeting directly with the recording bot.
ZoomMeetingsApi.GetMeetingLivestreamDetails
Get livestream configuration details for a Zoom meeting.
Parameters
- meeting_id (
string
, required) The unique identifier of the Zoom meeting to retrieve livestream details.
ZoomMeetingsApi.GetMeetingSummary
Retrieve the summary of a Zoom meeting or webinar.
Parameters
- meeting_uuid (
string
, required) The UUID of the meeting or webinar. If it begins with a ’/’ or contains ’//’, double-encode before use.
ZoomMeetingsApi.DeleteMeetingOrWebinarSummary
Delete the summary of a meeting or webinar.
Parameters
- meeting_uuid (
string
, required) The unique ID for the meeting. Double-encode if it starts with ’/’ or contains ’//’.
ZoomMeetingsApi.AddAutoOpenAppToMeeting
Configure an app to auto-open in a scheduled Zoom meeting.
Parameters
- meeting_id (
integer
, required) The ID of the scheduled Zoom meeting. Ensure it is stored as a long format integer, as meeting IDs can exceed 10 digits.
ZoomMeetingsApi.DeleteMeetingAutoOpenApp
Delete a meeting auto-open app in Zoom.
Parameters
- meeting_id (
integer
, required) The unique identifier for the meeting. Ensure it is stored as a long format integer, as IDs can exceed 10 digits.
ZoomMeetingsApi.ListZoomMeetingPolls
Retrieve all polls for a specified Zoom meeting.
Parameters
- zoom_meeting_id (
integer
, required) The ID of the Zoom meeting. Ensure it is stored as a long format number since IDs can exceed 10 digits. - query_anonymous_polls (
boolean
, optional) Set to true to query for polls with the Anonymous option enabled. False excludes them.
ZoomMeetingsApi.GetZoomMeetingPollInfo
Retrieve details of a specific Zoom meeting poll.
Parameters
- meeting_id (
integer
, required) The unique ID of the Zoom meeting. Ensure it is stored as a long integer as it can exceed 10 digits. - poll_id (
string
, required) The unique identifier for the poll within a Zoom meeting. Required to retrieve poll details.
ZoomMeetingsApi.DeleteZoomMeetingPoll
Delete a poll from a Zoom scheduled meeting.
Parameters
- meeting_id (
integer
, required) The unique identifier for the Zoom meeting. Use a long format integer as IDs can exceed 10 digits. - zoom_poll_id (
string
, required) The unique identifier for the poll to be deleted from a scheduled Zoom meeting. Required for poll deletion.
ZoomMeetingsApi.ListZoomMeetingRegistrants
Retrieve registered users for a Zoom meeting.
Parameters
- meeting_id (
integer
, required) The ID of the Zoom meeting. Store this as a long integer to accommodate large values over 10 digits. - meeting_occurrence_id (
string
, optional) The unique identifier for a specific occurrence of a meeting or webinar. - registrant_status (
string
, optional) Filter registrants by their status:pending
,approved
, ordenied
. - number_of_records_per_call (
integer
, optional) The number of registrant records to return in one API call. Determines the batch size. - pagination_page_number_deprecated (
integer
, optional) Deprecated. Do not use. Usenext_page_token
for pagination instead. - pagination_next_page_token (
string
, optional) Use this token to paginate through results. It expires in 15 minutes.
ZoomMeetingsApi.GetZoomMeetingRegistrationQuestions
Retrieve registration questions for a Zoom meeting.
Parameters
- zoom_meeting_id (
integer
, required) The unique ID of the Zoom meeting. It should be stored as a long format integer to accommodate IDs that may exceed 10 digits.
ZoomMeetingsApi.GetMeetingRegistrantDetails
Retrieve details of a Zoom meeting registrant.
Parameters
- meeting_id (
integer
, required) The unique ID of the Zoom meeting. Use a long integer format to ensure accuracy as IDs can exceed 10 digits. - registrant_id (
string
, required) The ID of the registrant whose details are to be retrieved.
ZoomMeetingsApi.DeleteMeetingRegistrant
Remove a registrant from a Zoom meeting.
Parameters
- meeting_id (
integer
, required) The unique identifier for the Zoom meeting. - registrant_id (
string
, required) The unique identifier for the meeting registrant to be deleted. - meeting_occurrence_id (
string
, optional) The ID for a specific occurrence of a recurring Zoom meeting. Required ifregistration_type
is 2 or 3.
ZoomMeetingsApi.GetMeetingSurveyInfo
Retrieve details about a Zoom meeting survey.
Parameters
- meeting_id (
integer
, required) The unique identifier for a Zoom meeting. Should be stored as a long-format integer to accommodate IDs longer than 10 digits.
ZoomMeetingsApi.DeleteZoomMeetingSurvey
Delete a scheduled Zoom meeting survey.
Parameters
- zoom_meeting_id (
integer
, required) The ID of the scheduled Zoom meeting. Store as a long format integer due to its potential size exceeding 10 digits.
ZoomMeetingsApi.GetZoomMeetingCaptionToken
Retrieve a closed caption token for a Zoom meeting.
Parameters
- zoom_meeting_id (
integer
, required) The ID of the Zoom meeting. Store as a long format integer, since meeting IDs can exceed 10 digits. - meeting_token_type (
string
, optional) The type of meeting token to retrieve, defaults to ‘closed_caption_token’.
ZoomMeetingsApi.GetPastMeetingDetails
Fetch details of a past Zoom meeting.
Parameters
- meeting_identifier (
string
, required) The ID or UUID of the meeting. Double encode if UUID starts with ’/’ or contains ’//‘
ZoomMeetingsApi.GetPastZoomMeetings
Retrieve past instances of Zoom meetings.
Parameters
- past_meeting_id (
integer
, required) The ID of the past meeting to retrieve instances for. Must be a meeting that has concluded within the past 15 months.
ZoomMeetingsApi.GetPastMeetingParticipants
Retrieve participants from a past Zoom meeting.
Parameters
- meeting_id (
string
, required) The meeting’s ID or UUID. If UUID begins with ’/’ or contains ’//’, double-encode before using. - number_of_records_per_page (
integer
, optional) The number of participant records to return in a single API call for a past meeting. - pagination_next_page_token (
string
, optional) Token for paginating through large result sets, expires after 15 minutes.
ZoomMeetingsApi.ListPastMeetingPolls
Retrieve poll results for a past Zoom meeting.
Parameters
- meeting_id (
string
, required) The meeting’s ID or UUID. Double-encode UUIDs with ’/’ or ’//’ before making a request.
ZoomMeetingsApi.GetZoomPastMeetingQa
Retrieve Q&A from a specific past Zoom meeting.
Parameters
- zoom_meeting_identifier (
string
, required) The meeting ID or UUID. Double-encode UUIDs starting with ’/’ or containing ’//’.
ZoomMeetingsApi.ListZoomMeetingTemplates
Retrieve Zoom meeting templates for a user.
Parameters
- zoom_user_id (
string
, required) The user ID to retrieve meeting templates. Use ‘me’ for user-level apps.
ZoomMeetingsApi.ListZoomScheduledMeetings
Retrieve a Zoom user’s scheduled meetings.
Parameters
- zoom_user_identifier (
string
, required) The user’s Zoom ID, email, or ‘me’ for user-level apps to list scheduled meetings. - meeting_type (
string
, optional) Specify the type of meeting to retrieve: ‘scheduled’, ‘live’, ‘upcoming’, ‘upcoming_meetings’, or ‘previous_meetings’. - records_per_page (
integer
, optional) The number of meeting records to return in each API call. Helps paginate results for larger datasets. - pagination_next_page_token (
string
, optional) Token to paginate through large result sets. Expires in 15 minutes. - current_page_number (
integer
, optional) The current page number for the returned records when fetching scheduled meetings. - start_date (
string
, optional) Specify the start date for listing meetings. Format should be ‘YYYY-MM-DD’. - end_date (
string
, optional) The end date for retrieving scheduled meetings. Format should be YYYY-MM-DD. - meeting_timezone (
string
, optional) Specify the timezone for the ‘from’ and ‘to’ date values. Refer to the Zoom API timezone list for supported formats.
ZoomMeetingsApi.ListUpcomingZoomMeetings
Fetches upcoming Zoom meetings for a user.
Parameters
- zoom_user_identifier (
string
, required) The Zoom user’s ID or email. Use ‘me’ for user-level apps to refer to the current user.
ZoomMeetingsApi.GetUserAudioConferences
Retrieve a list of user’s personal audio conference accounts.
Parameters
- user_identifier (
string
, required) The user’s ID or email. Use ‘me’ for user-level apps to represent the current user.
ZoomMeetingsApi.GetZoomUserActivityLogs
Retrieve Zoom user sign in and sign out activity reports.
Parameters
- start_date (
string
, optional) Start date for the activity logs report, in YYYY-MM-DD format. Must be within the last six months. - end_date_for_activity_logs (
string
, optional) The end date up to which to view the activity logs report. Must specify within the last six months. - records_per_page (
integer
, optional) Specifies the number of activity log records to retrieve in one API call. Adjust for batch processing of data. - pagination_next_page_token (
string
, optional) Token used for paginating through large sets of user activity logs. Use the token received from the previous response to access the next set of results.
ZoomMeetingsApi.GetZoomBillingReport
Retrieve Zoom account department billing reports.
Parameters
This tool does not take any parameters.
ZoomMeetingsApi.FetchZoomBillingInvoices
Retrieve billing invoices reports for a specific billing period.
Parameters
- billing_report_id (
string
, required) Unique identifier for the billing report. Acquire this ID from the response of the Get Billing Reports API.
ZoomMeetingsApi.GetZoomCloudRecordingReport
Retrieve Zoom cloud recording usage report for a date range.
Parameters
- start_date (
string
, required) Start date in ‘yyyy-mm-dd’ format. It must be up to 30 days before the end date and within the past six months. - end_date (
string
, required) End date in ‘yyyy-mm-dd’ format. Must be within one month of the start date and within the last six months. - group_identifier (
string
, optional) The unique string ID of the group to retrieve cloud recording reports for. Obtainable via the List groups API.
ZoomMeetingsApi.GetZoomDailyReport
Retrieve daily Zoom usage statistics for account-wide overview.
Parameters
- report_year (
integer
, optional) The year for which the Zoom usage report is requested. Must be a valid integer year. - report_month (
integer
, optional) The month (1-12) for the report. Specify as an integer. - zoom_group_id (
string
, optional) The ID of the Zoom group for which you want to retrieve the usage report. Use the ‘List groups’ API to find the ID. The report will only include users in this group.
ZoomMeetingsApi.GetZoomHistoryMeetings
Retrieve a list of historical Zoom meetings and webinars.
Parameters
- start_date (
string
, required) The start date for the report inyyyy-mm-dd
format. Ensure the date range is within one month. - end_date (
string
, required) The end date for the query inyyyy-mm-dd
format. It defines the end of the one-month date range for the report. - query_date_type (
string
, optional) Specifies whether to query by meeting’s start time or end time. Use ‘start_time’ for start time and ‘end_time’ for end time. Defaults to ‘start_time’. - query_meeting_type (
string
, optional) Specifies the type of meeting to query: ‘all’ for both meetings and webinars, ‘meeting’ for meetings only, and ‘webinar’ for webinars only. - report_type (
string
, optional) Specify the type of report to query: all, poll, survey, qa, resource, or reaction. - search_keywords (
string
, optional) Keywords for the meeting topic or meeting ID to filter the historical Zoom meetings and webinars. - number_of_records_per_call (
integer
, optional) The maximum number of records to return in a single API call. Helps manage large data sets. - pagination_next_page_token (
string
, optional) Token for pagination of large result sets. Expires in 15 minutes. - group_identifier (
string
, optional) The unique group ID to query members. Use the List groups API to obtain this ID. Only includes users from the specified group. - query_meeting_features (
string
, optional) Comma-separated list of meeting features to filter historical meetings. Options include features likescreen_sharing
,video_on
,poll
, etc.
ZoomMeetingsApi.GetMeetingActivityLogs
Retrieve a list of meeting activity logs from Zoom.
Parameters
- start_date (
string
, required) The start date for the report in ‘yyyy-MM-dd’ format. Ensure the range with ‘to’ is only one month. - end_date (
string
, required) The end date for fetching meeting activity logs in ‘yyyy-MM-dd’ format. Must be within one month of the start date. - activity_type (
string
, required) Specify the type of activity to filter logs. Options: All Activities, Meeting Created, Meeting Started, User Join, User Left, Remote Control, In-Meeting Chat, Meeting Ended. - number_of_records_per_call (
integer
, optional) Specify the number of records to be returned in a single API call. Adjust according to data needs and rate limits. - pagination_token (
string
, optional) Token for paginating through large sets of results. Expires in 15 minutes. - meeting_number (
string
, optional) The unique identifier for the Zoom meeting. Required to fetch activity logs. - operator_name_or_email (
string
, optional) An operator’s name or email used to filter the meeting activity logs.
ZoomMeetingsApi.GetZoomMeetingReport
Retrieve a detailed report for a past Zoom meeting.
Parameters
- zoom_meeting_identifier (
string
, required) The meeting’s ID or UUID. Double encode UUIDs starting with ’/’ or containing ’//’.
ZoomMeetingsApi.GetZoomMeetingParticipantsReport
Get a report of past Zoom meeting participants.
Parameters
- meeting_identifier (
string
, required) The ID or UUID of the Zoom meeting. For meeting UUIDs starting with ’/’ or containing ’//’, double-encode before requesting. - records_per_page (
integer
, optional) The number of participant records to return in a single API call. - pagination_next_page_token (
string
, optional) Token for fetching the next page of large result sets. Expires in 15 minutes. - include_registrant_id_in_report (
string
, optional) Include ‘registrant_id’ in the response to see registrant ID attributes.
ZoomMeetingsApi.GetZoomMeetingPollReport
Fetches a report of poll results for a past Zoom meeting.
Parameters
- zoom_meeting_identifier (
string
, required) The meeting’s ID or UUID. If the UUID begins with ’/’ or contains ’//’, double encode it.
ZoomMeetingsApi.ZoomReportMeetingQa
Retrieve a report on past Zoom meeting Q&A sessions.
Parameters
- meeting_identifier (
string
, required) Meeting’s ID or UUID. Double-encode UUIDs if they begin with ’/’ or contain ’//’.
ZoomMeetingsApi.GetZoomMeetingSurveyReport
Retrieve report details of a Zoom meeting survey.
Parameters
- meeting_identifier (
string
, required) The ID or UUID of the Zoom meeting. Double-encode UUIDs with ’/’ or ’//’ characters.
ZoomMeetingsApi.RetrieveZoomOperationLogs
Retrieve Zoom operation logs for auditing admin and user activity.
Parameters
- start_date_for_report (
string
, required) Start date for the report in ‘yyyy-mm-dd’ or ‘yyyy-MM-dd HH:mm’ format. The report covers a one-month period. - end_date (
string
, required) End date for the report in ‘yyyy-mm-dd’ or ‘yyyy-MM-dd HH:mm’ format, marking the close of the desired data range. - records_per_page (
integer
, optional) Specify the number of records to return in a single call, optimizing pagination for large datasets. - pagination_next_page_token (
string
, optional) Token for paginating large result sets in operation logs. Expires in 15 minutes. - filter_by_category_type (
string
, optional) Optional argument to filter the response by specific category type, such as ‘all’, ‘user’, or ‘recording’.
ZoomMeetingsApi.GetZoomTelephoneReport
Retrieve Zoom telephone report for specified meetings.
Parameters
- start_date (
string
, required) Start date for the report in ‘yyyy-mm-dd’ format. The date range should cover only one month. - end_date (
string
, required) The end date for the report in ‘yyyy-mm-dd’ format. It should be within one month of the start date. - audio_type (
string
, optional) Specify the type of audio. Options: ‘1’ for Toll-free Call-in & Call-out, ‘2’ for Toll, or ‘3’ for SIP Connected Audio. - date_query_type (
string
, optional) Specifies the date type for the report query. Options: ‘start_time’, ‘end_time’, ‘meeting_start_time’, or ‘meeting_end_time’. Defaults to ‘start_time’. - records_per_page (
integer
, optional) Specify the number of records to return in a single API call. Useful for managing large data sets efficiently. - pagination_page_number (
integer
, optional) Deprecated. Use the page number for current records pagination unless using ‘meeting_start_time’ or ‘meeting_end_time’. - pagination_next_page_token (
string
, optional) Token for retrieving the next set of results in large data sets. Expires in 15 minutes.
ZoomMeetingsApi.ListZoomUpcomingEvents
Retrieve upcoming Zoom meetings and webinars.
Parameters
- start_date (
string
, required) Start date in ‘yyyy-mm-dd’ format. The date range with ‘end_date’ should be within one month. - end_date (
string
, required) The end date for the report in ‘yyyy-mm-dd’ format, within one month of the start date. - records_per_page (
integer
, optional) Number of records to return in a single API call, used for paginating results. - pagination_token (
string
, optional) Token for paginating through large result sets, expires in 15 minutes. - event_type_to_query (
string
, optional) Specify the type of Zoom event to query: ‘meeting’, ‘webinar’, or ‘all’. Defaults to ‘all’. - group_identifier (
string
, optional) The ID of the group for filtering events to include only those where the host is a member. Obtainable via the Zoom ‘List groups’ API.
ZoomMeetingsApi.GetZoomHostReport
Retrieve Zoom host activity reports for a specified period.
Parameters
- start_date (
string
, required) Start date of the report in ‘yyyy-mm-dd’ format. The date range for the report must be within one month. - end_date (
string
, required) End date for the report in ‘yyyy-mm-dd’ format. Must be at most one month after the ‘from’ date. - host_activity_type (
string
, optional) Specify ‘active’ for active hosts or ‘inactive’ for inactive hosts. - record_count_per_api_call (
integer
, optional) Specify the number of records to return in each API call, controlling the data amount per request. - current_page_number (
integer
, optional) The page number to retrieve for the host activity report. - next_page_pagination_token (
string
, optional) Token for paginating large result sets in host reports, with a 15-minute expiration. - zoom_group_id (
string
, optional) The ID for the group. Use the List groups API to obtain this, as the response includes only users in the specified group.
ZoomMeetingsApi.GetZoomMeetingReports
Retrieve details of past Zoom meetings and webinars.
Parameters
- report_start_date (
string
, required) Start date for the report in ‘yyyy-mm-dd’ format. Ensure the date range with ‘to’ is within one month. - end_date (
string
, required) The end date of the report in ‘yyyy-mm-dd’ format. The date range should be within one month of the start date and must fall within the past six months. - zoom_user_identifier (
string
, required) The user ID or email address to identify the user. Use ‘me’ for user-level apps. - number_of_records_per_page (
integer
, optional) The number of records to return in a single API call. Determines the page size for report data retrieval. - pagination_token (
string
, optional) Token to paginate through large result sets, expiring after 15 minutes. - meeting_type (
string
, optional) Specify the type of past meetings to query. Options: ‘past’ for all past meetings, ‘pastOne’ for a single past user meeting, ‘pastJoined’ for all past meetings the account’s users hosted or joined.
ZoomMeetingsApi.GetZoomWebinarReport
Retrieve details of a past Zoom webinar.
Parameters
- webinar_identifier (
string
, required) The ID or UUID of the webinar. Use webinar ID for latest instance or UUID, which may need double encoding if it starts with ’/’ or contains ’//’.
ZoomMeetingsApi.GetWebinarParticipantReport
Retrieve detailed report on webinar attendees.
Parameters
- webinar_identifier (
string
, required) The webinar’s ID or UUID. Double-encode UUIDs starting with ’/’ or containing ’//’. - number_of_records_per_call (
integer
, optional) Specifies the number of records to return in a single API call for webinar participant reports. - pagination_token (
string
, optional) Token for paginating through large sets of webinar participant data. Expires in 15 minutes. - include_registrant_id (
string
, optional) Specify if the registrant’s unique ID should be included in the webinar participant report.
ZoomMeetingsApi.RetrieveZoomWebinarPollsReport
Retrieve report on past webinar polls for a Zoom webinar.
Parameters
- webinar_id (
string
, required) The webinar’s ID or UUID. If using a UUID starting with ’/’ or containing ’//’, double-encode it.
ZoomMeetingsApi.GetZoomWebinarQaReport
Retrieve report on questions and answers from Zoom webinars.
Parameters
- webinar_identifier (
string
, required) The ID or UUID of the webinar. Double-encode if UUID starts with ’/’ or contains ’//’.
ZoomMeetingsApi.GetZoomWebinarSurveyReport
Retrieve a report on past webinar survey results.
Parameters
- zoom_webinar_id (
string
, required) The ID or UUID of the webinar. If using a UUID starting with ’/’ or containing ’//’, double-encode it.
ZoomMeetingsApi.ListSipPhones
Retrieve a list of SIP phones on a Zoom account.
Parameters
- user_identifier (
string
, optional) A user’s username or email to filter SIP phone integrations for that specific user. - records_per_page (
integer
, optional) The number of SIP phone records to return in a single API call. Adjust for desired page size. - pagination_token (
string
, optional) Token for paginating through large SIP phone result sets. Expires in 15 minutes.
ZoomMeetingsApi.DeleteZoomSipPhone
Delete a SIP phone from a Zoom account.
Parameters
- sip_phone_id (
string
, required) The unique identifier for the SIP phone to be deleted, obtainable from the List SIP phones API.
ZoomMeetingsApi.GetTspInfo
Retrieve Telephony Service Provider (TSP) info for an account.
Parameters
This tool does not take any parameters.
ZoomMeetingsApi.ListUserTspAccounts
Retrieve a user’s TSP accounts on Zoom.
Parameters
- user_identifier (
string
, required) The user ID or email address of the user. Use ‘me’ for user-level apps.
ZoomMeetingsApi.GetUserTspDetails
Retrieve TSP account details for a specific Zoom user.
Parameters
- user_identifier (
string
, required) The user ID or email address of the user. Use ‘me’ for user-level apps. - tsp_account_id (
string
, required) The ID of the TSP account to retrieve details for. It can either be ‘1’ or ‘2’.
ZoomMeetingsApi.DeleteUserTspAccount
Delete a user’s Telephony Service Provider account.
Parameters
- user_identifier (
string
, required) Specify the user’s ID or email. Use ‘me’ for user-level apps to identify the current user. - tsp_account_id (
string
, required) The ID of the TSP account to be deleted, specified as a string.
ZoomMeetingsApi.ListZoomTrackingFields
Retrieve all tracking fields from your Zoom account.
Parameters
This tool does not take any parameters.
ZoomMeetingsApi.GetZoomTrackingFieldInfo
Retrieve details about a specific Zoom tracking field.
Parameters
- tracking_field_id (
string
, required) The unique identifier for the Zoom tracking field you want to retrieve information about. Must be a string.
ZoomMeetingsApi.DeleteZoomTrackingField
Delete a tracking field in Zoom.
Parameters
- tracking_field_id (
string
, required) The unique identifier of the tracking field to be deleted in Zoom. Required for the deletion process.
ZoomMeetingsApi.DeleteWebinarChatMessage
Delete a message from a live Zoom webinar by ID.
Parameters
- webinar_id (
integer
, required) The unique ID of the webinar from which to delete the chat message. This should be an integer. - webinar_chat_message_id (
string
, required) The unique identifier for the webinar chat message to delete, encoded in base64 format. - webinar_chat_file_uuids (
string
, optional) Comma-separated base64-encoded UUIDs for the live webinar chat files to identify specific chat data files.
ZoomMeetingsApi.GetWebinarAbsentees
Retrieve a list of absentees from a Zoom webinar.
Parameters
- webinar_id_or_uuid (
string
, required) The webinar’s ID or UUID. If using a UUID starting with ’/’ or containing ’//’, double encode it. - webinar_occurrence_id (
string
, optional) The ID of the specific webinar occurrence to retrieve absentees for. - number_of_records_per_call (
integer
, optional) The number of records to return in a single API call. - pagination_next_page_token (
string
, optional) Token for pagination to access the next set of results. Expires in 15 minutes.
ZoomMeetingsApi.ListPastWebinars
Retrieve details of past Zoom webinar instances.
Parameters
- webinar_id (
integer
, required) The unique identifier for a specific Zoom webinar. It should be an integer value.
ZoomMeetingsApi.RetrieveWebinarParticipants
Retrieve participants of a past Zoom webinar.
Parameters
- webinar_id (
string
, required) The ID or UUID of the webinar. If it starts with ’/’ or contains ’//’ ensure it is double encoded. - number_of_records_per_call (
integer
, optional) Specify the number of participant records to retrieve in a single API call. This helps control the size of each data page. - pagination_token_for_participants (
string
, optional) Token to fetch the next page of webinar participants. Expires in 15 minutes.
ZoomMeetingsApi.GetWebinarPollResults
Retrieve poll results from a past webinar.
Parameters
- webinar_id (
string
, required) The ID or UUID of the webinar. Use a double-encoded UUID if it contains ’/’ or ’//’.
ZoomMeetingsApi.ListWebinarQa
Retrieve Q&A from a past webinar on Zoom.
Parameters
- webinar_identifier (
string
, required) The ID or UUID of the webinar. If using a UUID with ’/’ or ’//’, double encode before use.
ZoomMeetingsApi.ListZoomWebinarTemplates
Retrieve a list of a user’s Zoom webinar templates.
Parameters
- user_identifier (
string
, required) The user’s unique ID. Use ‘me’ for user-level apps to identify the current user.
ZoomMeetingsApi.ListZoomWebinars
Retrieve all scheduled webinars for a Zoom user.
Parameters
- user_identifier (
string
, required) The user’s ID or email address. For user-level apps, use ‘me’ to refer to the authenticated user. - webinar_type (
string
, optional) Specify the type of webinars to list. Choose ‘scheduled’ for unexpired, live, and upcoming scheduled webinars, or ‘upcoming’ for all upcoming webinars, including live ones. - webinar_list_page_size (
integer
, optional) The number of webinar records to return in a single API call for the Zoom user. Adjust for pagination needs. - next_page_token (
integer
, optional) Use this token for pagination instead of the deprecated page_number field.
ZoomMeetingsApi.GetZoomWebinarDetails
Retrieve details for a scheduled Zoom webinar.
Parameters
- webinar_id (
string
, required) The Zoom webinar’s ID or universally unique identifier (UUID) to fetch the specific webinar details. - recurring_webinar_occurrence_id (
string
, optional) Unique identifier for a specific occurrence of a recurring webinar. Used to retrieve details for that occurrence. - show_previous_occurrences (
boolean
, optional) Set to true to view details of all previous occurrences of a recurring webinar.
ZoomMeetingsApi.DeleteWebinar
Delete a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier for the Zoom webinar to be deleted. This is required to specify which webinar should be removed. - webinar_occurrence_id (
string
, optional) The ID of the specific webinar occurrence to delete. Required for webinars with multiple occurrences. - send_cancellation_notifications (
boolean
, optional) Set to true to email panelists and registrants about webinar cancellation. Defaults to false.
ZoomMeetingsApi.GetWebinarBrandingInfo
Retrieve webinar session branding information.
Parameters
- webinar_id (
integer
, required) The unique ID of the webinar for which to retrieve session branding information. This is required and must be a valid integer.
ZoomMeetingsApi.DeleteWebinarNameTag
Delete a Zoom webinar’s branding name tag.
Parameters
- webinar_id (
integer
, required) The unique identifier for the Zoom webinar from which the branding name tag should be deleted. - name_tag_ids (
string
, optional) Comma-separated list of name tag IDs to delete for a webinar.
ZoomMeetingsApi.DeleteWebinarVirtualBackground
Delete a webinar’s virtual background.
Parameters
- webinar_id (
integer
, required) The unique ID of the webinar for which the virtual background should be deleted. This ID is required. - virtual_background_file_ids (
string
, optional) Provide a comma-separated list of virtual background file IDs to be deleted from the webinar.
ZoomMeetingsApi.SetWebinarVirtualBackground
Set a webinar’s virtual background branding.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar to update the virtual background branding. - virtual_background_file_id (
string
, optional) The ID of the virtual background file to update for the webinar. - set_default_virtual_background_for_all_panelists (
boolean
, optional) Whether to set the virtual background as the default for all panelists, including those without a current default background.
ZoomMeetingsApi.RemoveWebinarBrandingWallpaper
Remove a webinar’s branding wallpaper file.
Parameters
- webinar_id (
integer
, required) The unique identifier of the webinar whose branding wallpaper you want to delete.
ZoomMeetingsApi.GetWebinarLiveStreamingJoinToken
Retrieve a Zoom webinar’s join token for live streaming.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar. This is required to retrieve the live streaming join token.
ZoomMeetingsApi.GetWebinarArchiveToken
Get a webinar’s archive token for local archiving.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar whose archive token is to be retrieved. This ID is necessary to obtain access to the webinar’s raw media streams.
ZoomMeetingsApi.GetZoomWebinarLocalRecordingToken
Retrieve Zoom webinar join token for local recording.
Parameters
- webinar_id (
integer
, required) The unique identifier for the Zoom webinar to retrieve the join token for local recording.
ZoomMeetingsApi.GetWebinarLivestreamDetails
Retrieve live stream details for a Zoom webinar.
Parameters
- webinar_unique_id (
string
, required) The unique identifier for the webinar to retrieve live stream details.
ZoomMeetingsApi.ListZoomWebinarPanelists
Retrieve a list of panelists for a specific Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier for the Zoom webinar.
ZoomMeetingsApi.RemoveWebinarPanelists
Remove all panelists from a specified Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar from which you want to remove all panelists. This should be an integer.
ZoomMeetingsApi.RemoveWebinarPanelist
Remove a panelist from a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar from which the panelist will be removed. This should be an integer value. - panelist_identifier (
string
, required) The ID or email of the panelist to remove from the webinar. Obtain from the List Panelists API.
ZoomMeetingsApi.ListWebinarPollsZoom
Retrieve all polls from a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The ID of the Zoom webinar for which to retrieve polls. - query_anonymous_polls (
boolean
, optional) Set to true to query polls with the Anonymous option enabled. Set to false to exclude them.
ZoomMeetingsApi.GetWebinarPollDetails
Fetches details of a webinar poll from Zoom.
Parameters
- webinar_id (
integer
, required) The unique identifier of the webinar for which the poll details are being requested. This is required to fetch the poll data. - poll_id (
string
, required) The unique identifier for the specific webinar poll. This is required to fetch the poll details.
ZoomMeetingsApi.DeleteWebinarPoll
Delete a poll from a specific webinar on Zoom.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar from which the poll should be deleted. - poll_id (
string
, required) The unique identifier for the poll to be deleted from the webinar.
ZoomMeetingsApi.ListZoomWebinarRegistrants
Retrieve a list of registrants for a specified Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique ID of the webinar for which registrants are being retrieved. This is required for the request. - webinar_occurrence_id (
string
, optional) The unique identifier for a specific occurrence of the webinar. Use this ID to specify which instance of a recurring webinar you are querying. - registrant_status (
string
, optional) Filter registrants by status: ‘pending’ for those awaiting approval, ‘approved’ for accepted registrants, or ‘denied’ for rejected applications. - registrants_tracking_source_id (
string
, optional) The tracking source ID for webinar registrants, indicating the registration page location. - number_of_records_per_call (
integer
, optional) The number of registrant records to return within a single API call. This helps control the size of the response. - deprecated_page_number (
integer
, optional) Deprecated. This field will be deprecated and is no longer supported in future releases. Use ‘next_page_token’ for pagination instead. - pagination_next_page_token (
string
, optional) Token for paginating through webinar registrant results when the available set exceeds the current page size. Expires in 15 minutes.
ZoomMeetingsApi.GetWebinarRegistrationQuestions
Retrieve registration questions for webinar attendees.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar. It is required to retrieve the registration questions.
ZoomMeetingsApi.GetWebinarRegistrantDetails
Retrieve details for a specific Zoom webinar registrant.
Parameters
- webinar_id (
integer
, required) The unique ID of the webinar for which registrant details are needed. - registrant_id (
string
, required) The unique identifier for the webinar registrant. Required to fetch the registrant’s details. - webinar_occurrence_id (
string
, optional) The unique identifier for a specific occurrence of the webinar to fetch registrant details.
ZoomMeetingsApi.RemoveWebinarRegistrant
Remove a registrant from a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier for the specific Zoom webinar from which the registrant will be removed. - registrant_id (
string
, required) The unique identifier of the registrant to be removed from the webinar. - webinar_occurrence_id (
string
, optional) The unique identifier for the specific webinar occurrence.
ZoomMeetingsApi.GetWebinarSurveyInfo
Retrieve details about a Zoom webinar survey.
Parameters
- webinar_id (
integer
, required) The unique ID of the Zoom webinar for which you want to retrieve survey details.
ZoomMeetingsApi.DeleteZoomWebinarSurvey
Delete a Zoom webinar survey.
Parameters
- webinar_id (
integer
, required) The unique identifier for the webinar to delete its survey. This must be a valid integer ID from Zoom.
ZoomMeetingsApi.GetWebinarCaptionToken
Retrieve a closed caption token for a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The ID of the webinar for which the closed caption token is requested. - webinar_token_type (
string
, optional) The type of token needed for the webinar. Only ‘closed_caption_token’ is supported for third-party closed caption API access. Defaults to ‘closed_caption_token’.
ZoomMeetingsApi.GetWebinarTrackingSources
List tracking sources for a Zoom webinar.
Parameters
- webinar_id (
integer
, required) The unique identifier of the Zoom webinar for which you want to list tracking sources. Ensure the webinar has registration enabled.