Zoom

zoom

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

Video Conferencing Team Collaboration Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (17)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add a meeting registrantZOOM_ADD_A_MEETING_REGISTRANTAcción

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.

Parámetros de entrada

orgstring
The registrant"s organization.
zipstring
The registrant"s ZIP or postal code.
citystring
The registrant"s city.
emailstringObligatorioemail
The registrant"s email address.
phonestring
The registrant"s phone number.
statestring
The registrant"s state or province.
addressstring
The registrant"s address.
countrystring
The registrant"s two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
commentsstring
The registrant"s questions and comments.
industrystring
The registrant"s industry.
languagestringenum
The registrant"s language preference for confirmation emails: * `en-US` — English (US) * `de-DE` — German (Germany) * `es-ES` — Spanish (Spain) * `fr-FR` — French (France) * `jp-JP` — Japanese * `pt-PT` — Portuguese (Portugal) * `ru-RU` — Russian * `zh-CN` — Chinese (PRC) * `zh-TW` — Chinese (Taiwan) * `ko-KO` — Korean * `it-IT` — Italian (Italy) * `vi-VN` — Vietnamese * `pl-PL` — Polish * `Tr-TR` — Turkish
en-USde-DEes-ESfr-FRjp-JPpt-PTru-RUzh-CNzh-TWko-KOit-ITvi-VN+2
job_titlestring
The registrant"s job title.
last_namestring
The registrant"s last name.
meetingIdintegerObligatorio
The meeting"s ID. When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
first_namestringObligatorio
The registrant"s first name.
auto_approveboolean
If a meeting was scheduled with the `approval_type` field value of `1` (manual approval) but you want to automatically approve meeting registrants, set the value of this field to `true`. **Note:** You cannot use this field to change approval setting for a meeting originally scheduled with the `approval_type` field value of `0` (automatic approval).
occurrence_idsstring
A comma-separated list of meeting occurrence IDs. You can get this value with the [Get a meeting](https://developers.zoom.us) API.
no_of_employeesstringenum
The registrant"s number of employees: * `1-20` * `21-50` * `51-100` * `101-500` * `500-1,000` * `1,001-5,000` * `5,001-10,000` * `More than 10,000`
1-2021-5051-100101-500500-1,0001,001-5,0005,001-10,000More than 10,000
custom_questionsobject[]
Information about custom questions.
purchasing_time_framestringenum
The registrant"s purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe`
Within a month1-3 months4-6 monthsMore than 6 monthsNo timeframe
role_in_purchase_processstringenum
The registrant"s role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved`
Decision MakerEvaluator/RecommenderInfluencerNot involved

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a webinar registrantZOOM_ADD_A_WEBINAR_REGISTRANTAcción

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.

Parámetros de entrada

orgstring
The registrant"s organization.
zipstring
The registrant"s ZIP or postal code.
citystring
The registrant"s city.
emailstringObligatorioemail
The registrant"s email address.
phonestring
The registrant"s phone number.
statestring
The registrant"s state or province.
addressstring
The registrant"s address.
countrystring
The registrant"s two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).
commentsstring
The registrant"s questions and comments.
industrystring
The registrant"s industry.
languagestringenum
The registrant"s language preference for confirmation emails: * `en-US` - English (US) * `de-DE` - German (Germany) * `es-ES` - Spanish (Spain) * `fr-FR` - French (France) * `jp-JP` - Japanese * `pt-PT` - Portuguese (Portugal) * `ru-RU` - Russian * `zh-CN` - Chinese (PRC) * `zh-TW` - Chinese (Taiwan) * `ko-KO` - Korean * `it-IT` - Italian (Italy) * `vi-VN` - Vietnamese * `pl-PL` - Polish * `Tr-TR` - Turkish
en-USde-DEes-ESfr-FRjp-JPpt-PTru-RUzh-CNzh-TWko-KOit-ITvi-VN+2
job_titlestring
The registrant"s job title.
last_namestring
The registrant"s last name.
source_idstring
The tracking source"s unique identifier.
webinarIdintegerObligatorio
The webinar"s ID.
first_namestringObligatorio
The registrant"s first name.
occurrence_idsstring
A comma-separated list of webinar occurrence IDs. Get this value with the [Get a webinar](https://developers.zoom.us) API. Make sure the `registration_type` is 3 if updating multiple occurrences with this API.
no_of_employeesstringenum
The registrant"s number of employees: * `1-20` * `21-50` * `51-100` * `101-500` * `500-1,000` * `1,001-5,000` * `5,001-10,000` * `More than 10,000`
1-2021-5051-100101-500500-1,0001,001-5,0005,001-10,000More than 10,000
custom_questionsobject[]
Information about custom questions.
purchasing_time_framestringenum
The registrant"s purchasing time frame: * `Within a month` * `1-3 months` * `4-6 months` * `More than 6 months` * `No timeframe`
Within a month1-3 months4-6 monthsMore than 6 monthsNo timeframe
role_in_purchase_processstringenum
The registrant"s role in the purchase process: * `Decision Maker` * `Evaluator/Recommender` * `Influencer` * `Not involved`
Decision MakerEvaluator/RecommenderInfluencerNot involved

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a meetingZOOM_CREATE_A_MEETINGAcción

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.

Parámetros de entrada

typeinteger
The type of meeting. * `1` - An instant meeting. * `2` - A scheduled meeting. * `3` - A recurring meeting with no fixed time. * `8` - A recurring meeting with fixed time.
topicstring
The meeting"s topic.
agendastring
The meeting"s agenda. This value has a maximum length of 2,000 characters.
userIdstringObligatorio
The user"s user ID or email address. For user-level apps, pass the `me` value.
durationinteger
The meeting"s scheduled duration, in minutes. This field is only used for scheduled meetings (`2`).
passwordstring
The passcode required to join the meeting. By default, a passcode can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters. * If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements. * If passcode requirements are enabled, use the [**Get user settings**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](https://developers.zoom.us/docs/api-reference/zoom-api/ma#operation/accountSettings) API to get the requirements.
timezonestring
The timezone to assign to the `start_time` value. This field is only used for scheduled or recurring meetings with a fixed time. For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
start_timestringdate-time
The meeting"s start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats. * To set a meeting"s start time in GMT, use the `yyyy-MM-ddTHH:mm:ssZ` date-time format. For example, `2020-03-31T12:02:00Z`. * To set a meeting"s start time using a specific timezone, use the `yyyy-MM-ddTHH:mm:ss` date-time format and specify the [timezone ID](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones) in the `timezone` field. If you do not specify a timezone, the `timezone` value defaults to your Zoom account"s timezone. You can also use `UTC` for the `timezone` value. **Note:** If no `start_time` is set for a scheduled meeting, the `start_time` is set at the current time and the meeting type changes to an instant meeting, which expires after 30 days.
template_idstring
The account admin meeting template ID used to schedule a meeting using a [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). For a list of account admin-provided meeting templates, use the [**List meeting templates**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/listMeetingTemplates) API. * At this time, this field **only** accepts account admin meeting template IDs. * To enable the account admin meeting templates feature, [contact Zoom support](https://support.zoom.us/hc/en-us).
pre_scheduleboolean
Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time). * `true` - Create a prescheduled meeting. * `false` - Create a regular meeting.
schedule_forstring
The email address or user ID of the user to schedule a meeting for.
settings__audiostringenum
How participants join the audio portion of the meeting. * `both` - Both telephony and VoIP. * `telephony` - Telephony only. * `voip` - VoIP only. * `thirdParty` - Third party audio conference.
bothtelephonyvoipthirdParty
tracking_fieldsobject[]
Information about the meeting"s tracking fields.
default_passwordboolean
Whether to generate a default passcode using the user"s settings. This value defaults to `false`. If this value is `true` and the user has the PMI setting enabled with a passcode, then the user"s meetings will use the PMI passcode. It will **not** use a default passcode.
recurrence__typeinteger
Recurrence meeting types. `1` - Daily. `2` - Weekly. `3` - Monthly.
settings__use__pmiboolean
Whether to use a [Personal Meeting ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi) instead of a generated meeting ID. This field is only used for scheduled meetings (`2`), instant meetings (`1`), or recurring meetings with no fixed time (`3`). This value defaults to `false`.
settings__jbh__timeinteger
If the value of the `join_before_host` field is `true`, this field indicates the time limits when a participant can join a meeting before the meeting"s host. * `0` - Allow the participant to join the meeting at anytime. * `5` - Allow the participant to join 5 minutes before the meeting"s start time. * `10` - Allow the participant to join 10 minutes before the meeting"s start time.
settings__resourcesobject[]
The meeting"s resources.
settings__watermarkboolean
Whether to add a watermark when viewing a shared screen.
settings__cn__meetingboolean
Whether to host the meeting in China (CN). This value defaults to `false`.
settings__focus__modeboolean
Whether to enable the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when the meeting starts.
settings__host__videoboolean
Whether to start meetings with the host video on.
settings__in__meetingboolean
Whether to host the meeting in India (IN). This value defaults to `false`.
recurrence__end__timesinteger
Select how many times the meeting should recur before it is canceled. If `end_times` is set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with `end_date_time`.
settings__contact__namestring
The contact name for meeting registration.
settings__waiting__roomboolean
Whether to enable the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room). If this value is `true`, this **disables** the `join_before_host` setting.
recurrence__monthly__dayinteger
Use this field **only if you"re scheduling a recurring meeting of type** `3` to state the day in a month when the meeting should recur. The value range is from 1 to 31. For the meeting to recur on 23rd of each month, provide `23` as this field"s value and `1` as the `repeat_interval` field"s value. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.
recurrence__weekly__daysstringenum
This field is required if you"re scheduling a recurring meeting of type `2` to state the days of the week when the meeting should repeat. The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field"s value. **Note:** To set the meeting to occur on multiple days of a week, provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays, provide `1,3` as this field"s value. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.
1234567
settings__approval__typeinteger
Enable meeting registration approval. * `0` - Automatically approve registration. * `1` - Manually approve registration. * `2` - No registration required. This value defaults to `2`.
settings__calendar__typeinteger
Indicates the type of calendar integration used to schedule the meeting. * `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) * `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on) Works with the `private_meeting` field to determine whether to share details of meetings or not.
settings__contact__emailstring
The contact email address for meeting registration.
recurrence__monthly__weekinteger
Use this field **only if you"re scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur. `-1` - Last week of the month. `1` - First week of the month. `2` - Second week of the month. `3` - Third week of the month. `4` - Fourth week of the month.
settings__auto__recordingstringenum
The automatic recording settings. * `local` - Record the meeting locally. * `cloud` - Record the meeting to the cloud. * `none` - Auto-recording disabled. This value defaults to `none`.
localcloudnone
settings__encryption__typestringenum
The type of [end-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871) to use for the meeting. * `enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud when you enable this option. * `e2ee` - End-to-end encryption. The encryption key is stored on your local device and **cannot** be obtained by anyone else. When you use E2EE encryption, [certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording or phone and SIP/H.323 dial-in, are **disabled**.
enhanced_encryptione2ee
settings__private__meetingboolean
Whether to set the meeting as private.
recurrence__end__date__timestringdate-time
Select the final date when the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with `end_times`.
settings__internal__meetingboolean
Whether to set the meeting as an internal meeting.
settings__meeting__inviteesobject[]
A list of the meeting"s invitees.
settings__mute__upon__entryboolean
Whether to mute participants upon entry.
recurrence__repeat__intervalinteger
Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field"s value as `2` and the value of the `type` parameter as `3`. For a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is of `12` weeks. For a monthly meeting, there is a maximum of `3` months.
settings__alternative__hostsstring
A semicolon-separated list of the meeting"s alternative hosts" email addresses or IDs.
settings__join__before__hostboolean
Whether participants can join the meeting before its host. This field is only used for scheduled meetings (`2`) or recurring meetings (`3` and `8`). This value defaults to `false`. If the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) is enabled, this setting is **disabled**.
settings__participant__videoboolean
Whether to start meetings with the participant video on.
settings__registration__typeinteger
The meeting"s registration type. * `1` - Attendees register once and can attend any meeting occurrence. * `2` - Attendees must register for each meeting occurrence. * `3` - Attendees register once and can select one or more meeting occurrences to attend. This field is only for recurring meetings with fixed times (`8`). This value defaults to `1`.
settings__close__registrationboolean
Whether to close registration after the event date. This value defaults to `false`.
settings__email__notificationboolean
Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.
settings__show__share__buttonboolean
Whether to include social media sharing buttons on the meeting"s registration page. This setting is only applied to meetings with registration enabled.
recurrence__monthly__week__dayinteger
Use this field **only if you"re scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.
settings__breakout__room__roomsobject[]
Information about the breakout rooms.
settings__authentication__optionstring
If the `meeting_authentication` value is `true`, the type of authentication required for users to join a meeting. To get this value, use the `authentication_options` array"s `id` value in the [**Get user settings**](https://developers.zoom.us/docs/api-reference/zoom-api/methods#operation/userSettings) API response.
settings__breakout__room__enableboolean
Whether to enable the [**Breakout Room pre-assign**](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) option.
settings__audio__conference__infostring
Third party audio conference info.
settings__authentication__domainsstring
The meeting"s authenticated domains. Only Zoom users whose email address contains an authenticated domain can join the meeting. Comma-separate multiple domains or use a wildcard for listing domains.
settings__meeting__authenticationboolean
If true, only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join the meeting.
settings__allow__multiple__devicesboolean
Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled.
settings__host__save__video__orderboolean
Whether the **Allow host to save video order** feature is enabled.
settings__authentication__exceptionobject[]
A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite.
settings__push__change__to__calendarboolean
Whether to push meeting changes to the calendar. To enable this feature, configure the **Configure Calendar and Contacts Service** in the user"s profile page of the Zoom web portal and enable the **Automatically sync Zoom calendar events information bi-directionally between Zoom and integrated calendars.** setting in the **Settings** page of the Zoom web portal. * `true` - Push meeting changes to the calendar. * `false` - Do not push meeting changes to the calendar.
settings__global__dial__in__countriesstring[]
A list of available global dial-in countries.
settings__auto__start__meeting__summaryboolean
Whether to automatically start a meeting summary.
settings__participant__focused__meetingboolean
Whether to set the meeting as a participant focused meeting.
settings__alternative__host__update__pollsboolean
Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.
settings__language__interpretation__enableboolean
Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.
settings__registrants__confirmation__emailboolean
Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email.
settings__registrants__email__notificationboolean
Whether to send registrants email notifications about their registration approval, cancellation, or rejection. * `true` - Send an email notification. * `false` - Do not send an email notification. Set this value to `true` to also use the `registrants_confirmation_email` parameter.
settings__additional__data__center__regionsstring[]
Add additional meeting [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars). Provide this value as an array of [country codes](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) for the countries available as data center regions in the [**Account Profile**](https://zoom.us/account/setting) interface but have been opted out of in the [user settings](https://zoom.us/profile). For example, the data center regions selected in your [**Account Profile**](https://zoom.us/account) are `Europe`, `Hong Kong SAR`, `Australia`, `India`, `Japan`, `China`, `United States`, and `Canada`. However, in the [**My Profile**](https://zoom.us/profile) settings, you did **not** select `India` and `Japan` for meeting and webinar traffic routing. To include `India` and `Japan` as additional data centers, use the `[IN, TY]` value for this field.
settings__continuous__meeting__chat__enableboolean
Whether to enable the **Enable continuous meeting chat** setting.
settings__auto__start__ai__companion__questionsboolean
Whether to automatically start AI Companion questions.
settings__language__interpretation__interpretersobject[]
Information about the meeting"s language interpreters.
settings__sign__language__interpretation__enableboolean
Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the meeting.
settings__alternative__hosts__email__notificationboolean
Whether to send email notifications to alternative hosts. This value defaults to `true`.
settings__sign__language__interpretation__interpretersobject[]
Information about the meeting"s sign language interpreters.
settings__approved__or__denied__countries__or__regions__enableboolean
Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Approve-or-block-entry-for-users-from-specific-countries-regions) setting.
settings__approved__or__denied__countries__or__regions__methodstringenum
Whether to allow or block users from specific countries or regions. * `approve` - Allow users from specific countries or regions to join the meeting. If you select this setting, include the approved countries or regions in the `approved_list` field. * `deny` - Block users from specific countries or regions from joining the meeting. If you select this setting, include the blocked countries or regions in the `denied_list` field.
approvedeny
settings__approved__or__denied__countries__or__regions__denied__liststring[]
The list of blocked countries or regions.
settings__approved__or__denied__countries__or__regions__approved__liststring[]
The list of approved countries or regions.
settings__continuous__meeting__chat__auto__add__invited__external__usersboolean
Whether to enable the **Automatically add invited external users** setting.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete meeting recordingsZOOM_DELETE_MEETING_RECORDINGSAcción

Summary: to delete all meeting recordings, ensure the user's account has cloud recording enabled. required permissions include `recording:write:admin` and `recording:write` with a `light` rate limit label.

Parámetros de entrada

actionstringenum
The recording delete actions: `trash` - Move recording to trash. `delete` - Delete recording permanently.
trashdelete
meetingIdstringObligatorio
To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a meetingZOOM_GET_A_MEETINGAcción

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'.

Parámetros de entrada

meetingIdintegerObligatorio
The meeting"s ID. When storing this value in your database, store it as a long format integer and **not** an integer. Meeting IDs can be more than 10 digits.
occurrence_idstring
Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).
show_previous_occurrencesboolean
Set this field"s value to `true` to view meeting details of all previous occurrences of a [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a meeting summaryZOOM_GET_A_MEETING_SUMMARYAcción

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.

Parámetros de entrada

meetingIdstringObligatorio
The meeting"s universally unique ID (UUID). When you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a webinarZOOM_GET_A_WEBINARAcción

Access zoom webinar details requires pro or higher plan and webinar add-on. scopes include `webinar:read:admin` and `webinar:read`. granular scopes and a 'light' rate limit also apply.

Parámetros de entrada

webinarIdstringObligatorio
The webinar"s ID or universally unique ID (UUID).
occurrence_idstring
Unique identifier for an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences. When you create a recurring Webinar using [**Create a webinar**](https://developers.zoom.us) API, you can retrieve the Occurrence ID from the response of the API call.
show_previous_occurrencesboolean
Set the value of this field to `true` if you would like to view Webinar details of all previous occurrences of a recurring Webinar.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get daily usage reportZOOM_GET_DAILY_USAGE_REPORTAcción

The daily report provides zoom service usage details, like new users, meetings, participants, and minutes per day for a month, requiring a pro plan or higher. it has a 'heavy' rate limit.

Parámetros de entrada

yearinteger
Year for this report
monthinteger
Month for this report
group_idstring
The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us) API. **Note:** The API response will only contain users who are members of the queried group ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get meeting recordingsZOOM_GET_MEETING_RECORDINGSAcción

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.

Parámetros de entrada

ttlinteger
The `download_access_token` Time to Live (TTL) value. This parameter is only valid if the `include_fields` query parameter contains the `download_access_token` value.
meetingIdstringObligatorio
To get a meeting"s cloud recordings, provide the meeting ID or UUID. If providing the meeting ID instead of UUID, the response will be for the latest meeting instance. To get a webinar"s cloud recordings, provide the webinar"s ID or UUID. If providing the webinar ID instead of UUID, the response will be for the latest webinar instance. If a UUID starts with `/` or contains `//` (example: `/ajXp112QmuoKj4854875==`), **[double encode](https://developers.zoom.us) the UUID** before making an API request.
include_fieldsstring
The `download_access_token` value for downloading the meeting"s recordings.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get past meeting participantsZOOM_GET_PAST_MEETING_PARTICIPANTSAcción

Api allows paid users (pro+) to fetch past meeting attendee info, excluding solo participants. requires double encoding for certain uuids, with `meeting:read` scope and others. rate limit is medium.

Parámetros de entrada

meetingIdstringObligatorio
The meeting"s ID or universally unique ID (UUID). * If you provide a meeting ID, the API will return a response for the latest meeting instance. * If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the meeting UUID before making an API request.
page_sizeinteger
The number of records returned within a single API call.
next_page_tokenstring
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token"s expiration period is 15 minutes.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all recordingsZOOM_LIST_ALL_RECORDINGSAcción

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.

Parámetros de entrada

mcstring
The query metadata of the recording if using an on-premise meeting connector for the meeting.
tostring
The end date in "yyyy-mm-dd" "yyyy-mm-dd" UTC format.
fromstring
The start date in "yyyy-mm-dd" UTC format for the date range where you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the `from` and `to` parameters, by default the value of "from" field will be `2020-06-30` and the value of the "to" field will be `2020-07-01`. **Note**: The `trash` files cannot be filtered by date range and thus, the `from` and `to` fields should not be used for trash files.
trashboolean
The query trash. * `true` - List recordings from trash. * `false` - Do not list recordings from the trash. The default value is `false`. If you set it to `true`, you can use the `trash_type` property to indicate the type of Cloud recording that you need to retrieve.
userIdstringObligatorio
The user"s ID or email address. For user-level apps, pass the `me` value.
page_sizeinteger
The number of records returned within a single API call.
meeting_idinteger
The meeting ID.
trash_typestring
The type of cloud recording to retrieve from the trash. * `meeting_recordings`: List all meeting recordings from the trash. * `recording_file`: List all individual recording files from the trash.
next_page_tokenstring
The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List archived filesZOOM_LIST_ARCHIVED_FILESAcción

Zoom's archiving solution enables administrators to automatically record and archive meeting data to third-party platforms for compliance, needing the meeting and webinar archiving feature enabled.

Parámetros de entrada

tostring
The query end date, in `yyyy-MM-dd"T"HH:mm:ssZ` format. This value and the `from` query parameter value cannot exceed seven days.
fromstring
The query start date, in `yyyy-MM-dd"T"HH:mm:ssZ` format. This value and the `to` query parameter value cannot exceed seven days.
group_idstring
The group ID. To get a group ID, use the [List groups](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.
page_sizeinteger
The number of records returned within a single API call.
next_page_tokenstring
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token"s expiration period is 15 minutes.
query_date_typestringenum
The type of query date. * `meeting_start_time` * `archive_complete_time` This value defaults to `meeting_start_time`.
meeting_start_timearchive_complete_time

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List devicesZOOM_LIST_DEVICESAcción

This api lets you list devices. **scopes:** `device:read:admin`,`device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`

Parámetros de entrada

page_sizeinteger
The number of records returned within a single API call.
device_typeinteger
Filter devices by device type. Device Type: `-1` - All Zoom Room device(0,1,2,3,4,6). `0` - Zoom Rooms Computer. `1` - Zoom Rooms Controller. `2` - Zoom Rooms Scheduling Display. `3` - Zoom Rooms Control System. `4` - Zoom Rooms Whiteboard. `5` - Zoom Phone Appliance. `6` - Zoom Rooms Computer (with Controller).
platform_osstringenum
Filter devices by platform operating system.
winmacipadiphoneandroidlinux
search_textstring
Filter devices by name or serial number.
device_modelstring
Filter devices by model.
device_statusinteger
Filter devices by status. Device Status: `0` - offline. `1` - online. `-1` - unlink
device_vendorstring
Filter devices by vendor.
next_page_tokenstring
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token"s expiration period is 15 minutes.
is_enrolled_in_zdmboolean
Filter devices by enrollment of ZDM (Zoom Device Management).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List meetingsZOOM_LIST_MEETINGSAcción

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.

Parámetros de entrada

tostring
The end date.
fromstring
The start date.
typestringenum
The type of meeting. * `scheduled` - All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings. * `live` - All the ongoing meetings. * `upcoming` - All upcoming meetings, including live meetings. * `upcoming_meetings` - All upcoming meetings, including live meetings. * `previous_meetings` - All the previous meetings.
scheduledliveupcomingupcoming_meetingsprevious_meetings
userIdstringObligatorio
The user"s user ID or email address. For user-level apps, pass the `me` value.
timezonestring
The timezone to assign to the `from` and `to` value. For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
page_sizeinteger
The number of records returned within a single API call.
page_numberinteger
The page number of the current page in the returned records.
next_page_tokenstring
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token"s expiration period is 15 minutes.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List webinar participantsZOOM_LIST_WEBINAR_PARTICIPANTSAcción

Get a list of past webinar participants with a pro plan or above plus an add-on. requires specific scopes and has a medium rate limit.

Parámetros de entrada

page_sizeinteger
The number of records returned within a single API call.
webinarIdstringObligatorio
The webinar"s ID or universally unique ID (UUID). * If you provide a webinar ID, the API returns a response for the latest webinar instance. * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) the webinar UUID before making an API request.
next_page_tokenstring
Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token"s expiration period is 15 minutes.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List webinarsZOOM_LIST_WEBINARSAcción

The api lists all scheduled webinars for zoom users with a webinar plan, using `me` for user-level apps. it only shows unexpired webinars for hosts broadcasting to up to 10,000 attendees. requires pro plan upwards and specific scopes. rate limit: medium.

Parámetros de entrada

typestringenum
The type of webinar. * `scheduled` - All valid previous (unexpired) webinars, live webinars, and upcoming scheduled webinars. * `upcoming` - All upcoming webinars, including live webinars.
scheduledupcoming
userIdstringObligatorio
The user"s user ID or email address. For user-level apps, pass the `me` value.
page_sizeinteger
The number of records returned within a single API call.
page_numberinteger
**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a meetingZOOM_UPDATE_A_MEETINGAcción

To update a meeting via api, ensure `start time` is future-dated; `recurrence` is needed. limit: 100 requests/day, 100 updates/meeting in 24 hrs. requires `meeting:write` and `meeting:write:admin` scopes, with a `light` rate limit.

Parámetros de entrada

typeinteger
Meeting types. `1` - Instant meeting. `2` - Scheduled meeting. `3` - Recurring meeting with no fixed time. `8` - Recurring meeting with a fixed time.
topicstring
Meeting topic.
agendastring
Meeting description.
durationinteger
Meeting duration in minutes. Used for scheduled meetings only.
passwordstring
Meeting passcode. Passcodes may only contain these characters [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters. **Note** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. If the requirements are enabled, view those requirements by calling either the [**Get user settings**](https://developers.zoom.us) API or the [**Get account settings**](https://developers.zoom.us) API.
timezonestring
The timezone to assign to the `start_time` value. Only use this field ifor scheduled or recurring meetings with a fixed time. For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).
meetingIdintegerObligatorio
The meeting"s ID. When storing this value in your database, store it as a long format integer and **not** an integer. Meeting IDs can be greater than 10 digits.
start_timestringdate-time
Meeting start time. When using a format like `yyyy-MM-dd"T"HH:mm:ss"Z"`, always use GMT time. When using a format like `yyyy-MM-dd"T"HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
template_idstring
Unique identifier of the meeting template. [Schedule the meeting from a meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates#h_86f06cff-0852-4998-81c5-c83663c176fb). Retrieve this field"s value by calling the [List meeting templates](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/listMeetingTemplates) API.
pre_scheduleboolean
Whether to create a prescheduled meeting through the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` - scheduled meetings- and `3` - recurring meetings with no fixed time. * `true` - Create a prescheduled meeting. * `false` - Create a regular meeting.
schedule_forstring
The email address or `userId` of the user to schedule a meeting for.
occurrence_idstring
Meeting occurrence ID. Support change of agenda, `start_time`, duration, or settings {`host_video`, `participant_video`, `join_before_host`, `mute_upon_entry`, `waiting_room`, `watermark`, `auto_recording`}.
settings__audiostringenum
Determine how participants can join the audio portion of the meeting. `both` - Both Telephony and VoIP. `telephony` - Telephony only. `voip` - VoIP only. `thirdParty` - Third party audio conference.
bothtelephonyvoipthirdParty
tracking_fieldsobject[]
Tracking fields.
recurrence__typeinteger
Recurrence meeting types. `1` - Daily. `2` - Weekly. `3` - Monthly.
settings__use__pmiboolean
Use a [personal meeting ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.
settings__jbh__timeinteger
If the value of `join_before_host` field is set to true, use this field to indicate time limits for a participant to join a meeting before a host. * `0` - Allow participant to join anytime. * `5` - Allow participant to join 5 minutes before meeting start time. * `10` - Allow participant to join 10 minutes before meeting start time.
settings__resourcesobject[]
The meeting"s resources.
settings__watermarkboolean
Add a watermark when viewing a shared screen.
settings__cn__meetingboolean
Host the meeting in China.
settings__focus__modeboolean
Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts.
settings__host__videoboolean
Start video when the host joins the meeting.
settings__in__meetingboolean
Host meeting in India.
recurrence__end__timesinteger
Select how many times the meeting should recur before it is canceled. If `end_times` is set to 0, it means there is no end time. The maximum number of recurrences is 60. Cannot be used with `end_date_time`.
settings__custom__keysobject[]
Custom keys and values assigned to the meeting.
settings__contact__namestring
Contact name for registration.
settings__waiting__roomboolean
Enable waiting room.
recurrence__monthly__dayinteger
Use this field **only if you"re scheduling a recurring meeting of type** `3` to state the day in a month when the meeting should recur. The value range is from 1 to 31. For instance, if the meeting should recur on 23rd of each month, provide `23` as this field"s value and `1` as the `repeat_interval` field"s value. If the meeting should recur every three months on 23rd of the month, change the `repeat_interval` field"s value to `3`.
recurrence__weekly__daysstringenum
This field is required if you"re scheduling a recurring meeting of type `2`, to state which days of the week the meeting should repeat. Thiw field"s value could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field"s value. **Note** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `1,3` as this field"s value. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.
1234567
settings__approval__typeinteger
Enable registration and set approval for the registration. Note that this feature requires the host to be of **Licensed** user type. **Registration cannot be enabled for a basic user.** `0` - Automatically approve. `1` - Manually approve. `2` - No registration required.
settings__calendar__typeinteger
The type of calendar integration used to schedule the meeting. * `1` - [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) * `2` - [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on) Works with the `private_meeting` field to determine whether to share details of meetings.
settings__contact__emailstring
Contact email for registration.
settings__enforce__loginboolean
Only signed in users can join this meeting. **This field is deprecated and will not be supported in the future.** As an alternative, use the `meeting_authentication`, `authentication_option`, and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.
recurrence__monthly__weekinteger
Use this field **only if you"re scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur. `-1` - Last week of the month. `1` - First week of the month. `2` - Second week of the month. `3` - Third week of the month. `4` - Fourth week of the month.
settings__auto__recordingstringenum
Automatic recording. `local` - Record on local. `cloud` - Record on cloud. `none` - Disabled.
localcloudnone
settings__encryption__typestringenum
Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features such cloud recording and phone/SIP/H.323 dial-in, will be **automatically disabled**. `enhanced_encryption` - Enhanced encryption. Encryption is stored in the cloud if you enable this option. `e2ee` - [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the features join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.
enhanced_encryptione2ee
settings__private__meetingboolean
Whether the meeting is set as private.
recurrence__end__date__timestringdate-time
Select the final date when the meeting recurs before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. Cannot be used with `end_times`.
settings__internal__meetingboolean
Whether to set the meeting as an internal meeting.
settings__meeting__inviteesobject[]
A list of the meeting"s invitees.
settings__mute__upon__entryboolean
Mute participants upon entry.
recurrence__repeat__intervalinteger
Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field"s value as `2` and the `type` parameter"s value to `3`. For a daily meeting, the maximum interval is `90` days. For a weekly meeting, the maximum interval is `12` weeks. For a monthly meeting, the maximum value is `3` months.
settings__alternative__hostsstring
A semicolon-separated list of the meeting"s alternative hosts" email addresses or IDs.
settings__join__before__hostboolean
Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.
settings__participant__videoboolean
Start video when participants join the meeting.
settings__registration__typeinteger
Registration type. Used for recurring meeting with fixed time only. `1` - Attendees register once and can attend any of the occurrences. `2` - Attendees need to register for each occurrence to attend. `3` - Attendees register once and can choose one or more occurrences to attend.
settings__close__registrationboolean
Close registration after the event date.
settings__email__notificationboolean
Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.
settings__show__share__buttonboolean
Show social share buttons on the meeting registration page. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).
recurrence__monthly__week__dayinteger
Use this field only if you"re scheduling a recurring meeting of type `3` to state a specific day in a week when a monthly meeting should recur. To use this field, you must also use the `monthly_week` field. `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.
settings__authentication__namestring
Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f).
settings__breakout__room__roomsobject[]
Create room(s).
settings__authentication__optionstring
Meeting authentication option ID.
settings__breakout__room__enableboolean
Set this field"s value to `true` to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option.
settings__audio__conference__infostring
Third party audio conference info.
settings__authentication__domainsstring
If user has configured [Sign Into Zoom with Specified Domains](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated.
settings__enforce__login__domainsstring
Only signed in users with specified domains can join meetings. **This field is deprecated and will not be supported in the future.** As an alternative, use the `meeting_authentication`, `authentication_option`. and `authentication_domains` fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.
settings__meeting__authenticationboolean
`true`- Only authenticated users can join meetings.
settings__allow__multiple__devicesboolean
Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).
settings__host__save__video__orderboolean
Whether the **Allow host to save video order** feature is enabled.
settings__authentication__exceptionobject[]
The participants added here will receive unique meeting invite links and bypass authentication.
settings__global__dial__in__numbersobject[]
Global dial-in countries or regions
settings__global__dial__in__countriesstring[]
List of global dial-in countries
settings__auto__start__meeting__summaryboolean
Whether to automatically start meeting summary.
settings__participant__focused__meetingboolean
Whether to set the meeting as a participant focused meeting.
settings__alternative__host__update__pollsboolean
Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.
settings__language__interpretation__enableboolean
Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.
settings__registrants__confirmation__emailboolean
Whether to send registrants an email confirmation. * `true` - Send a confirmation email. * `false` - Do not send a confirmation email.
settings__registrants__email__notificationboolean
Whether to send registrants email notifications about their registration approval, cancellation, or rejection. * `true` - Send an email notification. * `false` - Do not send an email notification. Set this value to `true` to also use the `registrants_confirmation_email` parameter.
settings__continuous__meeting__chat__enableboolean
Whether to enable the **Enable continuous meeting chat** setting.
settings__auto__start__ai__companion__questionsboolean
Whether to automatically start AI Companion questions.
settings__language__interpretation__interpretersobject[]
Information about the meeting"s language interpreters.
settings__sign__language__interpretation__enableboolean
Whether to enable [sign language interpretation](https://support.zoom.us/hc/en-us/articles/9644962487309-Using-sign-language-interpretation-in-a-meeting-or-webinar) for the meeting.
settings__alternative__hosts__email__notificationboolean
Flag to determine whether to send email notifications to alternative hosts, default value is true.
settings__sign__language__interpretation__interpretersobject[]
Information about the meeting"s sign language interpreters.
settings__approved__or__denied__countries__or__regions__enableboolean
`true` - Setting enabled to either allow users or block users from specific regions to join your meetings. `false` - Setting disabled.
settings__approved__or__denied__countries__or__regions__methodstringenum
Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting. `approve` - Allow users from specific regions or countries to join this meeting. If this setting is selected, include the approved regions or countries in the `approved_list`. `deny` - Block users from specific regions or countries from joining this meeting. If this setting is selected, include the approved regions orcountries in the `denied_list`
approvedeny
settings__approved__or__denied__countries__or__regions__denied__liststring[]
List of countries or regions from where participants can not join this meeting.
settings__approved__or__denied__countries__or__regions__approved__liststring[]
List of countries or regions from where participants can join this meeting.
settings__continuous__meeting__chat__auto__add__invited__external__usersboolean
Whether to enable the **Automatically add invited external users** setting.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Triggers (11)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Daily Usage Report ChangedZOOM_DAILY_USAGE_REPORT_CHANGED_TRIGGERTrigger

Triggers when the Zoom daily usage report changes for a selected year/month. This trigger monitors daily usage statistics including: - New users added - Number of meetings held - Participant counts - Meeting minutes consumed

Configuración

group_idstring
Optional group ID to filter results. When specified, only includes users who are members of the queried group. Use the List groups API to retrieve group IDs.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
monthinteger
Month for the report (1-12). If not provided, defaults to the current month.
yearinteger
Year for the report. If not provided, defaults to the current year.

Payload del evento

changed_datesstring[]
List of dates that had changes in their statistics
event_typestring
Type of change detected (report_updated)
reportobjectObligatorio
Current state of the daily usage report

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors Zoom daily usage reports for changes in statistics. - You can specify a year and month to monitor (defaults to current year/month if not provided). - Optionally filter by group ID to monitor usage for a specific group only. - The trigger detects changes such as: - New users joining - Changes in meeting counts - Changes in participant counts - Changes in meeting minutes - Requires a Pro plan or higher and the report:read:daily_usage:admin scope.

Meeting Details ChangedZOOM_MEETING_DETAILS_CHANGED_TRIGGERTrigger

Triggers when a specific meeting's details change. Detects changes such as: - Meeting topic changes - Agenda updates - Schedule changes (timezone, duration) - Settings modifications (waiting room, recording, video, etc.) - Password changes - Recurrence pattern updates

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
meeting_idintegerObligatorio
The meeting ID to monitor for details changes. Use the numeric meeting ID from your Zoom meeting.

Payload del evento

changed_fieldsstring[]
List of field names that changed
event_typestringObligatorio
Type of change detected (meeting_updated, settings_changed)
meeting_detailsobjectObligatorio
Current state of the meeting details

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Zoom meeting for changes to its details. - You must provide a meeting ID to monitor. - The trigger detects changes to: - Meeting topic and agenda - Schedule details (timezone, duration, start time) - Meeting settings (waiting room, video, audio, recording, etc.) - Password and security settings - Recurrence patterns for recurring meetings

Meeting Recording ChangedZOOM_MEETING_RECORDING_CHANGED_TRIGGERTrigger

Triggers when a specific meeting's cloud recordings change. Detects changes such as: - New recording files appearing - Recording processing completion (status changes) - Recording metadata changes (count, size, etc.) - New participant audio files

Configuración

include_download_tokenboolean
Whether to include download access token in the response. Set to True if you need to download recordings.
intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
meeting_idstringObligatorio
The meeting ID or UUID to monitor for recording changes. Use the meeting ID for the latest instance or UUID for a specific instance.
token_ttlinteger
Time to live (in seconds) for the download access token. Only used when include_download_token is True.

Payload del evento

changes_detectedobject
Dictionary describing what changed (e.g., new files, status changes, metadata updates)
event_typestringObligatorio
Type of change detected (recording_added, recording_updated, recording_processing_completed)
meeting_recordingobjectObligatorio
Current state of the meeting recording

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Zoom meeting for changes to its cloud recordings. - You must provide a meeting ID or UUID to monitor. - The trigger detects: - New recording files appearing after processing completes - Changes in recording status (e.g., from 'processing' to 'completed') - Updates to recording metadata (file count, total size) - New participant audio files - Use include_download_token to get download access tokens if you need to download recordings.

Meeting Summary Created or UpdatedZOOM_MEETING_SUMMARY_UPDATED_TRIGGERTrigger

Triggers when a meeting summary is created or updated for a specific meeting. IMPORTANT: This trigger requires a PAID Zoom account (Pro, Business, or Enterprise plan). Free Zoom accounts cannot use this feature. Additionally requires: - AI Companion feature enabled in account settings - Meeting must not be end-to-end encrypted (E2EE) - Meeting summary must be enabled and generated for the meeting

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
meeting_idstringObligatorio
The unique ID of the meeting to monitor for summary changes. This is the meeting UUID or meeting ID from your Zoom account.

Payload del evento

changed_fieldsstring[]
List of fields that changed (for updates)
event_typestringObligatorio
Type of event that occurred (created/updated)
summaryobjectObligatorio
The meeting summary that was created or updated

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Zoom meeting for summary changes (creation or updates). - REQUIRES PAID ZOOM ACCOUNT (Pro or higher) - NOT available for free accounts. - You must provide the meeting ID you want to monitor. - The meeting must have AI Companion enabled and meeting summary generation enabled. - The trigger detects when a summary is first created or when it's updated.

New Cloud RecordingZOOM_NEW_CLOUD_RECORDING_TRIGGERTrigger

Triggers when a new cloud recording meeting instance appears for a user.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
page_sizeinteger
Number of recordings to fetch per page (1-300)
user_idstring
The user's ID or email address. Use 'me' for the authenticated user.

Payload del evento

event_typestring
Type of event
meetingobjectObligatorio
The meeting with new cloud recording

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors Zoom cloud recordings for new meeting instances. - Each meeting instance (identified by UUID) with a cloud recording will trigger once. - Use user_id='me' to monitor the authenticated user's recordings, or specify a user ID/email. - Configure page_size to control how many recordings to check per poll (default: 30).

New Meeting CreatedZOOM_NEW_MEETING_CREATED_TRIGGERTrigger

Triggers when a new Zoom meeting is created for a user.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
meeting_typestring
Type of meetings to monitor: 'scheduled', 'live', 'upcoming', 'upcoming_meetings', or 'previous_meetings'
page_sizeinteger
Number of meetings to fetch per page (1-300)
user_idstring
The user's ID or email address. Use 'me' for the authenticated user.

Payload del evento

event_typestring
Type of event that occurred
meetingobjectObligatorio
The newly created meeting

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors Zoom meetings and fires when new meetings are created. - Use user_id='me' to monitor the authenticated user's meetings, or specify a user ID/email. - Configure meeting_type to monitor specific types of meetings (default: 'scheduled'). - Each meeting triggers only once when first detected.

New Meeting ParticipantZOOM_NEW_MEETING_PARTICIPANT_TRIGGERTrigger

Triggers when a new participant appears in a past meeting's participant report.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
meeting_idstringObligatorio
The meeting's ID or universally unique ID (UUID). If you provide a meeting ID, the API returns a response for the latest meeting instance. If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you must double encode the meeting UUID before making an API request.
page_sizeinteger
The number of participants to fetch per API call (max 300).

Payload del evento

customer_keystring
The customer key associated with the participant.
durationinteger
Duration the participant was in the meeting, in seconds.
failoverboolean
Whether failover occurred during the meeting for this participant.
idstring
Unique identifier for the participant in UUID format.
join_timestring
The date and time when the participant joined the meeting (ISO 8601 format).
leave_timestring
The date and time when the participant left the meeting (ISO 8601 format).
namestring
Participant's display name shown during the meeting.
registrant_idstring
The participant's unique registrant ID if they registered for the meeting.
statusstring
The participant's attendance status: 'in_meeting' or 'in_waiting_room'.
user_emailstring
The participant's email address. May be empty for external attendees.
user_idstring
The participant's Zoom user ID. Empty for external participants not in your account.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific past meeting for new participants. - You must provide the meeting ID or UUID to monitor. - The trigger will detect participants that appear in the participant list after the trigger is set up. - Note: This trigger is designed for past meetings. The participant list may take time to populate after a meeting ends. - Requires a paid Zoom account (Pro or higher).

New Webinar CreatedZOOM_NEW_WEBINAR_CREATED_TRIGGERTrigger

Triggers when a new webinar is created for a user.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
page_sizeinteger
The number of webinars to fetch per API call (1-300).
user_idstring
The user's user ID or email address. Use 'me' for user-level apps to monitor your own webinars.

Payload del evento

agendastring
Agenda or description of the webinar.
created_atstring
Timestamp when the webinar was created in date-time format (ISO 8601).
durationinteger
Duration of the webinar in minutes.
host_idstring
User ID of the webinar host.
idinteger
Webinar ID, also known as the webinar number.
join_urlstring
URL for participants to join the webinar.
occurrencesobject[]
Array of occurrence objects for recurring webinars.
settingsobject
Webinar settings object containing various configuration options.
start_timestring
Scheduled start time of the webinar in date-time format (ISO 8601).
start_urlstring
URL for the host to start the webinar. Expiration time is two hours for regular users and 90 days for API users.
timezonestring
Timezone in which the webinar is scheduled.
topicstring
Topic or title of the webinar.
typeinteger
Webinar type. Values: 5 (Webinar), 6 (Recurring webinar with no fixed time), 9 (Recurring webinar with fixed time).
uuidstring
Unique identifier for the webinar instance.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors Zoom webinars for a specific user and fires when new webinars are created. - Use user_id='me' to monitor the authenticated user's webinars, or specify a user ID/email address. - Each webinar triggers only once when first detected. - Note: This trigger requires a Zoom webinar plan to be active for the user.

New Webinar ParticipantZOOM_NEW_WEBINAR_PARTICIPANT_TRIGGERTrigger

Triggers when a new participant appears in a past webinar's participant list.

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
page_sizeinteger
The number of participants to fetch per API call (max 300).
webinar_idstringObligatorio
The webinar's ID or universally unique ID (UUID). If you provide a webinar ID, the API returns a response for the latest webinar instance. If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you must double encode the webinar UUID before making an API request.

Payload del evento

attentiveness_scorestring
Participant's attentiveness score. Can be an empty string or a percentage value.
bo_mtg_idstring
Breakout room ID for participants in breakout rooms.
durationinteger
Participant duration in seconds.
idstring
Participant UUID. Unique identifier for the participant.
join_timestring
The time at which the participant joined the webinar. ISO 8601 date-time format.
leave_timestring
The time at which the participant left the webinar. ISO 8601 date-time format.
namestring
Participant display name.
registrant_idstring
The unique identifier for the registrant. Used to identify external participants.
user_emailstring
Email address of the participant.
user_idstring
Participant ID. User ID of the participant if they are an authenticated Zoom user.

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific past webinar for new participants. - You must provide the webinar ID or UUID to monitor. - The trigger will detect participants that appear in the participant list after the trigger is set up. - Note: This trigger is designed for past webinars. The participant list may take time to populate after a webinar ends.

User Information ChangedZOOM_USER_INFORMATION_CHANGED_TRIGGERTrigger

Triggers when a Zoom user's information changes. Detects changes such as: - Profile information updates (name, email, display name) - Role or type changes - Department, job title, or location updates - Contact information changes (phone, timezone) - Status changes (active, inactive, pending) - Settings updates (language, pronouns, etc.)

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
login_typeinteger
The user's login method to filter by (e.g., 1 for Google OAuth, 100 for Zoom Work email).
user_idstringObligatorio
The user ID or email address of the user to monitor. Use 'me' for the authenticated user.

Payload del evento

changes_detectedobject
Dictionary describing what changed (field names to old/new values)
event_typestringObligatorio
Type of change detected (user_updated)
userobjectObligatorio
Current state of the user information

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Zoom user for changes to their information. - You must provide a user ID, email address, or 'me' for the authenticated user. - The trigger detects: - Profile information changes (name, email, display name) - Role or user type changes - Department, job title, or location updates - Contact information changes (phone number, timezone) - Status changes (active, inactive, pending) - Settings updates (language, pronouns, verification status) - Excludes volatile fields (last_login_time, pic_url, created_at, last_client_version, jid) from change detection.

Webinar Details ChangedZOOM_WEBINAR_DETAILS_CHANGED_TRIGGERTrigger

Triggers when a Zoom webinar's details change. Detects changes such as: - Topic updates - Start time changes - Agenda modifications - Duration changes - Settings updates (host video, registration type, audio options, etc.) - Status changes - Occurrence updates for recurring webinars - Recurrence pattern changes

Configuración

intervalnumber
Periodic Interval to Check for Updates & Send a Trigger in Minutes
occurrence_idstring
Unique identifier for an occurrence of a recurring webinar. Leave blank for non-recurring webinars.
show_previous_occurrencesboolean
Set to True to view webinar details of all previous occurrences of a recurring webinar.
webinar_idstringObligatorio
The webinar's ID or universally unique ID (UUID) to monitor for changes.

Payload del evento

changes_detectedobject
Dictionary describing what changed (field names to old/new values)
event_typestringObligatorio
Type of change detected (webinar_updated)
webinarobjectObligatorio
Current state of the webinar details

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger monitors a specific Zoom webinar for changes to its details. - You must provide a webinar ID or UUID to monitor. - The trigger detects: - Topic, agenda, and description changes - Start time and duration modifications - Timezone changes - Settings updates (video, audio, registration, approval type, etc.) - Status changes - Occurrence updates for recurring webinars - Recurrence pattern changes - For recurring webinars, you can optionally specify an occurrence_id to monitor a specific occurrence. - Set show_previous_occurrences to True to include past occurrences in the monitoring. - Excludes volatile fields (start_url, join_url) from change detection.