Zoom

Learn how to use Zoom with Composio

Overview

SLUG

ZOOM

Description

Zoom is a video conferencing and online meeting platform featuring breakout rooms, screen sharing, and integrations with various enterprise tools

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to meeting:read:admin,meeting:write:admin,recording:write:admin,recording:master,recording:read:admin,user:read:admin,user:write:admin,user:master,account:read:admin,account:master,account:write:admin,calendar:write:admin,calendar:read:admin,contact:read:admin,group:write:admin,group:read:admin,group:master,mail:read:admin,mail:write:admin,phone_recording:write:admin,phone_recording:read:admin,phone_recording:master,clips:write:admin,zoom_events_recordings:read:admin,meeting_summary:read:admin
full
stringDefaults to https://api.zoom.us/v2
bearer_token
string

Tools

SLUG: ZOOM_CREATE_A_MEETING

Enable zoom meeting creation via user-level apps with "me". "start url" for hosts expires in 2 hours, or 90 days for "custcreate" users. renew via api, capped at 100 requests/day. requires "meeting:write" permission, subject to medium rate limit.

Action Parameters

agenda
string
default_password
boolean
duration
integer
password
string
pre_schedule
boolean
recurrence__end__date__time
string
recurrence__end__times
integerDefaults to 1
recurrence__monthly__day
integerDefaults to 1
recurrence__monthly__week
integer
recurrence__monthly__week__day
integer
recurrence__repeat__interval
integer
recurrence__type
integerDefaults to 2
recurrence__weekly__days
stringDefaults to 1
schedule_for
string
settings__additional__data__center__regions
array
settings__allow__multiple__devices
boolean
settings__alternative__host__update__polls
boolean
settings__alternative__hosts
string
settings__alternative__hosts__email__notification
booleanDefaults to True
settings__approval__type
integerDefaults to 2
settings__approved__or__denied__countries__or__regions__approved__list
array
settings__approved__or__denied__countries__or__regions__denied__list
array
settings__approved__or__denied__countries__or__regions__enable
boolean
settings__approved__or__denied__countries__or__regions__method
string
settings__audio
stringDefaults to both
settings__audio__conference__info
string
settings__authentication__domains
string
settings__authentication__exception
array
settings__authentication__option
string
settings__auto__recording
stringDefaults to none
settings__auto__start__ai__companion__questions
boolean
settings__auto__start__meeting__summary
boolean
settings__breakout__room__enable
boolean
settings__breakout__room__rooms
array
settings__calendar__type
integer
settings__close__registration
boolean
settings__cn__meeting
boolean
settings__contact__email
string
settings__contact__name
string
settings__continuous__meeting__chat__auto__add__invited__external__users
boolean
settings__continuous__meeting__chat__enable
boolean
settings__email__notification
booleanDefaults to True
settings__encryption__type
string
settings__focus__mode
boolean
settings__global__dial__in__countries
array
settings__host__save__video__order
boolean
settings__host__video
boolean
settings__in__meeting
boolean
settings__internal__meeting
boolean
settings__jbh__time
integer
settings__join__before__host
boolean
settings__language__interpretation__enable
boolean
settings__language__interpretation__interpreters
array
settings__meeting__authentication
boolean
settings__meeting__invitees
array
settings__mute__upon__entry
boolean
settings__participant__focused__meeting
boolean
settings__participant__video
boolean
settings__private__meeting
boolean
settings__push__change__to__calendar
boolean
settings__registrants__confirmation__email
boolean
settings__registrants__email__notification
boolean
settings__registration__type
integerDefaults to 1
settings__resources
array
settings__show__share__button
boolean
settings__sign__language__interpretation__enable
boolean
settings__sign__language__interpretation__interpreters
array
settings__use__pmi
boolean
settings__waiting__room
boolean
settings__watermark
boolean
start_time
string
template_id
string
timezone
string
topic
string
tracking_fields
array
type
integerDefaults to 2
userId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_DELETE_A_MEETING_REGISTRANT

Delete a meeting registrant. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Action Parameters

meetingId
integerRequired
occurrence_id
string
registrantId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_GET_A_MEETING

The text provides details on api permissions for reading meeting information, categorizing permissions into general and granular scopes, and labels the rate limit as 'light'.

Action Parameters

meetingId
integerRequired
occurrence_id
string
show_previous_occurrences
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_GET_A_MEETING_SUMMARY

Meeting summary info requires a pro+ host plan, ai companion enabled, excluding e2ee meetings. scopes include meeting summary:read and admin versions. rate limit: light.

Action Parameters

meetingId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_GET_MEETING_RECORDINGS

To download meeting recordings, use `download url`. include oauth token in the header for passcode-protected ones. supports `recording:read` and `phone recording:read:admin` scopes, with a `light` rate limit.

Action Parameters

include_fields
string
meetingId
stringRequired
ttl
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_LIST_ALL_RECORDINGS

This text details how to list zoom cloud recordings for a user, notably by using "me" for user-level apps and requiring an oauth token for access. it requires a pro plan, cloud recording enabled, and has a medium rate limit.

Action Parameters

from
string
mc
stringDefaults to false
meeting_id
integer
next_page_token
string
page_size
integerDefaults to 30
to
string
trash
boolean
trash_type
stringDefaults to meeting_recordings
userId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_LIST_MEETINGS

This zoom api lists a user's scheduled meetings using the `me` value for user-level apps, excluding instant meetings and only showing unexpired ones. it requires specific scopes and has a `medium` rate limit.

Action Parameters

from
string
next_page_token
string
page_number
integer
page_size
integerDefaults to 30
timezone
string
to
string
type
stringDefaults to scheduled
userId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_UPDATE_MEETING_STATUS

Update the status of a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Action Parameters

action
string
meetingId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ADD_A_MEETING_REGISTRANT

This text guides on creating and customizing a user's registration for a zoom meeting, with a max of 4,999 registrants. preconditions include the host being licensed. api scopes and a light rate limit apply.

Action Parameters

address
string
auto_approve
boolean
city
string
comments
string
country
string
custom_questions
array
email
stringRequired
first_name
stringRequired
industry
string
job_title
string
language
string
last_name
string
meetingId
integerRequired
no_of_employees
string
occurrence_ids
string
org
string
phone
string
purchasing_time_frame
string
role_in_purchase_process
string
state
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ADD_A_NEW_DEVICE

Add a new device to a zoom account, requiring `device:write:admin` scope with a `medium` rate limit.

Action Parameters

device_name
stringRequired
device_type
integerRequired
extension_number
string
mac_address
stringRequired
model
stringRequired
room_id
string
serial_number
stringRequired
tag
string
user_email
string
vendor
stringRequired
zdm_group_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ADD_A_USER_S_TSP_ACCOUNT

Add a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Action Parameters

conference_code
stringRequired
dial_in_numbers
array
leader_pin
stringRequired
tsp_bridge
string
userId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ADD_A_WEBINAR_REGISTRANT

Zoom users with a webinar plan can create and manage webinars, broadcasting to up to 10,000 attendees. registration requires a pro plan, specific permissions, and is governed by a "light" rate limit.

Action Parameters

address
string
city
string
comments
string
country
string
custom_questions
array
email
stringRequired
first_name
stringRequired
industry
string
job_title
string
language
string
last_name
string
no_of_employees
string
occurrence_ids
string
org
string
phone
string
purchasing_time_frame
string
role_in_purchase_process
string
source_id
string
state
string
webinarId
integerRequired
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ADD_PANELISTS

Panelists in webinars have access to more features like video sharing and screen sharing compared to attendees. adding panelists requires a pro or higher zoom plan with webinar add-on and specific scopes. rate limit label is medium.

Action Parameters

panelists
array
webinarId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_ASSIGN_A_DEVICE_TO_A_USER_OR_COMMONAREA

Assign, move, or remove a device for a user/common area within zoom device management (zdm). requires the device to be enrolled in zdm and appropriate admin scopes. rate limit category is medium.

Action Parameters

extension_number
string
mac_address
stringRequired
vendor
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CHANGE_DEVICE

Change device name. **prerequisites:** * device must be enrolled in zmd (zoom device management) **scopes:** `device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`

Action Parameters

deviceId
stringRequired
device_name
stringRequired
device_type
integer
room_id
string
tag
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CHANGE_DEVICE_ASSOCIATION

Api allows changing zoom room device associations, requiring enrollment in zoom device management (zmd) with admin write access. rate limit is medium.

Action Parameters

app_type
stringDefaults to ZR
deviceId
stringRequired
room_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CREATE_A_H_323_SIP_DEVICE

H.323/sip devices can join or be called into zoom meetings via room connector. use the api to add devices to your zoom account. rate limit: light.

Action Parameters

encryption
stringRequired
ip
stringRequired
name
stringRequired
protocol
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CREATE_A_MEETING_POLL

Meeting hosts can create polls for attendees if using a pro or higher plan, with the polling feature enabled, and for scheduled meetings only. rate limit: light.

Action Parameters

anonymous
boolean
meetingId
integerRequired
poll_type
integer
questions
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CREATE_A_MEETING_TEMPLATE_FROM_AN_EXISTING_MEETING

Create a meeting template from an existing meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`

Action Parameters

meeting_id
integer
name
string
overwrite
boolean
save_recurrence
boolean
userId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ZOOM_CREATE_A_RECORDING_REGISTRANT

Zoom offers on-demand cloud recordings of past meetings, accessible to registered users via an api. api scopes required are `recording:write:admin` and `recording:write`, with a 'light' rate limit.

Action Parameters

address
string
city
string
comments
string
country
string
custom_questions
array
email
stringRequired
first_name
stringRequired
industry
string
job_title
string
last_name
string
meetingId
integerRequired
no_of_employees
string
org
string
phone
string
purchasing_time_frame
string
role_in_purchase_process
string
state
string
status
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired