Skip to main content

Zoom

This Integration is part of the Zoom Pack.#

Use the Zoom integration manage your Zoom users and meetings This integration was integrated and tested with version 2.0.0 of Zoom

Configure Zoom on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Zoom.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Server URL (e.g. 'https://api.zoom.us/v2/')False
    Account ID (OAuth)False
    Client ID (OAuth)False
    Client Secret (OAuth)False
    API Key (JWT-Deprecated.)This authentication method will be deprecated by Zoom in June 2023.False
    API Secret (JWT-Deprecated.)This authentication method will be deprecated by Zoom in June 2023.False
    API Key (JWT-Deprecated.)This authentication method will be deprecated by Zoom in June 2023.False
    API Secret (JWT-Deprecated.)This authentication method will be deprecated by Zoom in June 2023.False
    Use system proxy settingsFalse
    Trust any certificate (not secure)False
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

zoom-create-user#


Create a new user in zoom account

Base Command#

zoom-create-user

Input#

Argument NameDescriptionRequired
first_nameFirst name of the new user.Required
last_nameLast name of the new user.Required
emailThe email of the new user.Required
user_typeThe type of the newly created user. Note: the old type "pro" in now called "Licensed", and the type "Corporate" is not sopprted in Zoom v2 and above.
. Possible values are: Basic, Licensed, pro, Corporate. Default is Basic.
Optional

Context Output#

PathTypeDescription
Zoom.User.idstringThe ID of the created user
Zoom.User.first_namestringFirst name of the created user
Zoom.User.last_namestringLast name for the created user
Zoom.User.emailstringEmail of the created user
Zoom.User.created_atdateCreated date of the user. Note that this field does not appear in zoom v2 and above.
Zoom.User.typenumberThe type of the user

Command example#

!zoom-create-user email=example@example.com first_name=john last_name=smith user_type=Basic

Context Example#

{
"Zoom": {
"User": {
"email": "example@example.com",
"first_name": "john",
"id": "wSQafNLNSJWq_oBzmT7XOw",
"last_name": "smith",
"type": 1
}
}
}

Human Readable Output#

User created successfully with ID: wSQafNLNSJWq_oBzmT7XOw

zoom-create-meeting#


Create a new zoom meeting (scheduled ,instant, or recurring)

Base Command#

zoom-create-meeting

Input#

Argument NameDescriptionRequired
typeThe type of the meeting. Possible values are: Instant, Scheduled, Recurring meeting with fixed time. Default is Instant.Required
end_date_timeFor recurring meetings only. Select the final date on which the meeting will recur before it is canceled
For example: 2017-11-25T12:00:00Z
.
Optional
end_timesFor recurring meetings only.
Select how many times the meeting should recur before it is canceled.
max = 365. Default = 1.
.
Optional
monthly_dayFor recurring meetings with Monthly recurrence_type only.
State the day in a month, the meeting should recur. The value range is from 1 to 31. Default = 1.
.
Optional
monthly_weekFor recurring meetings with Monthly recurrence_type only.
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. Allowed: -1 (for last week of the month) ┃1┃2┃3┃4
.
Optional
monthly_week_dayFor recurring meetings with Monthly recurrence_type only.
State a specific day in a week when the monthly meeting should recur. Allowed: 1┃2┃3┃4┃5┃6┃7
To use this field, you must also use the monthly_week field.
.
Optional
repeat_intervalFor recurring meeting with fixed time only.
Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as 2 and the value of the type parameter as Monthly.
For a daily meeting, the maximum is 90 days. For a weekly meeting the maximum is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.
.
Optional
recurrence_typeFor recurring meetings only.
Set the recurrence meeting types.
. Possible values are: Daily, Weekly, Monthly.
Optional
weekly_daysFor recurring meetings with a Weekly recurrence_type only.
State a specific day in a week when the weekly meeting should recur. Allowed: 1┃2┃3┃4┃5┃6┃7 Default = 1.
.
Optional
auto-record-meetingThe automatic recording settings.
Note that the Cloud option is available for zoom paid customers only.
. Possible values are: local, cloud, none. Default is none.
Optional
encryption_typeThe type of end-to-end (E2EE) encryption, enhanced_encryption or e2ee. Possible values are: enhanced_encryption, e2ee. Default is enhanced_encryption.Optional
host_videostart meetings with the host video on. Possible values are: true, false. Default is True.Optional
join_before_host_timeIf the value of the join_before_host field is true, this field sets the time that a participant can join before the meeting's host.
You can choose: 5 or 10 (minuts), or 0 for any time.
. Possible values are: 0, 5, 10.
Optional
join_before_hostWhether participants can join the meeting before its host. For scheduled or recurring meetings only. The default value is False. Possible values are: false, true.Optional
meeting_authenticationIf true, only authenticated users can join the meeting. Possible values are: false, true. Default is false.Optional
useremail address or id of user for meeting.Required
topicThe topic of the meeting.Required
waiting_roomThis allows the host to control when a participant joins the meeting. The default is False. Possible values are: false, true.Optional
start-timeMeeting start time. When using a format like “yyyy-MM-ddTHH:mm:ssZ”, always use GMT time. When using a format like “yyyy-MM-ddTHH:mm:ss”, you should use local time and you will need to specify the time zone. Only used for scheduled meetings and recurring meetings with fixed time.Optional
timezoneTimezone to format start_time. For example, “America/Los_Angeles”. For scheduled meetings only. .Optional

Context Output#

PathTypeDescription
Zoom.Meeting.join_urlstringJoin url for the meeting
Zoom.Meeting.idstringMeeting id of the new meeting that is created
Zoom.Meeting.start_urlstringThe URL to start the meeting
Zoom.Meeting.uuidstringUnique meeting ID of the new meeting that is created
Zoom.Meeting.statusstringThe status of the meeting
Zoom.Meeting.start_timeDateThe time that the meeting will start at
Zoom.Meeting.host emailstringThe email of the host of this meeting
Zoom.Meeting.topicstringThe topic of the meeting
Zoom.Meeting.durationnumberThe duratian of the meeting
Zoom.Meeting.created_atDateThe time that this meeting was created
Zoom.Meeting.typenumberThe type of the new meeting, Instant = 1, Scheduled =2,Recurring with fixed time = 8

Command example#

!zoom-create-meeting topic=test type=scheduled user=example@example.com start-time=2023-01-29T12:12:12Z

Context Example#

{
"Zoom": {
"Meeting": {
"created_at": "2023-01-15T12:44:30Z",
"duration": 60,
"host_email": "example@example.com",
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 88454393857,
"join_url": "https://us06web.zoom.us/j/8845?pwd=WkI1WUdvbHhnMlJuaXU1WDNPdz09",
"pre_schedule": false,
"settings": {
"allow_multiple_devices": false,
"alternative_host_update_polls": false,
"alternative_hosts": "",
"alternative_hosts_email_notification": true,
"approval_type": 2,
"approved_or_denied_countries_or_regions": {
"enable": false
},
"audio": "both",
"auto_recording": "none",
"breakout_room": {
"enable": false
},
"close_registration": false,
"cn_meeting": false,
"device_testing": false,
"email_notification": true,
"enable_dedicated_group_chat": false,
"encryption_type": "enhanced_encryption",
"enforce_login": false,
"enforce_login_domains": "",
"focus_mode": false,
"global_dial_in_countries": [
"US"
],
"global_dial_in_numbers": [
{
"city": "Houston",
"country": "US",
"country_name": "US",
"number": "+1 3462487799",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3602095623",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3863475053",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 5074734847",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 5642172000",
"type": "toll"
},
{
"city": "New York",
"country": "US",
"country_name": "US",
"number": "+1 6465588656",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 6469313860",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 6694449171",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 6892781000",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 7193594580",
"type": "toll"
},
{
"city": "Denver",
"country": "US",
"country_name": "US",
"number": "+1 7207072699",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 2532050468",
"type": "toll"
},
{
"city": "Tacoma",
"country": "US",
"country_name": "US",
"number": "+1 2532158782",
"type": "toll"
},
{
"city": "Washington DC",
"country": "US",
"country_name": "US",
"number": "+1 3017158592",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3052241968",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3092053325",
"type": "toll"
},
{
"city": "US",
"country": "US",
"country_name": "US",
"number": "+1 3126266799",
"type": "toll"
}
],
"host_save_video_order": false,
"host_video": true,
"in_meeting": false,
"jbh_time": 0,
"join_before_host": false,
"meeting_authentication": false,
"mute_upon_entry": false,
"participant_video": false,
"private_meeting": false,
"registrants_confirmation_email": true,
"registrants_email_notification": true,
"request_permission_to_unmute_participants": false,
"show_share_button": false,
"use_pmi": false,
"waiting_room": false,
"watermark": false
},
"start_time": "2023-01-29T12:12:12Z",
"start_url": "https://us06web.zoom.us/s/883857?zIjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4NDU0MzkzODU3IiwiZXhwIjoxNjczNzkzODcwLCJpYXQiOjE2NzM3ODY2NzAsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.5vRJBkMbmODUD_7H3bkS7OjR-MuuLUzNMJ_KeCzWc_U",
"status": "waiting",
"timezone": "Asia/Jerusalem",
"topic": "test",
"type": 2,
"uuid": "4gbib+fjTFmz1wH1LoE7EQ=="
}
}
}

Human Readable Output#

Meeting details#

uuididhost_idhost_emailtopictypestatusstart_timedurationtimezonecreated_atstart_urljoin_url
4gbib+fjTFmz1wH1LoE7EQ==88454393857uJiZN-O7Rp6Jp_995FpZGgexample@example.comtest2waiting2023-01-29T12:12:12Z60Asia/Jerusalem2023-01-15T12:44:30Zhttps://us06web.zoom.us/s/88454393857?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4NDU0MzkzODU3IiwiZXhwIjoxNjczNzkzODcwLCJpYXQiOjE2NzM3ODY2NzAsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.5vRJBkMbmODUD_7H3bkS7OjR-MuuLUzNMJ_KeCzWc_Uhttps://us06web.zoom.us/j/88454393857?pwd=WkI1WnVEWUdvbHhnMlJuaXU1WDNPdz09

zoom-fetch-recording#


Get meeting record and save as file in the warroom

Base Command#

zoom-fetch-recording

Input#

Argument NameDescriptionRequired
meeting_idMeeting ID of the recorded meeting.Required
delete_afterWhether to delete the recording from the cloud after downloading. Possible values are: false, true. Default is true.Optional

Context Output#

PathTypeDescription
File.SHA256UnknownAttachment's SHA256
File.SHA1UnknownAttachment's SHA1
File.MD5UnknownAttachment's MD5
File.NameUnknownAttachment's Name
File.InfoUnknownAttachment's Info
File.SizeUnknownAttachment's Size (In Bytes)
File.ExtensionUnknownAttachment's Extension
File.TypeUnknownAttachment's Type
File.EntryIDUnknownAttachment's EntryID
File.SSDeepUnknownAttachment's SSDeep hash

Command example#

!zoom-fetch-recording meeting_id=83622325727 delete_after=false

Context Example#

{
"File": [
{
"EntryID": "446@37e93103-1bd6-4776-8021-0f7023b1bb79",
"Extension": "MP4",
"Info": "video/mp4",
"MD5": "0de01f8f6d037e9ebecde2f91ad9b7a3",
"Name": "recording_83622325727_d831fbd5-3938-44d0-b30b-962bf76e2916.MP4",
"SHA1": "c81f9abb6dcf9be42dae99bc5e1501c43496d66e",
"SHA256": "8b252b01c8e6af62b88de64abf80d360467da1598dcd6b50ac9a252ffafb2eb5",
"SHA512": "b273e90a9cd0589eaba1c5e647fedab7b46e198193a54bec70a18def9ada57575833ea89b6eabf7f5852c3dc98b862780793d3e87e32a238ec2a7acffdba2495",
"SSDeep": "1536:TDWnSNbM8oEWzjSn7anYBcoGdee32hfUunvSHx8:T6t8JWzjSWnYBcoG9325UunvSHq",
"Size": 320333,
"Type": "ISO Media, MP4 v2 [ISO 14496-14]"
},
{
"EntryID": "447@37e93103-1bd6-4776-8021-0f7023b1bb79",
"Extension": "M4A",
"Info": "video/mp4",
"MD5": "e826111564499ca8021d0ddfcfde064b",
"Name": "recording_83622325727_19bf5f8a-e77c-4b75-b09e-13983521703c.M4A",
"SHA1": "50d3386dc5b74935b8f8d541f319df34a49f90a0",
"SHA256": "2719528cf61358ccbee861fb8e42d9d5fb37390baa22d0dc7dad1aa7e3935146",
"SHA512": "74bfb40ade824e6e36329b3e2335b2028fac648d3ecef1a02e9be93d4a455e3acf4c1f9c844d1c2ebcc661d4c84d66c1da4f0ca0462eabc12bf2dff84006d460",
"SSDeep": "24:fctSXvr4S+08n11/TlllZltk2B0tDilduxEJvCXyxrApd4dEcpXuFxnZQ4r:uYr41Xnf/T/vX/8OvqyrjiCuFhZQK",
"Size": 243652,
"Type": "ISO Media, MP4 v2 [ISO 14496-14]"
}
]
}

Human Readable Output#

The Audio file recording_83622325727_19bf5f8a-e77c-4b75-b09e-13983521703c.M4A was downloaded successfully

zoom-list-users#


List the existing users

Base Command#

zoom-list-users

Input#

Argument NameDescriptionRequired
statusWhich status of users to list. Possible values are: active, inactive, pending. Default is active.Optional
page-sizeNumber of users to return. Max 300. The default is 30.Optional
next_page_tokenThe next page token is used to get the next page. IMPORTENT: You must pass the same page size that you pased at the first call.
.
Optional
page-numberWhich page of results to return. The default = 1.
Note: This argument is in a deprecate process by the API. As an alternative use "next_page_token" or "limit".
.
Optional
limitThe total amunt of results to show.Optional
user_idA user ID. this is for a singel user.Optional
role_idFilter the response by a specific role.
For example: role_id=0 (Owner), role_id=2 (Member)
.
Optional

Context Output#

PathTypeDescription
Zoom.Metadata.CountnumberTotal page count available
Zoom.Metadata.NumbernumberCurrent page number
Zoom.Metadata.SizenumberNumber of results in current page
Zoom.Metadata.TotalnumberTotal number of records
Zoom.User.idstringID of the user
Zoom.User.first_namestringFirst name of user
Zoom.User.last_namestringLast name of user
Zoom.User.emailstringEmail of user
Zoom.User.typenumberType of user
Zoom.User.created_atdateDate when user was created
Zoom.User.deptstringDepartment for user
Zoom.User.verifiednumberIs the user verified
Zoom.User.last_login_timedateLast login time of the user
Zoom.User.timezonestringDefault timezone for the user
Zoom.User.pmistringPMI of user
Zoom.User.group_idsstringGroups user belongs to

Command example#

!zoom-list-users status=pending limit=10

Context Example#

{
"Zoom": {
"Metadata": {
"Count": 6,
"Number": 1,
"Size": 10,
"Total": 59
},
"User": [
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T12:55:33Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T13:09:28Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2022-12-22T10:19:47Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T13:12:46Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T12:04:08Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T12:56:08Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T12:58:16Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T13:15:04Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T11:58:04Z",
"verified": 0
},
{
"created_at": "2023-01-15T12:44:34Z",
"email": "example@example.com",
"id": "",
"pmi": 0,
"role_id": "0",
"status": "pending",
"type": 1,
"user_created_at": "2023-01-02T13:09:52Z",
"verified": 0
}
]
}
}

Human Readable Output#

Users#

idemailtypepmiverifiedcreated_atstatusrole_id
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0
example@example.com1002023-01-15T12:44:34Zpending0

Metadata#

total_records
59

zoom-delete-user#


Delete a user from Zoom

Base Command#

zoom-delete-user

Input#

Argument NameDescriptionRequired
userThe user ID or email to delete.Required
actionThe action to take. Possible values are: disassociate, delete. Default is disassociate.Optional

Context Output#

There is no context output for this command.

zoom-meeting-get#


Get the information of an existing zoom meeting

Base Command#

zoom-meeting-get

Input#

Argument NameDescriptionRequired
meeting_idThe id of the existing meeting.Required
occurrence_idProvide this field to view meeting details of a particular occurrence of the recurring meeting.Optional
show_previous_occurrencesSet the value of this field to true if you would like to view meeting details of all previous occurrences of a recurring meeting. Possible values are: false, true. Default is True.Optional

Context Output#

PathTypeDescription
Zoom.Meeting.join_urlstringJoin url for the meeting
Zoom.Meeting.idstringMeeting id of the new meeting that is created
Zoom.Meeting.start_urlstringThe URL to start the meeting
Zoom.Meeting.uuidstringUnique meeting ID of the new meeting that is created
Zoom.Meeting.statusstringThe status of the meeting
Zoom.Meeting.start_timeDateThe time that the meeting will start at
Zoom.Meeting.host emailstringThe email of the host of this meeting
Zoom.Meeting.topicstringThe topic of the meeting
Zoom.Meeting.durationnumberThe duratian of the meeting
Zoom.Meeting.created_atDateThe time that this meeting was created
Zoom.Meeting.typenumberThe type of the new meeting, Instant = 1, Scheduled =2,Recurring with fixed time = 8

Command example#

!zoom-meeting-get meeting_id=88949894296

Context Example#

{
"Zoom": {
"Meeting": {
"agenda": "",
"assistant_id": "",
"created_at": "2022-12-29T08:10:13Z",
"duration": 60,
"host_email": "example@example.com",
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 88949894296,
"join_url": "https://us06web.zoom.us/94296?pwd=b3GdrSDBBNU1FYTVRVmdadz09",
"pre_schedule": false,
"settings": {
"allow_multiple_devices": false,
"alternative_host_update_polls": false,
"alternative_hosts": "",
"alternative_hosts_email_notification": true,
"approval_type": 2,
"approved_or_denied_countries_or_regions": {
"enable": false
},
"audio": "both",
"auto_recording": "none",
"breakout_room": {
"enable": false
},
"close_registration": false,
"cn_meeting": false,
"device_testing": false,
"email_notification": true,
"enable_dedicated_group_chat": false,
"encryption_type": "enhanced_encryption",
"enforce_login": false,
"enforce_login_domains": "",
"focus_mode": false,
"global_dial_in_countries": [
"US"
],
"global_dial_in_numbers": [
{
"country": "US",
"country_name": "US",
"number": "+1 6469313860",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 6694449171",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 6892781000",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 7193594580",
"type": "toll"
},
{
"city": "Denver",
"country": "US",
"country_name": "US",
"number": "+1 7207072699",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 2532050468",
"type": "toll"
},
{
"city": "Tacoma",
"country": "US",
"country_name": "US",
"number": "+1 2532158782",
"type": "toll"
},
{
"city": "Washington DC",
"country": "US",
"country_name": "US",
"number": "+1 3017158592",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3052241968",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3092053325",
"type": "toll"
},
{
"city": "US",
"country": "US",
"country_name": "US",
"number": "+1 3126266799",
"type": "toll"
},
{
"city": "Houston",
"country": "US",
"country_name": "US",
"number": "+1 3462487799",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3602095623",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 3863475053",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 5074734847",
"type": "toll"
},
{
"country": "US",
"country_name": "US",
"number": "+1 5642172000",
"type": "toll"
},
{
"city": "New York",
"country": "US",
"country_name": "US",
"number": "+1 6465588656",
"type": "toll"
}
],
"host_save_video_order": false,
"host_video": true,
"in_meeting": false,
"jbh_time": 0,
"join_before_host": false,
"meeting_authentication": false,
"mute_upon_entry": false,
"participant_video": false,
"private_meeting": false,
"registrants_confirmation_email": true,
"registrants_email_notification": true,
"request_permission_to_unmute_participants": false,
"show_share_button": false,
"use_pmi": false,
"waiting_room": false,
"watermark": false
},
"start_time": "2022-12-29T12:12:12Z",
"start_url": "https://us06web.zoom.us/s/88949?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4OTQ5ODk0Mjk2IiwiZXhwIjoxNjczNzkzODc2LCJpYXQiOjE2NzM3ODY2NzYsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.BTOeH_-MZRm7A5sACnDJrP_zKbzaDCWZ5orvtH4rVb0",
"status": "waiting",
"timezone": "Asia/Jerusalem",
"topic": "test",
"type": 2,
"uuid": "anhEx2x6QWG7TREn71MmoA=="
}
}
}

Human Readable Output#

Meeting details#

uuididhost_idhost_emailtopictypestatusstart_timedurationtimezoneagendacreated_atstart_urljoin_url
anhEx2x6QWG7TREn71MmoA==88949894296uJiZN-O7Rp6Jp_995FpZGgexample@example.comtest2waiting2022-12-29T12:12:12Z60Asia/Jerusalem2022-12-29T08:10:13Zhttps://us06web.zoom.us/s/88949894296?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6InVKaVpOLU83UnA2SnBfOTk1RnBaR2ciLCJpc3MiOiJ3ZWIiLCJzayI6IjczMjU5NTExMTgxNDYyODc0NjciLCJzdHkiOjEwMCwid2NkIjoidXMwNiIsImNsdCI6MCwibW51bSI6Ijg4OTQ5ODk0Mjk2IiwiZXhwIjoxNjczNzkzODc2LCJpYXQiOjE2NzM3ODY2NzYsImFpZCI6ImFlS0QyQkZKUkFTdDFRVlVSV285Q0EiLCJjaWQiOiIifQ.BTOeH_-MZRm7A5sACnDJrP_zKbzaDCWZ5orvtH4rVb0https://us06web.zoom.us/j/88949894296?pwd=b3dzT1pzWGdrSDBBNU1FYTVRVmdadz09

zoom-meeting-list#


Show all the meetings of a given user. Note: only scheduled and unexpired meetings will appear.

Base Command#

zoom-meeting-list

Input#

Argument NameDescriptionRequired
user_idThe user ID of the meetings owner.Required
page_sizeNumber of users to return. Default = 30. Max = 300.Optional
page_numberWhich page of results to return. The default = 1.
Note: This argument is in a deprecate process by the API. As an alternative use "next_page_token" or "limit".
.
Optional
next_page_tokenThe next page token is used to paginate te the next page. IMPORTENT: You must pass the same page size that you pased at the first call.
.
Optional
limitThe total amunt of results to show.Optional
typeFilter the results by searching specific types. Possible values are: all, scheduled, live, upcoming, upcoming_meetings, previous_meetings. Default is "scheduled".Optional

Context Output#

PathTypeDescription
Zoom.Metadata.TotalnumberTotal number of records
Zoom.Meeting.page_sizenumberThe size of the page returned from the API
Zoom.Meeting.total_recordsnumberThe total records in the API for this request.
Zoom.Meeting.join_urlstringJoin url for the meeting
Zoom.Meeting.idstringMeeting id of the new meeting that is created
Zoom.Meeting.start_urlstringThe URL to start the meeting
Zoom.Meeting.uuidstringUnique meeting ID of the new meeting that is created
Zoom.Meeting.statusstringThe status of the meeting
Zoom.Meeting.start_timeDateThe time that the meeting will start at
Zoom.Meeting.host emailstringThe email of the host of this meeting
Zoom.Meeting.topicstringThe topic of the meeting
Zoom.Meeting.durationnumberThe duratian of the meeting
Zoom.Meeting.created_atDateThe time that this meeting was created
Zoom.Meeting.typeunknownThe ty pe of this meeting

Command example#

!zoom-meeting-list user_id=example@example.com type=scheduled limit=7

Context Example#

{
"Zoom": {
"Meeting": {
"meetings": [
{
"created_at": "2022-12-04T10:41:27Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 83810397585,
"join_url": "https://us06web.zoom.us/j/83810397585?pwd=OGFiZjVvMWZzdDBoaXlLdz09",
"start_time": "2022-12-10T11:00:00Z",
"timezone": "Asia/Jerusalem",
"topic": "2",
"type": 8,
"uuid": "z93Dc6Kj3jx+zaYg=="
},
{
"created_at": "2022-12-06T07:59:02Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 84540166459,
"join_url": "https://us06web.zoom.us/j/84540166459?pwd=ZzZaaVpFYlBVYnFoUT09",
"start_time": "2022-12-12T08:00:00Z",
"timezone": "Asia/Jerusalem",
"topic": "My recurring Meeting -Dima",
"type": 8,
"uuid": "4kZQ+HlFOAz0VBPHoCYg=="
},
{
"created_at": "2022-12-27T21:05:41Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 89824497327,
"join_url": "https://us06web.zoom.us/j/89824497327?pwd=SWp3b3VDRVhmQT09",
"start_time": "2022-12-27T21:05:00Z",
"timezone": "Asia/Jerusalem",
"topic": "efe",
"type": 8,
"uuid": "RABXy2D4hA1rgpDgQ=="
},
{
"created_at": "2022-12-27T21:11:01Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 83245658341,
"join_url": "https://us06web.zoom.us/j/83245658341?pwd=SmNGMHI0RDNkZ2Yms3Zz09",
"start_time": "2022-12-27T21:11:00Z",
"timezone": "Asia/Jerusalem",
"topic": "efe",
"type": 8,
"uuid": "qOXvloSamJjjFaFgniTA=="
},
{
"created_at": "2022-12-27T21:25:54Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 88468901206,
"join_url": "https://us06web.zoom.us/j/88468901206?pwd=RXZYQlWCtpS3l1MHUxZz09",
"start_time": "2022-12-27T21:25:00Z",
"timezone": "Asia/Jerusalem",
"topic": "efe",
"type": 8,
"uuid": "yHzCvl4Sry+C9LnCwdnwQ=="
},
{
"created_at": "2022-12-28T06:39:48Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 87525048161,
"join_url": "https://us06web.zoom.us/j/87525048161?pwd=ZXlV3U0OUxxSlBkdz09",
"start_time": "2022-12-28T06:39:00Z",
"timezone": "Asia/Jerusalem",
"topic": "efe",
"type": 8,
"uuid": "Sblh/S1W+rTKUcojJjw=="
},
{
"created_at": "2022-12-28T06:42:25Z",
"duration": 60,
"host_id": "uJiZN-O7Rp6Jp_995FpZGg",
"id": 83877839723,
"join_url": "https://us06web.zoom.us/j/83877839723?pwd=WySkY4Zkc4Zz09",
"start_time": "2022-12-28T06:42:00Z",
"timezone": "Asia/Jerusalem",
"topic": "efe",
"type": 8,
"uuid": "iLXDe4HsR6uMb+x8GyybTA=="
}
],
"next_page_token": "N58N4bhqiBFapzndJocx6cc8NKr2",
"page_size": 7,
"total_records": 60
},
"Metadata": {
"Size": 7,
"Total": 60
}
}
}

Human Readable Output#

Meeting list#

uuididhost_idtopictypestart timedurationtimezonecreated_atjoin_url
z93Dc6KjSo20Wr3jx+zaYg==83810397585uJiZN-O7Rp6Jp_995FpZGg2860Asia/Jerusalem2022-12-04T10:41:27Zhttps://us06web.zoom.us/j/83810397585?pwd=OGFiZjRYNGhwWkVvMWZzdDBoaXlLdz09
4kZQ+Hl2RFOAz0VBPHoCYg==84540166459uJiZN-O7Rp6Jp_995FpZGgMy recurring Meeting -Dima860Asia/Jerusalem2022-12-06T07:59:02Zhttps://us06web.zoom.us/j/84540166459?pwd=ZzdmUEJ5QkZaaUZaaVpFYlBVYnFoUT09
RABXyk81T02D4hA1rgpDgQ==89824497327uJiZN-O7Rp6Jp_995FpZGgefe860Asia/Jerusalem2022-12-27T21:05:41Zhttps://us06web.zoom.us/j/89824497327?pwd=SWpvK0I0L3pQcTNnWlF3b3VDRVhmQT09
qOXvlLOoSamJjjFaFgniTA==83245658341uJiZN-O7Rp6Jp_995FpZGgefe860Asia/Jerusalem2022-12-27T21:11:01Zhttps://us06web.zoom.us/j/83245658341?pwd=SmNGMHI0R1hndnNlRXRDNkZ2Yms3Zz09
yHzCvl4USry+C9LnCwdnwQ==88468901206uJiZN-O7Rp6Jp_995FpZGgefe860Asia/Jerusalem2022-12-27T21:25:54Zhttps://us06web.zoom.us/j/88468901206?pwd=RXZYQlhVbWJKZ1pLWCtpS3l1MHUxZz09
Sblh/I34S1W+rTKUcojJjw==87525048161uJiZN-O7Rp6Jp_995FpZGgefe860Asia/Jerusalem2022-12-28T06:39:48Zhttps://us06web.zoom.us/j/87525048161?pwd=ZXlXdXl0QWlLOFVyV3U0OUxxSlBkdz09
iLXDe4HsR6uMb+x8GyybTA==83877839723uJiZN-O7Rp6Jp_995FpZGgefe860Asia/Jerusalem2022-12-28T06:42:25Zhttps://us06web.zoom.us/j/83877839723?pwd=WU9xNmp5RW5KRDhsZ1RySkY4Zkc4Zz09

Metadata#

total_records
60