Zoom Component

Easily manage users, meetings, and webinars in your Zoom account

Component key: zoom

Description

Zoom is a video teleconferencing software program developed by Zoom Video Communications. The Zoom component allows you to manage meetings, recordings, users and webinars.

Connections

OAuth 2.0

This component uses OAuth 2.0 to connect to Zoom's API. To create a Zoom OAuth 2.0 app, first visit the Zoom Marketplace. Log in and click Develop -> Build App.

Zoom auto generates a name for the App, it can be modified at the top left. You can add an icon in that same section.

Select how the app is going to be managed.

Take note of the Client ID and Client secret that were generated - these will be entered into Prismatic when you create an integration that uses the Zoom component. These IDs are essential for authenticating your integration with Zoom.

Add Prismatic's OAuth callback URL, https://oauth2.prismatic.io/callback, to the OAuth Redirect URL input. The OAuth Allow Lists input should be populated automatically with the same value.

Click Continue.

At this section (Access), you can activate Event Subscriptions. To do this, check the appropriate box and copy the Secret Token for webhooks verification and functionality.

You can ignore Surface and Embed sections by clicking Continue.

Add Scopes

Scopes determine what an integration is allowed to do on your customer's behalf. For example, scopes might include permissions for accessing meetings, webinars, recordings, and user information.

Add your required scopes for meetings, webinars, recordings, and users. You can omit other scopes, as this component does not implement actions for accounts, billing, etc.

You can also add a Scope Description for clarity.

Click Continue to complete the creation of your OAuth app.

Click Add App Now. You should be redirected to a Zoom consent screen. Click Allow. After that, the Prismatic's OAuth callback URL should open with an Authorization failed message. Ignore it.

You can now authenticate your integration with Zoom. Additional information on Zoom OAuth 2.0 apps is available in Zoom's documentation.

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://zoom.us/oauth/authorize	The OAuth 2.0 Authorization URL for Zoom
Client ID string / Required clientId		Client Identifier of your app for Zoom
Client Secret password / Required clientSecret		Client Secret of your app for Zoom
Scopes string Hidden Field scopes		Scopes are configured when a Zoom OAuth 2.0 app is created
Token URL string / Required Hidden Field tokenUrl	https://zoom.us/oauth/token	The OAuth 2.0 Token URL for Zoom

Triggers

Webhook

Receive and validate webhook requests from Zoom for webhooks you configure. | key: webhookReceiver

Input	Notes	Example
Zoom Webhook Secret Token string / Required webhookSecretToken	Please provide your Zoom webhook key.	x5Wkjt82gfjdhj___

Webhooks (Event Subscriptions) must be enabled for your Marketplace app with the following configurations:

A valid Event Notification Endpoint URL
The User has been activated subscription must be enabled under the User event.

To enable Event Subscriptions

In the designated Zoom App navigate to the Feature section and enable Event Subscriptions.
Select Add Event Subscriptions and name the subscription.
For the Event notification endpoint URL use the trigger URL provided in the designated flow of the Prismatic integration.
1. For example, https://hooks.prismatic.io/trigger/example.
Add the events you would like the integration to receive updates and save when completed.

Actions

Add Meeting Registrant

Add a new registrant to an existing meeting | key: addMeetingRegistrant

Input	Default	Notes	Example
Address string address		Provide a string value for the address.	122 S Privet dr
Auto Approve boolean autoApprove	false	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.
City string city		Provide a string value for the city	San Jose
Comments string comments		Provide a string value for comments.	These are some example comments.
Connection connection / Required connection
Country string country		Provide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries	US
Custom Questions code customQuestions		Provide an array custom questions for the registrant. Remove the default content if you do not want to include custom questions.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string / Required email		Provide a valid email address.	someone@example.com
First Name string / Required firstName		Provide a string value for the first name.	John
Industry string industry		Provide a string value for their industry	Computer Software
Job Title string jobTitle		Provide a string value for the job title.	Graphic Designer
Language string language		The registrant's language preference for confirmation emails.
Last Name string / Required lastName		Provide a string value for the last name	Doe
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503
Number Of Employees string numberOfEmployees		Provide a value form the supplied list.
Occurrence Ids string ocurrenceIds		A comma-separated list of meeting occurrence IDs.	1648194360000,1648367160000
Organization string org		Provide a string value for the registrant's organization.	Acme Inc.
Phone string phone		Provide a string value for the phone number.	15558904949
Purchasing Time Frame string purchasingTimeFrame		The registrant's purchasing time frame.
Role In Purchase Process string roleInPurchaseProcess		Provide a string value for the registrants role in the purchase process.
State string state		Provide a string value for the state or province.	California
Zip Code string zip		Provide a string value for the zipcode	90210

Example Payload for Add Meeting Registrant

{
  "data": {
    "id": 85746065,
    "join_url": "https://example.com/j/11111",
    "registrant_id": "fdgsfh2ey82fuh",
    "start_time": "2021-07-13T21:44:51Z",
    "topic": "My Meeting",
    "occurrences": [
      {
        "duration": 60,
        "occurrence_id": "1648194360000",
        "start_time": "2022-03-25T07:46:00Z",
        "status": "available"
      }
    ],
    "participant_pin_code": 380303
  }
}

Add Webinar Registrant

Add a new registrant of an existing webinar | key: addWebinarRegistrant

Input	Default	Notes	Example
Address string address		Provide a string value for the address.	122 S Privet dr
City string city		Provide a string value for the city	San Jose
Comments string comments		Provide a string value for comments.	These are some example comments.
Connection connection / Required connection
Country string country		Provide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries	US
Custom Questions code customQuestions		Provide an array custom questions for the registrant. Remove the default content if you do not want to include custom questions.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Email string / Required email		Provide a valid email address.	someone@example.com
First Name string / Required firstName		Provide a string value for the first name.	John
Industry string industry		Provide a string value for their industry	Computer Software
Job Title string jobTitle		Provide a string value for the job title.	Graphic Designer
Language string language		The registrant's language preference for confirmation emails.
Last Name string / Required lastName		Provide a string value for the last name	Doe
Number Of Employees string numberOfEmployees		Provide a value form the supplied list.
Occurrence Ids string ocurrenceIds		A comma-separated list of meeting occurrence IDs.	1648194360000,1648367160000
Organization string org		Provide a string value for the registrant's organization.	Acme Inc.
Phone string phone		Provide a string value for the phone number.	15558904949
Purchasing Time Frame string purchasingTimeFrame		The registrant's purchasing time frame.
Role In Purchase Process string roleInPurchaseProcess		Provide a string value for the registrants role in the purchase process.
Source Id string sourceId		The tracking source's unique identifier.	4816766181770
State string state		Provide a string value for the state or province.	California
Zip Code string zip		Provide a string value for the zipcode	90210

Example Payload for Add Webinar Registrant

{
  "data": {
    "id": 92674392836,
    "join_url": "https://example.com/j/22222",
    "registrant_id": "fdgsfh2ey82fuh",
    "start_time": "2021-07-13T21:44:51Z",
    "topic": "My Webinar",
    "occurrences": [
      {
        "duration": 60,
        "occurrence_id": "1648194360000",
        "start_time": "2022-03-25T07:46:00Z",
        "status": "available"
      }
    ]
  }
}

Create Meeting

Create a new meeting with an existing user as the host | key: createMeeting

Input	Default	Notes	Example
Agenda string agenda		Provide a string value for the agenda. This property has a maximum length of 2,000 characters.	In this meeting we will discuss...
Approval Type string approvalType	2	Enable meeting registration approval.
Audio Method string audio	both	How participants join the audio portion of the meeting.
Auto Recording string autoRecording	none	The automatic recording settings.
Global Dial In Countries string Value List availableDialInCountries		For each item specify the code of a country that is available for global dial in.	US
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Default Password boolean defaultPassword	false	Whether to generate a default passcode using the user's settings.
Duration string duration		Provide a value for the duration in minutes. This field is only used for scheduled meetings.	60
End Date Time string endDateTime		Select the final date when the meeting will recur before it is canceled. Cannot be used with the 'End Times' input.	2017-11-25T12:00:00Z
End Times string endTimes	1	Select how many times the meeting should recur before it is canceled. If set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with the 'End Date Time' input.	5
Host Video On Start boolean hostVideo	false	This flag will determine if the host's video is turned on by default.
Join Before Host boolean joinBeforeHost	false	This flag will determine if participants are allowed to join before the host.
Type string meetingType		Provide a value from the provided list.
Monthly Day string monthlyDay		Provide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected Type 3 for recurrence.	15
Monthly Week string monthlyWeek		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.
Monthly Week Day string monthlyWeekDay		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. Provide a value from 1 being Sunday to 7 being Saturday.	1
Mute Upon Entry boolean muteUponEntry	false	This flag will determine if participants are muted by default when they join.
Participant Video boolean participantVideo	false	This flag will determine if participants video is turned on by default.
Password string password		Provide a value up to 10 characters for the password.	examplePass
Pre Schedule boolean preSchedule	false	Whether to create a prescheduled meeting via the GSuite app.
Type Recurrence string recurrence		Pick a value from the provided list.
Registration Email Notifications boolean registrationEmailNotifications	false	Whether to send registrants email notifications about their registration approval, cancellation, or rejection.
Registration Type string registrationType	1	This field is only for recurring meetings with fixed times (8).
Repeat Interval string repeatInterval		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 field as 3.	1
Schedule For string scheduleFor		The email address or user ID of the user to schedule a meeting for.	example@email.com
Settings Extra Fields code settingsExtraFields		Provide additional fields for the settings object that are not covered by the other inputs. Remove the default content if you do not want to include extra fields. For more information, refer to the Zoom API documentation: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate
Start Time string startTime		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.	2021-12-15T12:02:00Z
Template Id string templateId		The account admin meeting template ID used to schedule a meeting using a meeting template.	AdxbhxCzKgSiWAw
Timezone string timezone		The timezone to assign to the 'Start Time' input 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 https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones	America/New_York
Topic string topic		The meeting's topic.	Daily Meeting
Tracking Fields code trackingFields		Information about the meeting's tracking fields. Remove the default content if you do not want to include tracking fields.
Use Personal Meeting ID boolean usePMI	false	This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.
User Id string / Required userId		Provide the unique identifier of a user.	89347503
Use Watermark boolean watermark	false	This flag will determine if a watermark will be displayed on screen share.
Weekly Day string weeklyDay		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. For instance, if the meeting should recur on Sunday, provide 1 as this field's value. To set the meeting to occur on multiple days of a week, provide comma separated values for this field like 1,3 to set the meeting to occur on Sunday and Tuesday.	1

Example Payload for Create Meeting

{
  "data": {
    "assistant_id": "kFFvsJc-Q1OSxaJQLvaa_A",
    "host_email": "jchill@example.com",
    "id": 92674392836,
    "registration_url": "https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6",
    "agenda": "My Meeting",
    "created_at": "2022-03-25T07:29:29Z",
    "duration": 60,
    "encrypted_password": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
    "pstn_password": "123456",
    "h323_password": "123456",
    "join_url": "https://example.com/j/11111",
    "chat_join_url": "https://example.com/launch/jc/11111",
    "occurrences": [
      {
        "duration": 60,
        "occurrence_id": "1648194360000",
        "start_time": "2022-03-25T07:46:00Z",
        "status": "available"
      }
    ],
    "password": "123456",
    "pmi": "97891943927",
    "pre_schedule": false,
    "recurrence": {
      "end_date_time": "2022-04-02T15:59:00Z",
      "end_times": 7,
      "monthly_day": 1,
      "monthly_week": 1,
      "monthly_week_day": 1,
      "repeat_interval": 1,
      "type": 1,
      "weekly_days": "1"
    },
    "settings": {
      "allow_multiple_devices": true,
      "alternative_hosts": "jchill@example.com;thill@example.com",
      "alternative_hosts_email_notification": true,
      "alternative_host_update_polls": true,
      "approval_type": 0,
      "approved_or_denied_countries_or_regions": {
        "approved_list": [
          "CX"
        ],
        "denied_list": [
          "CA"
        ],
        "enable": true,
        "method": "approve"
      },
      "audio": "telephony",
      "audio_conference_info": "test",
      "authentication_domains": "example.com",
      "authentication_exception": [
        {
          "email": "jchill@example.com",
          "name": "Jill Chill",
          "join_url": "https://example.com/s/11111"
        }
      ],
      "authentication_name": "Sign in to Zoom",
      "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
      "auto_recording": "cloud",
      "breakout_room": {
        "enable": true,
        "rooms": [
          {
            "name": "room1",
            "participants": [
              "jchill@example.com"
            ]
          }
        ]
      },
      "calendar_type": 1,
      "close_registration": false,
      "contact_email": "jchill@example.com",
      "contact_name": "Jill Chill",
      "custom_keys": [
        {
          "key": "key1",
          "value": "value1"
        }
      ],
      "email_notification": true,
      "encryption_type": "enhanced_encryption",
      "focus_mode": true,
      "global_dial_in_countries": [
        "US"
      ],
      "global_dial_in_numbers": [
        {
          "city": "New York",
          "country": "US",
          "country_name": "US",
          "number": "+1 1000200200",
          "type": "toll"
        }
      ],
      "host_video": true,
      "jbh_time": 0,
      "join_before_host": true,
      "language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "languages": "US,FR"
          }
        ]
      },
      "sign_language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "sign_language": "American"
          }
        ]
      },
      "meeting_authentication": true,
      "mute_upon_entry": false,
      "participant_video": false,
      "private_meeting": false,
      "registrants_confirmation_email": true,
      "registrants_email_notification": true,
      "registration_type": 1,
      "show_share_button": true,
      "use_pmi": false,
      "waiting_room": false,
      "watermark": false,
      "host_save_video_order": true,
      "internal_meeting": false,
      "meeting_invitees": [
        {
          "email": "jchill@example.com"
        }
      ],
      "continuous_meeting_chat": {
        "enable": true,
        "auto_add_invited_external_users": true,
        "channel_id": "cabc1234567defghijkl01234"
      },
      "participant_focused_meeting": false,
      "push_change_to_calendar": false,
      "resources": [
        {
          "resource_type": "whiteboard",
          "resource_id": "X4Hy02w3QUOdskKofgb9Jg",
          "permission_level": "editor"
        }
      ],
      "auto_start_meeting_summary": false,
      "auto_start_ai_companion_questions": false
    },
    "start_time": "2022-03-25T07:29:29Z",
    "start_url": "https://example.com/s/11111",
    "timezone": "America/Los_Angeles",
    "topic": "My Meeting",
    "tracking_fields": [
      {
        "field": "field1",
        "value": "value1",
        "visible": true
      }
    ],
    "type": 2
  }
}

Create User

Create a new user | key: createUser

Input	Default	Notes	Example
User Action string / Required action	create	The action to take to create the new user.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Display Name string displayName		The user's display name.	John Doe
Email string / Required email		Provide a valid email address.	someone@example.com
First Name string / Required firstName		Provide a string value for the first name.	John
Last Name string / Required lastName		Provide a string value for the last name	Doe
User Password password password		User password. Only used for the "autoCreate" function. The password has to have a minimum of 8 characters and maximum of 32 characters. By default (basic requirement), password must have at least one letter (a, b, c..), at least one number (1, 2, 3...) and include both uppercase and lowercase letters. It should not contain only one identical character repeatedly ('11111111' or 'aaaaaaaa') and it cannot contain consecutive characters ('12345678' or 'abcdefgh').	examplePass1
Plan United Type string planUnitedType		The type of Plan United user.
User Type string / Required userType		The value provided will determine the type of user that will be created.
Zoom One Type string zoomOneType		The type of Zoom One user.
Zoom Phone boolean zoomPhone	false	Whether the user has the Zoom Phone feature enabled.

Example Payload for Create User

{
  "data": {
    "email": "jchill@example.com",
    "first_name": "Jill",
    "id": "KDcuGIm1QgePTO8WbOqwIQ",
    "last_name": "Chill",
    "type": 1
  }
}

Delete User

Disassociate (unlink) a user or permanently delete a user by ID. | key: deleteUser

Input	Default	Notes	Example
Action string action	disassociate	Delete action options.
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Encrypted Email boolean encryptedEmail	false	Whether the email address passed for the 'User Id' value is an encrypted email address.
Transfer Email string transferEmail		Transfer email. This field is required if the user has Zoom Events/Sessions feature. After you delete or disassociate the user, the user's hub assets on Zoom Events site will be transferred to the target user.	jchill@example.com
Transfer Meeting boolean transferMeeting	false	Transfer meeting.
Transfer Recording boolean transferRecording	false	Transfer recording.
Transfer Webinar boolean transferWebinar	false	Transfer webinar.
Transfer Whiteboard boolean transferWhiteboard	false	When deleting a user, whether to transfer all their Zoom Whiteboard data to another user.
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for Delete User

{
  "data": {}
}

Get Meeting

Get the information and metadata of a meeting by Id | key: getMeeting

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503
Occurrence Id string ocurrenceId		Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.	1648194360000
Show Previous Occurrences boolean showPreviousOccurrences	false	Turn this flag ON to view meeting details of all previous occurrences of a recurring meeting.

Example Payload for Get Meeting

{
  "data": {
    "assistant_id": "kFFvsJc-Q1OSxaJQLvaa_A",
    "host_email": "jchill@example.com",
    "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
    "id": 97763643886,
    "uuid": "aDYlohsHRtCd4ii1uC2+hA==",
    "agenda": "My Meeting",
    "created_at": "2022-03-25T07:29:29Z",
    "duration": 60,
    "encrypted_password": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
    "pstn_password": "123456",
    "h323_password": "123456",
    "join_url": "https://example.com/j/11111",
    "chat_join_url": "https://example.com/launch/jc/11111",
    "occurrences": [
      {
        "duration": 60,
        "occurrence_id": "1648194360000",
        "start_time": "2022-03-25T07:46:00Z",
        "status": "available"
      }
    ],
    "password": "123456",
    "pmi": "97891943927",
    "pre_schedule": false,
    "recurrence": {
      "end_date_time": "2022-04-02T15:59:00Z",
      "end_times": 7,
      "monthly_day": 1,
      "monthly_week": 1,
      "monthly_week_day": 1,
      "repeat_interval": 1,
      "type": 1,
      "weekly_days": "1"
    },
    "settings": {
      "allow_multiple_devices": true,
      "alternative_hosts": "jchill@example.com;thill@example.com",
      "alternative_hosts_email_notification": true,
      "alternative_host_update_polls": true,
      "approval_type": 0,
      "approved_or_denied_countries_or_regions": {
        "approved_list": [
          "CX"
        ],
        "denied_list": [
          "CA"
        ],
        "enable": true,
        "method": "approve"
      },
      "audio": "telephony",
      "audio_conference_info": "test",
      "authentication_domains": "example.com",
      "authentication_exception": [
        {
          "email": "jchill@example.com",
          "name": "Jill Chill",
          "join_url": "https://example.com/s/11111"
        }
      ],
      "authentication_name": "Sign in to Zoom",
      "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
      "auto_recording": "cloud",
      "breakout_room": {
        "enable": true,
        "rooms": [
          {
            "name": "room1",
            "participants": [
              "jchill@example.com"
            ]
          }
        ]
      },
      "calendar_type": 1,
      "close_registration": false,
      "contact_email": "jchill@example.com",
      "contact_name": "Jill Chill",
      "custom_keys": [
        {
          "key": "key1",
          "value": "value1"
        }
      ],
      "email_notification": true,
      "encryption_type": "enhanced_encryption",
      "focus_mode": true,
      "global_dial_in_countries": [
        "US"
      ],
      "global_dial_in_numbers": [
        {
          "city": "New York",
          "country": "US",
          "country_name": "US",
          "number": "+1 1000200200",
          "type": "toll"
        }
      ],
      "host_video": true,
      "jbh_time": 0,
      "join_before_host": true,
      "language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "languages": "US,FR"
          }
        ]
      },
      "sign_language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "sign_language": "American"
          }
        ]
      },
      "meeting_authentication": true,
      "mute_upon_entry": false,
      "participant_video": false,
      "private_meeting": false,
      "registrants_confirmation_email": true,
      "registrants_email_notification": true,
      "registration_type": 1,
      "show_share_button": true,
      "use_pmi": false,
      "waiting_room": false,
      "watermark": false,
      "host_save_video_order": true,
      "internal_meeting": false,
      "meeting_invitees": [
        {
          "email": "jchill@example.com"
        }
      ],
      "continuous_meeting_chat": {
        "enable": true,
        "auto_add_invited_external_users": true,
        "channel_id": "cabc1234567defghijkl01234"
      },
      "participant_focused_meeting": false,
      "push_change_to_calendar": false,
      "resources": [
        {
          "resource_type": "whiteboard",
          "resource_id": "X4Hy02w3QUOdskKofgb9Jg",
          "permission_level": "editor"
        }
      ],
      "auto_start_meeting_summary": false,
      "auto_start_ai_companion_questions": false
    },
    "start_time": "2022-03-25T07:29:29Z",
    "start_url": "https://example.com/s/11111",
    "status": "waiting",
    "timezone": "America/Los_Angeles",
    "topic": "My Meeting",
    "tracking_fields": [
      {
        "field": "field1",
        "value": "value1",
        "visible": true
      }
    ],
    "type": 2
  }
}

Get Meeting Invitation

Get an invitation for a meeting | key: getMeetingInvitation

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503

Example Payload for Get Meeting Invitation

{
  "data": {
    "invitation": "Jill Chill is inviting you to a scheduled Zoom meeting.\r\n\r\nTopic: My Meeting\r\nTime: Mar 25, 2022 03:32 PM America, Los_Angeles\r\n\r\nJoin Zoom Meeting\r\nhttps://zoom.us/j/55544443210?pwd=8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1\r\n\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nOne tap mobile\r\n+5678901234,,55544443210#,,,,*123456# US (gg)\r\n\r\nDial by your location\r\n+1 15550100 US (gg)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nFind your local number: https://zoom.us/u/ab12cdef34jh\r\n\r\nJoin by SIP\r\n5550100@zoomcrc.com\r\n\r\nJoin by H.323\r\n192.0.2.1 (US West)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\n\r\n",
    "sip_links": [
      "5550100@zoomcrc.com"
    ]
  }
}

Get Meeting Recordings

Get a list of all recordings of a meeting | key: getMeetingRecordings

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Include Fields string includeFields		The download_access_token value for downloading the meeting's recordings.	a2f19f96-9294-4f51-8134-6f0eea108eb2
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503
Time To Live string ttl		The download_access_token Time to Live (TTL) value. This parameter is only valid if the 'Include Fields' input contains the download_access_token value. Min value is 0 and max value is 604800 (7 days).	86400

Example Payload for Get Meeting Recordings

{
  "data": {
    "account_id": "Cx3wERazSgup7ZWRHQM8-w",
    "duration": 20,
    "host_id": "_0ctZtY0REqWalTmwvrdIw",
    "id": 6840331990,
    "recording_count": 22,
    "start_time": "2021-03-18T05:41:36Z",
    "topic": "My Personal Meeting",
    "total_size": 22,
    "type": "1",
    "uuid": "BOKXuumlTAGXuqwr3bLyuQ==",
    "recording_play_passcode": "yNYIS408EJygs7rE5vVsJwXIz4-VW7MH",
    "recording_files": [
      {
        "deleted_time": "2021-03-18T05:41:36Z",
        "download_url": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
        "file_path": "/9090876528/path01/demo.mp4",
        "file_size": 7220,
        "file_type": "MP4",
        "file_extension": "M4A",
        "id": "72576a1f-4e66-4a77-87c4-f13f9808bd76",
        "meeting_id": "L0AGOEPVR9m5WSOOs/d+FQ==",
        "play_url": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
        "recording_end": "2021-03-18T05:41:36Z",
        "recording_start": "2021-03-18T05:41:36Z",
        "recording_type": "shared_screen_with_speaker_view",
        "status": "completed"
      }
    ],
    "download_access_token": "abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ",
    "password": "981651",
    "participant_audio_files": [
      {
        "download_url": "https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB",
        "file_name": "test.json",
        "file_path": "/9090876528/path01/demo.mp4",
        "file_size": 65536,
        "file_type": "M4A",
        "id": "a2f19f96-9294-4f51-8134-6f0eea108eb2",
        "play_url": "https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB",
        "recording_end": "2021-06-30T22:14:57Z",
        "recording_start": "2021-06-30T22:14:57Z",
        "status": "completed"
      }
    ]
  }
}

Get Phone Recordings

List all of the given users call recordings | key: getPhoneRecordings

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
From string from		The date range defined by the 'From' and 'To' inputs should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days.	2023-01-01 or 2023-01-01T00:00:00Z
To string to		Required only when the 'From' input is provided.	2023-01-16 or 2023-01-16T00:00:00Z
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for Get Phone Recordings

{
  "data": {
    "recordings": [
      {
        "call_id": "7025841973929235024",
        "call_log_id": "8f7345c5-0a65-4182-ab16-72fdb3be61ff",
        "callee_name": "User A",
        "callee_number": "1000001004",
        "callee_number_type": 1,
        "caller_name": "User B",
        "caller_number": "1000001028",
        "caller_number_type": 1,
        "outgoing_by": {
          "name": "User B",
          "extension_number": "123476"
        },
        "accepted_by": {
          "name": "User A",
          "extension_number": "101001"
        },
        "date_time": "2021-11-02T05:35:20Z",
        "direction": "inbound",
        "download_url": "https://domain/recording/download/EvVNLihbQ1WpeG_ALwnNzg",
        "duration": 11,
        "id": "8f7345c50a654182ab1672fdb3be61ff",
        "transcript_download_url": "https://domain/recording_transcript/download/8f7345c50a654182ab1672fdb3be61ff"
      }
    ]
  }
}

Get User

Get the information and metadata of a user by Id | key: getUser

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Encrypted Email boolean encryptedEmail	false	Whether the email address passed for the 'User Id' value is an encrypted email address.
Login Type string loginType		The user's login method.
Search By Unique Id boolean searchByUniqueId	false	Whether the queried 'User Id' value is an employee unique ID. This value defaults to false.
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for Get User

{
  "data": {
    "id": "zJKyaiAyTNC-MWjiWC18KQ",
    "dept": "Developers",
    "email": "jchill@example.com",
    "first_name": "Jill",
    "last_client_version": "5.9.6.4993(mac)",
    "last_login_time": "2021-05-05T20:40:30Z",
    "last_name": "Chill",
    "pmi": 3542471135,
    "role_name": "Admin",
    "timezone": "Asia/Shanghai",
    "type": 1,
    "use_pmi": false,
    "display_name": "Jill Chill",
    "account_id": "q6gBJVO5TzexKYTb_I2rpg",
    "account_number": 10009239,
    "cms_user_id": "KDcuGIm1QgePTO8WbOqwIQ",
    "company": "Jill",
    "user_created_at": "2018-10-31T04:32:37Z",
    "custom_attributes": [
      {
        "key": "cbf_cywdkexrtqc73f97gd4w6g",
        "name": "A1",
        "value": "1"
      }
    ],
    "employee_unique_id": "HqDyI037Qjili1kNsSIrIg",
    "group_ids": [
      "RSMaSp8sTEGK0_oamiA2_w"
    ],
    "im_group_ids": [
      "t-_-d56CSWG-7BF15LLrOw"
    ],
    "jid": "jchill@example.com",
    "job_title": "API Developer",
    "language": "en-US",
    "location": "Paris",
    "login_types": [
      101
    ],
    "manager": "thill@example.com",
    "personal_meeting_url": "example.com",
    "phone_numbers": [
      {
        "code": "+1",
        "country": "US",
        "label": "Mobile",
        "number": "800000000",
        "verified": true
      }
    ],
    "pic_url": "example.com",
    "plan_united_type": "1",
    "pronouns": "3123",
    "pronouns_option": 1,
    "role_id": "0",
    "status": "pending",
    "vanity_url": "example.com",
    "verified": 1,
    "cluster": "us04",
    "zoom_one_type": 4
  }
}

Get Webinar

Get the information and metadata of a webinar by Id | key: getWebinar

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Occurrence Id string occurrenceIdWebinar		Unique identifier for an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences.	1648538280000
Show Previous Occurrences boolean showPreviousOccurrencesWebinar	false	Turn this flag ON to view details of all previous occurrences of a recurring webinar.
Webinar Id string / Required webinarId		Provide the unique identifier of a webinar.	89347503

Example Payload for Get Webinar

{
  "data": {
    "host_email": "jchill@example.com",
    "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
    "id": 97871060099,
    "uuid": "m3WqMkvuRXyYqH+eKWhk9w==",
    "agenda": "My webinar",
    "created_at": "2022-03-26T07:18:32Z",
    "duration": 60,
    "join_url": "https://example.com/j/11111",
    "occurrences": [
      {
        "duration": 60,
        "occurrence_id": "1648194360000",
        "start_time": "2022-03-25T07:46:00Z",
        "status": "available"
      }
    ],
    "password": "123456",
    "encrypted_passcode": "8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1",
    "h323_passcode": "123456",
    "recurrence": {
      "end_date_time": "2022-04-02T15:59:00Z",
      "end_times": 7,
      "monthly_day": 1,
      "monthly_week": 1,
      "monthly_week_day": 1,
      "repeat_interval": 1,
      "type": 1,
      "weekly_days": "1"
    },
    "settings": {
      "allow_multiple_devices": true,
      "alternative_hosts": "jchill@example.com",
      "alternative_host_update_polls": true,
      "approval_type": 0,
      "attendees_and_panelists_reminder_email_notification": {
        "enable": true,
        "type": 0
      },
      "audio": "telephony",
      "audio_conference_info": "test",
      "authentication_domains": "example.com",
      "authentication_name": "Sign in to Zoom",
      "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
      "auto_recording": "cloud",
      "contact_email": "jchill@example.com",
      "contact_name": "Jill Chill",
      "email_language": "en-US",
      "follow_up_absentees_email_notification": {
        "enable": true,
        "type": 0
      },
      "follow_up_attendees_email_notification": {
        "enable": true,
        "type": 0
      },
      "global_dial_in_countries": [
        "US"
      ],
      "hd_video": false,
      "hd_video_for_attendees": false,
      "host_video": true,
      "language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "languages": "US,CN"
          }
        ]
      },
      "sign_language_interpretation": {
        "enable": true,
        "interpreters": [
          {
            "email": "interpreter@example.com",
            "sign_language": "American"
          }
        ]
      },
      "panelist_authentication": true,
      "meeting_authentication": true,
      "add_watermark": true,
      "add_audio_watermark": true,
      "notify_registrants": true,
      "on_demand": false,
      "panelists_invitation_email_notification": true,
      "panelists_video": true,
      "post_webinar_survey": true,
      "practice_session": false,
      "question_and_answer": {
        "allow_submit_questions": true,
        "allow_anonymous_questions": true,
        "answer_questions": "all",
        "attendees_can_comment": true,
        "attendees_can_upvote": true,
        "allow_auto_reply": true,
        "auto_reply_text": "Thank you for your question. We will get back to you shortly.",
        "enable": true
      },
      "registrants_confirmation_email": true,
      "registrants_email_notification": true,
      "registrants_restrict_number": 100,
      "registration_type": 1,
      "send_1080p_video_to_attendees": false,
      "show_share_button": true,
      "survey_url": "https://example.com",
      "enable_session_branding": true
    },
    "start_time": "2022-03-26T07:18:32Z",
    "start_url": "https://example.com/s/11111",
    "timezone": "America/Los_Angeles",
    "topic": "My Webinar",
    "tracking_fields": [
      {
        "field": "field1",
        "value": "value1"
      }
    ],
    "type": 5,
    "is_simulive": true,
    "record_file_id": "f09340e1-cdc3-4eae-9a74-98f9777ed908"
  }
}

List Meeting Registrants

Get the information and metadata of all registrants to a meeting by Id | key: listMeetingRegistrants

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503
Occurrence Id string ocurrenceId		Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.	1648194360000
Registrant Status string status	approved	Query by the registrant's status.

Example Payload for List Meeting Registrants

{
  "data": {
    "registrants": [
      {
        "id": "9tboDiHUQAeOnbmudzWa5g",
        "address": "1800 Amphibious Blvd.",
        "city": "Mountain View",
        "comments": "Looking forward to the discussion.",
        "country": "US",
        "custom_questions": [
          {
            "title": "What do you hope to learn from this?",
            "value": "Look forward to learning how you come up with new recipes and what other services you offer."
          }
        ],
        "email": "jchill@example.com",
        "first_name": "Jill",
        "industry": "Food",
        "job_title": "Chef",
        "last_name": "Chill",
        "no_of_employees": "1-20",
        "org": "Cooking Org",
        "phone": "5550100",
        "purchasing_time_frame": "1-3 months",
        "role_in_purchase_process": "Influencer",
        "state": "CA",
        "status": "approved",
        "zip": "94045",
        "create_time": "2022-03-22T05:59:09Z",
        "join_url": "https://example.com/j/11111",
        "participant_pin_code": 380303
      }
    ]
  }
}

List Meetings

List all meetings by user Id | key: listMeetings

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
From string from		The start date for the query.	2023-01-01 or 2023-01-01T00:00:00Z
Timezone string timezoneQuery		The timezone to assign to the 'From' and 'To' value.	America/New_York
To string to		The end date for the query.	2023-01-16 or 2023-01-16T00:00:00Z
Type Of Meeting string typeOfMeeting	scheduled	Query by the meeting type.
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for List Meetings

{
  "data": {
    "meetings": [
      {
        "agenda": "My Meeting",
        "created_at": "2022-03-23T05:31:16Z",
        "duration": 60,
        "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
        "id": 97763643886,
        "join_url": "https://example.com/j/11111",
        "pmi": "97891943927",
        "start_time": "2022-03-23T06:00:00Z",
        "timezone": "America/Los_Angeles",
        "topic": "My Meeting",
        "type": 2,
        "uuid": "aDYlohsHRtCd4ii1uC2+hA=="
      }
    ]
  }
}

List User's Channels

List all channels of a given user | key: listUsersChannels

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for List User's Channels

{
  "data": {
    "channels": [
      {
        "channel_settings": {
          "add_member_permissions": 2,
          "new_members_can_see_previous_messages_files": true,
          "posting_permissions": 3,
          "mention_all_permissions": 1,
          "allow_to_add_external_users": 2
        },
        "id": "cabc1234567defghijkl01234",
        "jid": "cabc1234567defghijkl01234@conference.xmpp.zoom.us",
        "name": "Developers",
        "type": 2,
        "channel_url": "https://zoom.us/launch/chat/v2/eyJzaWQiOiIyY2RkZjNyNjU3YTY0ODUzOWVhOThkODFhNjRiODE2YkBjb25mZXJlbmNlLnhtcHBkZXYuem9vbS51cyJ1"
      }
    ]
  }
}

List User's Chat Messages

List all chat messages of a given user | key: listUsersChatMessages

Input	Default	Notes	Example
Connection connection / Required connection
Date string date		The query date from which to retrieve the chat messages. This value defaults to the current date. If you do not provide the 'Date' or 'From' inputs, the API defaults to the 'Date' parameter.	2020-03-01
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Download File Formats string downloadFileFormats		This field returns the download URL in the specified format for different types of files. Currently, we only support the download URL in the .mp4 format for audio files. If this parameter is not specified, it returns the download URL of the file in its default format.	audio/mp4
Exclude Child Message boolean excludeChildMessage	false	This parameter excludes returning all child messages in a chat. It leaves only the parent messages.
From string from		The query start date in yyyy-MM-dd'T'HH:mm:ss'Z' format. If you provide both the 'Date' and 'from' inputs, the API uses the 'Date' input value to query.	2021-01-01T00:00:00Z
Include Deleted And Edited Message boolean includeDeletedAndEditedMessage	false	This field sets the value of this field to true to include edited and deleted messages in the response.
Search Key string searchKey		The query string for messages or files, up to 256 characters. If you use this input, you must also include a 'Search Type' input value. The 'To Contact' and the 'To Channel' inputs are not required when you use this input. If you do not call them, the API returns all contact and channel messages that match the 'Search Key' input. If you use this parameter, you cannot also query the 'Include Deleted And Edited Message' input. This parameter does not support the return of deleted or updated messages.	hello
Search Type string searchType		The type of search. If you use this input, you must also include a 'Search Key' input value. The 'To Contact' and the 'To Channel' inputs are not required when you use this input. If you do not call them, the API returns all contact and channel messages that match the 'Search Type' input. If you use this parameter, you cannot also query the 'Include Deleted And Edited Message' input. This parameter does not support the return of deleted or updated messages.
To string to		The query end date in yyyy-MM-dd'T'HH:mm:ss'Z' format. This value defaults to the current date.	2021-01-01T00:00:00Z
To Channel string toChannel		This field allows you to query by the channel ID of a channel in which the user had chat conversations. The API only returns messages sent and received by the user in the queried channel. You must provide either the 'To Contact' or the 'To Channel' query parameter. When you use the 'Search Key' and 'Search Type' parameters, this parameter is optional and not required. You must provide either the to_contact or the to_channel query parameter. When you call the 'Search Key' and 'Search Type' query parameters, this query parameter is optional and not required.	qrstuvwxyz67890
To Contact string toContact		This field allows you to query by the email address, user ID, or member ID of a chat contact with whom the user communicated. The API only returns messages sent and received between the user and the queried contact. You must provide either the 'To Contact' or the 'To Channel' query parameter. When you use the 'Search Key' and 'Search Type' parameters, this parameter is optional and not required.	jchill@example.com
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for List User's Chat Messages

{
  "data": {
    "messages": [
      {
        "bot_message": {},
        "date_time": "2020-02-10T21:39:50Z",
        "files": [
          {
            "download_url": "https://zoom.us/file/download/xBvggqyjQUal6TecwMlYwQ?filename=example.jpg&jwt=eyJhbGciOiJIUzI1NiJ9.eyJkaWciOiI3Yzg5YzBhYjIzYmZmMjdjNzE3NTQ4YzdjMTc0Njk3MWYzYjNmNjFjMzU5OTliNjE1ZjdjMWJmMzc5YTJiZThlIiwiYXVkIjoiZmlsZSIsImlzcyI6ImNyb3NzZmlsZSIsImV4cCI6MTY0ODI2NDY5N30.2fQxw3F1cEhvFJmnE2zPOdkHnPeZUktv_P0M--e-Tg8",
            "file_id": "xBvggqyjQUal6TecwMlYwQ",
            "file_name": "example.jpg",
            "file_size": 3966
          }
        ],
        "rich_text": [
          {
            "start_position": 0,
            "end_position": 5,
            "format_type": "Paragraph",
            "format_attr": "h1"
          }
        ],
        "download_url": "https://zoom.us/file/download/xBvggqyjQUal6TecwMlYwQ?filename=example.jpg&jwt=eyJhbGciOiJIUzI1NiJ9.eyJkaWciOiI3Yzg5YzBhYjIzYmZmMjdjNzE3NTQ4YzdjMTc0Njk3MWYzYjNmNjFjMzU5OTliNjE1ZjdjMWJmMzc5YTJiZThlIiwiYXVkIjoiZmlsZSIsImlzcyI6ImNyb3NzZmlsZSIsImV4cCI6MTY0ODI2NDY5N30.2fQxw3F1cEhvFJmnE2zPOdkHnPeZUktv_P0M--e-Tg8",
        "file_id": "xBvggqyjQUal6TecwMlYwQ",
        "file_name": "example.jpg",
        "file_size": 3966,
        "id": "EAB58B01-B35F-4F97-BA69-F9650F54679A",
        "message": "hello, world!",
        "reactions": [
          {
            "emoji": "U+1F600",
            "total_count": 1,
            "senders": [
              {
                "user_id": "v4iyWT1LTfy8QvPG4GTvdg",
                "member_id": "R4VM29Oj0fVM2hhEmSKVM2hhezJTezJTKVM2hezJT2hezJ"
              }
            ]
          }
        ],
        "reply_main_message_id": "27ED2949-6457-417C-83EA-72515DAF00BD",
        "reply_main_message_timestamp": 1581370790388,
        "sender": "jchill@example.com",
        "sender_member_id": "R4VM29Oj0fVM2hhEmSKVM2hhezJTezJTKVM2hezJT2hezJTSK",
        "sender_display_name": "Tom",
        "status": "Edited",
        "timestamp": 1581370790388,
        "at_items": [
          {
            "at_contact": "v4iyWT1LTfy8QvPG4GTvdg",
            "at_contact_member_id": "R4VM29Oj0fVM2hhEmSKVM2hhezJTezJTKVM2hezJT2hezJTSK",
            "at_type": 2,
            "end_position": 8,
            "start_position": 0
          }
        ]
      }
    ]
  }
}

List Users

List all users connected to your Zoom account | key: listUsers

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Include Fields string includeFields		The download_access_token value for downloading the meeting's recordings.	a2f19f96-9294-4f51-8134-6f0eea108eb2
License string license		The user's license. Filter the response by a specific license.
Role Id string roleId		The role's unique ID. Use this parameter to filter the response by a specific role.	0
User Status string status	active	The user's status.

Example Payload for List Users

{
  "data": {
    "users": [
      {
        "user_created_at": "2019-06-01T07:58:03Z",
        "custom_attributes": [
          {
            "key": "cbf_cywdkexrtqc73f97gd4w6g",
            "name": "A1",
            "value": "2323"
          }
        ],
        "dept": "Developers",
        "email": "jchill@example.com",
        "employee_unique_id": "HqDyI037Qjili1kNsSIrIg",
        "first_name": "Jill",
        "group_ids": [
          "t-_-d56CSWG-7BF15LLrOw"
        ],
        "host_key": "299492849",
        "id": "KDcuGIm1QgePTO8WbOqwIQ",
        "im_group_ids": [
          "t-_-d56CSWG-7BF15LLrOw"
        ],
        "last_client_version": "5.2.45120.0906(win)",
        "last_login_time": "2022-03-25T05:40:55Z",
        "last_name": "Chill",
        "plan_united_type": "1",
        "pmi": 6589310093,
        "role_id": "0",
        "status": "active",
        "timezone": "Asia/Shanghai",
        "type": 1,
        "verified": 1,
        "display_name": "Jill Chill"
      }
    ]
  }
}

List Webinar Participants

List all participants of a given webinar | key: listWebinarParticipants

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Webinar Id string / Required webinarId		Provide the unique identifier of a webinar.	89347503

Example Payload for List Webinar Participants

{
  "data": {
    "participants": [
      {
        "id": "30R7kT7bTIKSNUFEuH_Qlg",
        "name": "Jill Chill",
        "user_id": "ABCDEF123456",
        "registrant_id": "_f08HhPJS82MIVLuuFaJPg",
        "user_email": "jchill@example.com",
        "join_time": "2019-02-01T12:34:12.660Z",
        "leave_time": "2019-02-01T12:54:12.660Z",
        "duration": 20,
        "failover": false,
        "status": "in_meeting"
      }
    ]
  }
}

List Webinar Registrants

List all registrants of a given webinar. | key: listWebinarRegistrants

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Occurrence Id string occurrenceIdWebinarQuery		The meeting or webinar occurrence ID.	1648194360000
Registrant Status string registrantStatus	approved	Query by the registrant's status.
Tracking Source Id string trackingSourceId		The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations.	5516482804110
Webinar Id string / Required webinarId		Provide the unique identifier of a webinar.	89347503

Example Payload for List Webinar Registrants

{
  "data": {
    "registrants": [
      {
        "id": "9tboDiHUQAeOnbmudzWa5g",
        "address": "1800 Amphibious Blvd.",
        "city": "Mountain View",
        "comments": "Looking forward to the discussion.",
        "country": "US",
        "custom_questions": [
          {
            "title": "What do you hope to learn from this?",
            "value": "Look forward to learning how you come up with new recipes and what other services you offer."
          }
        ],
        "email": "jchill@example.com",
        "first_name": "Jill",
        "industry": "Food",
        "job_title": "Chef",
        "last_name": "Chill",
        "no_of_employees": "1-20",
        "org": "Cooking Org",
        "phone": "5550100",
        "purchasing_time_frame": "1-3 months",
        "role_in_purchase_process": "Influencer",
        "state": "CA",
        "status": "approved",
        "zip": "94045",
        "create_time": "2022-03-22T05:59:09Z",
        "join_url": "https://example.com/j/11111"
      }
    ]
  }
}

List Webinars

List all webinars for the given user | key: listWebinars

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Webinar Type string type		The type of webinar.
User Id string / Required userId		Provide the unique identifier of a user.	89347503

Example Payload for List Webinars

{
  "data": {
    "webinars": [
      {
        "agenda": "Learn more about Zoom APIs",
        "created_at": "2021-07-01T22:00:00Z",
        "duration": 60,
        "host_id": "x1yCzABCDEfg23HiJKl4mN",
        "id": 1234567890,
        "join_url": "https://example.com/j/11111",
        "start_time": "2021-07-13T21:00:00Z",
        "timezone": "America/Los_Angeles",
        "topic": "My Webinar",
        "type": 9,
        "uuid": "4444AAAiAAAAAiAiAiiAii==",
        "is_simulive": true
      }
    ]
  }
}

Raw Request

Send raw HTTP request to Zoom | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/workspaces), The base URL is already included (https://api.zoom.us/v2). For example, to connect to https://api.zoom.us/v2/workspaces, only /workspaces is entered in this field.	/workspaces
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Update Meeting

Update the information and metadata of an existing meeting by Id | key: updateMeeting

Input	Default	Notes	Example
Agenda string agenda		Provide a string value for the agenda. This property has a maximum length of 2,000 characters.	In this meeting we will discuss...
Approval Type string approvalType	2	Enable meeting registration approval.
Audio Method string audio	both	How participants join the audio portion of the meeting.
Auto Recording string autoRecording	none	The automatic recording settings.
Global Dial In Countries string Value List availableDialInCountries		For each item specify the code of a country that is available for global dial in.	US
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Duration string duration		Provide a value for the duration in minutes. This field is only used for scheduled meetings.	60
End Date Time string endDateTime		Select the final date when the meeting will recur before it is canceled. Cannot be used with the 'End Times' input.	2017-11-25T12:00:00Z
End Times string endTimes	1	Select how many times the meeting should recur before it is canceled. If set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with the 'End Date Time' input.	5
Host Video On Start boolean hostVideo	false	This flag will determine if the host's video is turned on by default.
Join Before Host boolean joinBeforeHost	false	This flag will determine if participants are allowed to join before the host.
Meeting Id string / Required meetingId		Provide the unique identifier of a meeting.	89347503
Type string meetingType		Provide a value from the provided list.
Monthly Day string monthlyDay		Provide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected Type 3 for recurrence.	15
Monthly Week string monthlyWeek		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.
Monthly Week Day string monthlyWeekDay		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. Provide a value from 1 being Sunday to 7 being Saturday.	1
Mute Upon Entry boolean muteUponEntry	false	This flag will determine if participants are muted by default when they join.
Occurrence Id string occurrenceIdQuery		Meeting occurrence ID.	1648194360000
Participant Video boolean participantVideo	false	This flag will determine if participants video is turned on by default.
Password string password		Provide a value up to 10 characters for the password.	examplePass
Pre Schedule boolean preSchedule	false	Whether to create a prescheduled meeting via the GSuite app.
Type Recurrence string / Required recurrence		Pick a value from the provided list.
Registration Email Notifications boolean registrationEmailNotifications	false	Whether to send registrants email notifications about their registration approval, cancellation, or rejection.
Registration Type string registrationType	1	This field is only for recurring meetings with fixed times (8).
Repeat Interval string repeatInterval		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 field as 3.	1
Schedule For string scheduleFor		The email address or user ID of the user to schedule a meeting for.	example@email.com
Settings Extra Fields code settingsExtraFields		Provide additional fields for the settings object that are not covered by the other inputs. Remove the default content if you do not want to include extra fields. For more information, refer to the Zoom API documentation: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate
Start Time string startTime		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.	2021-12-15T12:02:00Z
Template Id string templateId		The account admin meeting template ID used to schedule a meeting using a meeting template.	AdxbhxCzKgSiWAw
Timezone string timezone		Provide a string value for a valid timezone. Refer to the Id value in the timezone list: https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones	America/New_York
Topic string topic		Provide a string value for the topic.	Daily Meeting
Tracking Fields code trackingFields		Information about the meeting's tracking fields. Remove the default content if you do not want to include tracking fields.
Use Personal Meeting ID boolean usePMI	false	This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.
Use Watermark boolean watermark	false	This flag will determine if a watermark will be displayed on screen share.
Weekly Day string weeklyDay		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. For instance, if the meeting should recur on Sunday, provide 1 as this field's value. To set the meeting to occur on multiple days of a week, provide comma separated values for this field like 1,3 to set the meeting to occur on Sunday and Tuesday.	1

Example Payload for Update Meeting

{
  "data": {}
}

Update User

Update the information or metadata of a user by Id | key: updateUser

Input	Default	Notes	Example
About Me string aboutMe		The user's self-introduction. Hyperlinks or HTML code not allowed in this field.	I love Zoom!
CMS User Id string cmsUserId		Provide a string value for the user Id in the CMS.	KDcuGIm1QgePTO8WbOqwIQ
Company string company		Provide a string value for the company.	Acme Inc.
Connection connection / Required connection
Custom Attributes code customAttributes		The user's assigned custom attributes. Remove the default content if you do not want to include custom attributes.
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Timezone string dept		Provide a string value for the department of the user.	Example Department
Display Name string displayName		The user's display name.	John Doe
First Name string firstName		Provide a string value for the first name.	John
Group Id string groupId		Provide the unique identifier of the group that you would like to add a pending user to.	RSMaSp8sTEGK0_oamiA2_w
Host Key string hostKey		Provide a 6-10 digit value for the host key of the user.	4692486817
Job Title string jobTitle		Provide a string value for the job title.	Graphic Designer
User Language string language		The user's language.	English
Last Name string lastName		Provide a string value for the last name	Doe
LinkedIn URL string linkedinUrl		The user's LinkedIn URL.	https://www.linkedin.com/in/johndoe
Location string location		Provide a string value for the location.	United States
Login Type string loginType		The user's login method.
Manager string manager		The user's assigned manager.	John Doe
Phone Numbers code phoneNumbers		Information about the user's assigned phone numbers. Remove the default content if you do not want to include phone numbers. Allowed label values are: Mobile┃Office┃Home┃Fax
Plan United Type string planUnitedTypeUpdate		The Plan United plan option.
Personal Meeting Id string pmi		Provide an integer value for the personal meeting Id of a user.	1234567890
Pronouns string pronouns		The user's pronouns.	He/Him
Pronouns string pronounsOption		The user's pronouns.
Remove TSP Credentials boolean removeTspCredentials	false	Whether to remove the user's TSP credentials.
Timezone string timezone		Provide a string value for a valid timezone. Refer to the Id value in the timezone list: https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones	America/New_York
Use Personal Meeting ID boolean usePMI	false	This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id.
User Id string / Required userId		Provide the unique identifier of a user.	89347503
User Type string userType		The type of user.
Vanity Name string vanityName		This value will determine the name of your personal meeting room.	Example Name
Zoom One Type string zoomOneTypeUpdate		The Zoom One plan option.
Zoom Phone boolean zoomPhone	false	Whether the user has the Zoom Phone feature enabled.

Example Payload for Update User

{
  "data": {}
}

Easily manage users, meetings, and webinars in your Zoom account

Description​

Connections​

OAuth 2.0​

Add Scopes​

Triggers​

Webhook​

Actions​

Add Meeting Registrant​

Add Webinar Registrant​

Create Meeting​

Create User​

Delete User​

Get Meeting​

Get Meeting Invitation​

Get Meeting Recordings​

Get Phone Recordings​

Get User​

Get Webinar​

List Meeting Registrants​

List Meetings​

List User's Channels​

List User's Chat Messages​

List Users​

List Webinar Participants​

List Webinar Registrants​

List Webinars​

Raw Request​

Update Meeting​

Update User​