AptlyStar

Zoom

Create and manage Zoom meetings and recordings

Zoom is a leading cloud-based communications platform for video meetings, webinars, and online collaboration. It allows users and organizations to easily schedule, host, and manage meetings, providing tools for screen sharing, chat, recordings, and more.

With Zoom, you can:

  • Schedule and manage meetings: Create instant or scheduled meetings, including recurring events
  • Configure meeting options: Set meeting passwords, enable waiting rooms, and control participant video/audio
  • Send invitations and share details: Retrieve meeting invitations and information for easy sharing
  • Get and update meeting data: Access meeting details, modify existing meetings, and manage settings programmatically

In Aptlystar, the Zoom integration empowers your agents to automate scheduling and meeting management. Use tool actions to:

  • Programmatically create new meetings with custom settings
  • List all meetings for a specific user (or yourself)
  • Retrieve details or invitations for any meeting
  • Update or delete existing meetings directly from your automations

To connect to Zoom, drop the Zoom block and click Connect to authenticate with your Zoom account. Once connected, you can use the Zoom tools to create, list, update, and delete Zoom meetings. At any given time, you can disconnect your Zoom account by clicking Disconnect in Settings > Integrations, and access to your Zoom account will be revoked immediatley.

These capabilities let you streamline remote collaboration, automate recurring video sessions, and manage your organization's Zoom environment all as part of your workflows.

Usage Instructions

Integrate Zoom into workflows. Create, list, update, and delete Zoom meetings. Get meeting details, invitations, recordings, and participants. Manage cloud recordings programmatically.

Tools

zoom_create_meeting

Create a new Zoom meeting

Input

ParameterTypeRequiredDescription
userIdstringYesThe user ID or email address (e.g., "me", "user@example.com", or "AbcDefGHi"). Use "me" for the authenticated user.
topicstringYesMeeting topic (e.g., "Weekly Team Standup" or "Project Review")
typenumberNoMeeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time
startTimestringNoMeeting start time in ISO 8601 format (e.g., 2025-06-03T10:00:00Z)
durationnumberNoMeeting duration in minutes (e.g., 30, 60, 90)
timezonestringNoTimezone for the meeting (e.g., America/Los_Angeles)
passwordstringNoMeeting password
agendastringNoMeeting agenda or description text
hostVideobooleanNoStart with host video on
participantVideobooleanNoStart with participant video on
joinBeforeHostbooleanNoAllow participants to join before host
muteUponEntrybooleanNoMute participants upon entry
waitingRoombooleanNoEnable waiting room
autoRecordingstringNoAuto recording setting: local, cloud, or none

Output

ParameterTypeDescription
meetingobjectThe created meeting with all its properties
↳ idnumberMeeting ID
↳ uuidstringMeeting UUID
↳ host_idstringHost user ID
↳ host_emailstringHost email address
↳ topicstringMeeting topic
↳ typenumberMeeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time
↳ statusstringMeeting status (e.g., waiting, started)
↳ start_timestringStart time in ISO 8601 format
↳ durationnumberDuration in minutes
↳ timezonestringTimezone (e.g., America/Los_Angeles)
↳ agendastringMeeting agenda
↳ created_atstringCreation timestamp in ISO 8601 format
↳ start_urlstringURL for host to start the meeting
↳ join_urlstringURL for participants to join the meeting
↳ passwordstringMeeting password
↳ h323_passwordstringH.323/SIP room system password
↳ pstn_passwordstringPSTN password for phone dial-in
↳ encrypted_passwordstringEncrypted password for joining
↳ settingsobjectMeeting settings
↳ host_videobooleanStart with host video on
↳ participant_videobooleanStart with participant video on
↳ join_before_hostbooleanAllow participants to join before host
↳ mute_upon_entrybooleanMute participants upon entry
↳ watermarkbooleanAdd watermark when viewing shared screen
↳ audiostringAudio options: both, telephony, or voip
↳ auto_recordingstringAuto recording: local, cloud, or none
↳ waiting_roombooleanEnable waiting room
↳ meeting_authenticationbooleanRequire meeting authentication
↳ approval_typenumberApproval type: 0=auto, 1=manual, 2=none
↳ recurrenceobjectRecurrence settings for recurring meetings
↳ typenumberRecurrence type: 1=daily, 2=weekly, 3=monthly
↳ repeat_intervalnumberInterval between recurring meetings
↳ weekly_daysstringDays of week for weekly recurrence (1-7, comma-separated)
↳ monthly_daynumberDay of month for monthly recurrence
↳ monthly_weeknumberWeek of month for monthly recurrence
↳ monthly_week_daynumberDay of week for monthly recurrence
↳ end_timesnumberNumber of occurrences
↳ end_date_timestringEnd date time in ISO 8601 format
↳ occurrencesarrayMeeting occurrences for recurring meetings
↳ occurrence_idstringOccurrence ID
↳ start_timestringStart time in ISO 8601 format
↳ durationnumberDuration in minutes
↳ statusstringOccurrence status

zoom_list_meetings

List all meetings for a Zoom user

Input

ParameterTypeRequiredDescription
userIdstringYesThe user ID or email address (e.g., "me", "user@example.com", or "AbcDefGHi"). Use "me" for the authenticated user.
typestringNoMeeting type filter: scheduled, live, upcoming, upcoming_meetings, or previous_meetings
pageSizenumberNoNumber of records per page, 1-300 (e.g., 30, 50, 100)
nextPageTokenstringNoToken for pagination to get next page of results

Output

ParameterTypeDescription
meetingsarrayList of meetings
↳ idnumberMeeting ID
↳ uuidstringMeeting UUID
↳ host_idstringHost user ID
↳ topicstringMeeting topic
↳ typenumberMeeting type
↳ start_timestringStart time in ISO 8601 format
↳ durationnumberDuration in minutes
↳ timezonestringTimezone
↳ agendastringMeeting agenda
↳ created_atstringCreation timestamp
↳ join_urlstringURL for participants to join
pageInfoobjectPagination information
↳ pageCountnumberTotal number of pages
↳ pageNumbernumberCurrent page number
↳ pageSizenumberNumber of records per page
↳ totalRecordsnumberTotal number of records
↳ nextPageTokenstringToken for next page of results

zoom_get_meeting

Get details of a specific Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID (e.g., "1234567890" or "85746065432")
occurrenceIdstringNoOccurrence ID for recurring meetings
showPreviousOccurrencesbooleanNoShow previous occurrences for recurring meetings

Output

ParameterTypeDescription
meetingobjectThe meeting details
↳ idnumberMeeting ID
↳ uuidstringMeeting UUID
↳ host_idstringHost user ID
↳ host_emailstringHost email address
↳ topicstringMeeting topic
↳ typenumberMeeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time
↳ statusstringMeeting status (e.g., waiting, started)
↳ start_timestringStart time in ISO 8601 format
↳ durationnumberDuration in minutes
↳ timezonestringTimezone (e.g., America/Los_Angeles)
↳ agendastringMeeting agenda
↳ created_atstringCreation timestamp in ISO 8601 format
↳ start_urlstringURL for host to start the meeting
↳ join_urlstringURL for participants to join the meeting
↳ passwordstringMeeting password
↳ h323_passwordstringH.323/SIP room system password
↳ pstn_passwordstringPSTN password for phone dial-in
↳ encrypted_passwordstringEncrypted password for joining
↳ settingsobjectMeeting settings
↳ host_videobooleanStart with host video on
↳ participant_videobooleanStart with participant video on
↳ join_before_hostbooleanAllow participants to join before host
↳ mute_upon_entrybooleanMute participants upon entry
↳ watermarkbooleanAdd watermark when viewing shared screen
↳ audiostringAudio options: both, telephony, or voip
↳ auto_recordingstringAuto recording: local, cloud, or none
↳ waiting_roombooleanEnable waiting room
↳ meeting_authenticationbooleanRequire meeting authentication
↳ approval_typenumberApproval type: 0=auto, 1=manual, 2=none
↳ recurrenceobjectRecurrence settings for recurring meetings
↳ typenumberRecurrence type: 1=daily, 2=weekly, 3=monthly
↳ repeat_intervalnumberInterval between recurring meetings
↳ weekly_daysstringDays of week for weekly recurrence (1-7, comma-separated)
↳ monthly_daynumberDay of month for monthly recurrence
↳ monthly_weeknumberWeek of month for monthly recurrence
↳ monthly_week_daynumberDay of week for monthly recurrence
↳ end_timesnumberNumber of occurrences
↳ end_date_timestringEnd date time in ISO 8601 format
↳ occurrencesarrayMeeting occurrences for recurring meetings
↳ occurrence_idstringOccurrence ID
↳ start_timestringStart time in ISO 8601 format
↳ durationnumberDuration in minutes
↳ statusstringOccurrence status

zoom_update_meeting

Update an existing Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID to update (e.g., "1234567890" or "85746065432")
topicstringNoMeeting topic (e.g., "Weekly Team Standup" or "Project Review")
typenumberNoMeeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time
startTimestringNoMeeting start time in ISO 8601 format (e.g., 2025-06-03T10:00:00Z)
durationnumberNoMeeting duration in minutes (e.g., 30, 60, 90)
timezonestringNoTimezone for the meeting (e.g., America/Los_Angeles)
passwordstringNoMeeting password
agendastringNoMeeting agenda or description text
hostVideobooleanNoStart with host video on
participantVideobooleanNoStart with participant video on
joinBeforeHostbooleanNoAllow participants to join before host
muteUponEntrybooleanNoMute participants upon entry
waitingRoombooleanNoEnable waiting room
autoRecordingstringNoAuto recording setting: local, cloud, or none

Output

ParameterTypeDescription
successbooleanWhether the meeting was updated successfully

zoom_delete_meeting

Delete or cancel a Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID to delete (e.g., "1234567890" or "85746065432")
occurrenceIdstringNoOccurrence ID for deleting a specific occurrence of a recurring meeting
scheduleForReminderbooleanNoSend cancellation reminder email to registrants
cancelMeetingReminderbooleanNoSend cancellation email to registrants and alternative hosts

Output

ParameterTypeDescription
successbooleanWhether the meeting was deleted successfully

zoom_get_meeting_invitation

Get the meeting invitation text for a Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID (e.g., "1234567890" or "85746065432")

Output

ParameterTypeDescription
invitationstringThe meeting invitation text

zoom_list_recordings

List all cloud recordings for a Zoom user

Input

ParameterTypeRequiredDescription
userIdstringYesThe user ID or email address (e.g., "me", "user@example.com", or "AbcDefGHi"). Use "me" for the authenticated user.
fromstringNoStart date in yyyy-mm-dd format (within last 6 months)
tostringNoEnd date in yyyy-mm-dd format
pageSizenumberNoNumber of records per page, 1-300 (e.g., 30, 50, 100)
nextPageTokenstringNoToken for pagination to get next page of results
trashbooleanNoSet to true to list recordings from trash

Output

ParameterTypeDescription
recordingsarrayList of recordings
↳ uuidstringMeeting UUID
↳ idnumberMeeting ID
↳ account_idstringAccount ID
↳ host_idstringHost user ID
↳ topicstringMeeting topic
↳ typenumberMeeting type
↳ start_timestringMeeting start time
↳ durationnumberMeeting duration in minutes
↳ total_sizenumberTotal size of all recordings in bytes
↳ recording_countnumberNumber of recording files
↳ share_urlstringURL to share recordings
↳ recording_filesarrayList of recording files
↳ idstringRecording file ID
↳ meeting_idstringMeeting ID associated with the recording
↳ recording_startstringStart time of the recording
↳ recording_endstringEnd time of the recording
↳ file_typestringType of recording file (MP4, M4A, etc.)
↳ file_extensionstringFile extension
↳ file_sizenumberFile size in bytes
↳ play_urlstringURL to play the recording
↳ download_urlstringURL to download the recording
↳ statusstringRecording status
↳ recording_typestringType of recording (shared_screen, audio_only, etc.)
pageInfoobjectPagination information
↳ fromstringStart date of query range
↳ tostringEnd date of query range
↳ pageSizenumberNumber of records per page
↳ totalRecordsnumberTotal number of records
↳ nextPageTokenstringToken for next page of results

zoom_get_meeting_recordings

Get all recordings for a specific Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID or meeting UUID (e.g., "1234567890" or "4444AAABBBccccc12345==")
includeFolderItemsbooleanNoInclude items within a folder
ttlnumberNoTime to live for download URLs in seconds (max 604800)
downloadFilesbooleanNoDownload recording files into file outputs

Output

ParameterTypeDescription
recordingobjectThe meeting recording with all files
↳ uuidstringMeeting UUID
↳ idnumberMeeting ID
↳ account_idstringAccount ID
↳ host_idstringHost user ID
↳ topicstringMeeting topic
↳ typenumberMeeting type
↳ start_timestringMeeting start time
↳ durationnumberMeeting duration in minutes
↳ total_sizenumberTotal size of all recordings in bytes
↳ recording_countnumberNumber of recording files
↳ share_urlstringURL to share recordings
↳ recording_filesarrayList of recording files
↳ idstringRecording file ID
↳ meeting_idstringMeeting ID associated with the recording
↳ recording_startstringStart time of the recording
↳ recording_endstringEnd time of the recording
↳ file_typestringType of recording file (MP4, M4A, etc.)
↳ file_extensionstringFile extension
↳ file_sizenumberFile size in bytes
↳ play_urlstringURL to play the recording
↳ download_urlstringURL to download the recording
↳ statusstringRecording status
↳ recording_typestringType of recording (shared_screen, audio_only, etc.)
filesfile[]Downloaded recording files

zoom_delete_recording

Delete cloud recordings for a Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe meeting ID or meeting UUID (e.g., "1234567890" or "4444AAABBBccccc12345==")
recordingIdstringNoSpecific recording file ID to delete. If not provided, deletes all recordings.
actionstringNoDelete action: "trash" (move to trash) or "delete" (permanently delete)

Output

ParameterTypeDescription
successbooleanWhether the recording was deleted successfully

zoom_list_past_participants

List participants from a past Zoom meeting

Input

ParameterTypeRequiredDescription
meetingIdstringYesThe past meeting ID or UUID (e.g., "1234567890" or "4444AAABBBccccc12345==")
pageSizenumberNoNumber of records per page, 1-300 (e.g., 30, 50, 100)
nextPageTokenstringNoToken for pagination to get next page of results

Output

ParameterTypeDescription
participantsarrayList of meeting participants
↳ idstringParticipant unique identifier
↳ user_idstringUser ID if registered Zoom user
↳ namestringParticipant display name
↳ user_emailstringParticipant email address
↳ join_timestringTime when participant joined (ISO 8601)
↳ leave_timestringTime when participant left (ISO 8601)
↳ durationnumberDuration in seconds participant was in meeting
↳ attentiveness_scorestringAttentiveness score (deprecated)
↳ failoverbooleanWhether participant failed over to another data center
↳ statusstringParticipant status
pageInfoobjectPagination information
↳ pageSizenumberNumber of records per page
↳ totalRecordsnumberTotal number of records
↳ nextPageTokenstringToken for next page of results

On this page