npm.io
1.0.5 • Published 7 years ago

@bunchtogether/zoom-api-v2

Licence
MIT
Version
1.0.5
Deps
2
Size
2.6 MB
Vulns
3
Weekly
0
SummaryDependencyVersions

Unofficial Zoom API (v2) Client

npm version

Unofficial Zoom REST API client generated from the Zoom API (v2) Swagger definition using swagger-typescript-codegen and subsequent modifications.

ZOOM is a trademark of Zoom Video Communications, Inc. All content on this page derived from the Zoom API (v2) Swagger definition copyright Zoom Video Communications, Inc.

Install

yarn add @bunchtogether/zoom-api-v2

Usage

import Zoom from 'zoom-api-v2';

const API_KEY = "YOUR API KEY HERE";
const API_SECRET = "YOUR API SECRET HERE";

const zoom = new Zoom(API_KEY, API_SECRET);

const run = async () => {
    const users = await zoom.users({});
    console.log(JSON.stringify(users.body, null, 2));    
}

run();


/*

Logs:

{
  "page_count": 1,
  "page_number": 1,
  "page_size": 30,
  "total_records": 1,
  "users": [
    {
      "id": "XXX",
      "first_name": "John",
      "last_name": "Doe",
      "email": "johndoe@example.com",
      "type": 2,
      "pmi": 123456789,
      "timezone": "America/New_York",
      "verified": 1,
      "dept": "",
      "created_at": "2018-07-18T14:48:45Z",
      "last_login_time": "2019-06-27T14:59:25Z",
      "last_client_version": "4.3.46560.0311(win)",
      "pic_url": "XXX",
      "status": "active"
    }
  ]
}

*/

API

Table of Contents
Zoom

src/index.js:2628-21138

The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.

For instance you can list all users on an account via https://api.zoom.us/v2/users/.

Parameters
  • apiKey (string) The API Key.
  • apiSecret (string) The API Secreg.
  • domainOrOptions (string)? The project domain.
Zoom#accounts

src/index.js:2784-2819

List all the sub accounts under the master account.

Only master accounts can create and have sub accounts. Zoom only assigns this privilege to trusted partners.
Scopes:
  • account:read:admin
Parameters
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#accountCreate

src/index.js:2864-2915

Create a sub account under the master account.

Your account must be a master account in order to create sub accounts. Zoom only assigns this privilege to trusted partners. Please note: the created user will receive a confirmation email.

Scopes:
  • account:write:admin
Zoom#account

src/index.js:2947-2980

Get a sub account under the master account.

Your account must be a master account in order to retrieve sub accounts. Zoom only assigns this privilege to trusted partners.

Scopes:
  • account:read:admin
Parameters
  • accountId string The account ID.
Zoom#accountDisassociate

src/index.js:3012-3045

Disassociate a sub account from the master account. This will leave the sub account intact but it will no longer be associated with the master account.

Scopes:
  • account:write:admin
Parameters
  • accountId string The account ID.
Zoom#accountOptionsUpdate

src/index.js:3088-3137

Update a sub account's options under the master account.

Scopes:
  • account:write:admin
Parameters
  • accountId string The account ID.
Zoom#accountSettings

src/index.js:3169-3202

Get a sub account's settings under the master account.

Scopes:
  • account:read:admin
Parameters
  • accountId string The account ID.
Zoom#accountSettingsUpdate

src/index.js:3361-3526

Update a sub account's settings under the master account.

Scopes:
  • account:read:admin
Parameters
  • accountId string The account ID.
Zoom#accountManagedDomain

src/index.js:3558-3591

Get a sub account's managed domains under the master account.

Scopes:
  • account:read:admin
Parameters
  • accountId string The account ID.
Zoom#accountTrustedDomain

src/index.js:3622-3655

Get a sub account's trusted domains under the master account

Parameters
  • accountId string The account ID.
Zoom#accountBilling

src/index.js:3687-3720

Get billing information for a sub account under a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountBillingUpdate

src/index.js:3768-3822

Update billing information for a sub account under a master account.

This is only for a paid sub account that is paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountPlans

src/index.js:3854-3887

Get plan information for a sub account under the master account.

This is only for a sub account that is paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountPlanCreate

src/index.js:3969-4058

Subscribe plans for a sub account of a master account.

This can only subscribe plans for a free sub account and if paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountPlanBaseUpdate

src/index.js:4098-4144

Update a base plan for a sub account.

This can only update a base plan for a paid sub account that is paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountPlanAddonCreate

src/index.js:4186-4235

Add an additional plan for a sub account.

This can only add an Additional plan for a paid sub account that is paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#accountPlanAddonUpdate

src/index.js:4275-4321

Update an additional plan for a sub account.

This can only update an additional plan for a paid sub account that is paid by a master account.

Scopes:
  • billing:master
Parameters
  • accountId string The account ID.
Zoom#groups

src/index.js:4350-4374

List groups under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:read:admin
Zoom#groupCreate

src/index.js:4413-4453

Create a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Zoom#group

src/index.js:4488-4521

Get a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:read:admin
Parameters
Zoom#groupUpdate

src/index.js:4563-4608

Update a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
Zoom#groupDelete

src/index.js:4643-4676

Delete a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
Zoom#groupMembers

src/index.js:4722-4765

List the members of a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
  • groupId string The group ID. Can be retrieved by calling GET /groups.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#groupMembersCreate

src/index.js:4813-4865

Add members to a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
Zoom#groupMembersDelete

src/index.js:4904-4945

Delete a member from a group under your account.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
Zoom#deviceList

src/index.js:4972-4996

List H.323/SIP Devices on your Zoom account.

Scopes:
  • h323:read:admin
Zoom#deviceCreate

src/index.js:5033-5076

Create a H.323/SIP Device on your Zoom account

Scopes:
  • h323:write:admin
Zoom#deviceUpdate

src/index.js:5118-5166

Update a H.323/SIP device from your Zoom account.

Scopes:
  • h323:write:admin
Parameters
  • deviceId string The device ID.
Zoom#deviceDelete

src/index.js:5198-5231

Delete a H.323/SIP device from your Zoom account.

Scopes:
  • h323:write:admin
Parameters
  • deviceId string The device ID.
Zoom#trackingfieldList

src/index.js:5258-5282

List Tracking Fields on your Zoom account.

Scopes:
  • trackingfield:read:admin
Zoom#trackingfieldCreate

src/index.js:5320-5364

Create a Tracking Field on your Zoom account

Scopes:
  • trackingfield:write:admin
Zoom#trackingfieldGet

src/index.js:5396-5429

Retrieve a tracking field

Scopes:
  • trackingfield:read:admin
Parameters
  • fieldId string The Tracking Field ID
Zoom#trackingfieldUpdate

src/index.js:5472-5521

Update a Tracking Field on your Zoom account

Scopes:
  • trackingfield:write:admin
Parameters
  • fieldId string The Tracking Field ID
Zoom#trackingfieldDelete

src/index.js:5553-5586

Delete a Tracking Field on your Zoom account

Scopes:
  • trackingfield:write:admin
Parameters
  • fieldId string The Tracking Field ID
Zoom#imGroups

src/index.js:5613-5637

List IM directory groups under your account.

Scopes:
  • imgroup:read:admin
Zoom#imGroupCreate

src/index.js:5678-5722

Create an IM directory group under your account.

Scopes:
  • imgroup:write:admin
Zoom#imGroup

src/index.js:5755-5788

Retrieve an IM directory group under your account.

Scopes:
  • imgroup:read:admin
Parameters
Zoom#imGroupUpdate

src/index.js:5832-5881

Update an IM directory group under your account.

Scopes:
  • imgroup:write:admin
Parameters
Zoom#imGroupDelete

src/index.js:5914-5947

Delete an IM directory group under your account.

Scopes:
  • imgroup:write:admin
Parameters
Zoom#imGroupMembers

src/index.js:5991-6034

List the members of an IM directory group under your account.

Scopes:
  • imgroup:read:admin
Parameters
  • groupId string The group ID. Can be retrieved by calling GET /groups.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#imGroupMembersCreate

src/index.js:6080-6132

Add members to an IM directory group under your account.

Scopes:
  • imgroup:write:admin
Parameters
Zoom#imGroupMembersDelete

src/index.js:6169-6210

Delete a member from an IM directory group under your account.

Scopes:
  • imgroup:write:admin
Parameters
Zoom#imChatSessions

src/index.js:6262-6317

Retrieve IM Chat sessions for a specified period of time.

Note: This API only supports oauth2.

Scopes:
  • imchat:read, imchat:read:admin
Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#imChatMessages

src/index.js:6372-6435

Retrieve IM chat messages for a specified period of time.

Note: This API only supports oauth2.

Scopes:
  • imchat:read
Parameters
  • sessionId string IM chat session ID.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#meetings

src/index.js:6484-6532

List meetings for a user.

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • userId string The user ID or email address.
  • type string The meeting types: scheduled - All the scheduled meetings.live - All the live meetings.upcoming - All the upcoming meetings.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#meetingCreate

src/index.js:6615-6708

Create a meeting for a user.

The expiration time for the start_url Object is two hours. For API users, the expiration time is 90 days.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • userId string The user ID or email address.
Zoom#meeting

src/index.js:6745-6783

Retrieve the details of a meeting.

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • meetingId integer The meeting ID.
  • occurrenceId string Meeting occurrence id
Zoom#meetingUpdate

src/index.js:6879-6983

Update the details of a meeting.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • occurrenceId string Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}
Zoom#meetingDelete

src/index.js:7020-7058

Delete a meeting.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • occurrenceId string The meeting occurrence ID.
Zoom#meetingStatus

src/index.js:7097-7142

Update a meeting's status.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
Zoom#meetingRegistrants

src/index.js:7197-7250

List registrants of a meeting.

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • meetingId integer The meeting ID.
  • occurrenceId string The meeting occurrence ID.
  • status string The registrant status:pending - Registrant's status is pending.approved - Registrant's status is approved.denied - Registrant's status is denied.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#meetingRegistrantCreate

src/index.js:7316-7389

Register a participant for a meeting.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • occurrenceIds string Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
Zoom#meetingRegistrantStatus

src/index.js:7438-7493

Update a meeting registrant's status.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • occurrenceId string The meeting occurrence ID.
Zoom#pastMeetingDetails

src/index.js:7528-7561

Retrieve details from a past meeting.

Scopes:
  • meeting:read:admin meeting:read

Note: Please double encode your UUID when using this API.

Parameters
  • meetingUuid string The meeting UUID.
Zoom#pastMeetingParticipants

src/index.js:7607-7650

Retrieve participants from a past meeting.

Scopes:
  • meeting:read:admin meeting:read

Note: Please double encode your UUID when using this API.

Parameters
  • meetingUuid string The meeting UUID.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#pastMeetings

src/index.js:7682-7715

List of ended meeting instances

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • meetingId integer The meeting ID.
Zoom#meetingPolls

src/index.js:7751-7784

List polls of a meeting

Scopes:
  • meeting:read:admin meeting:read
Prerequisites:

Host user must be in a Pro plan. Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters
  • meetingId integer The meeting ID.
Zoom#meetingPollCreate

src/index.js:7833-7888

Create a poll for a meeting

Scopes:
  • meeting:write:admin meeting:write
Prerequisites:

Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Parameters
  • meetingId integer The meeting ID.
Zoom#meetingPollGet

src/index.js:7924-7965

Retrieve a meeting's poll

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • meetingId integer The meeting ID.
  • pollId string The poll ID
Zoom#meetingPollUpdate

src/index.js:8012-8072

Update a meeting's poll

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • pollId string The poll ID
Zoom#meetingPollDelete

src/index.js:8108-8149

Delete a meeting's Poll

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
  • pollId string The poll ID
Zoom#meetingRegistrantsQuestionsGet

src/index.js:8180-8213

List registration questions that will be displayed to users while registering for a meeeting.

Parameters
  • meetingId integer The meeting ID.
Zoom#meetingRegistrantQuestionUpdate

src/index.js:8260-8317

Update registration questions that will be displayed to users while registering for a meeeting.

Parameters
  • meetingId integer The meeting ID.
Zoom#recordingsList

src/index.js:8384-8447

List all recordings.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
  • mc string Query mc.
  • trash boolean Query trash.
  • from string Start date in 'yyyy-mm-dd' format. (Within 6 month range)
  • to string End date in 'yyyy-mm-dd' format. (Within 6 month range)
Zoom#recordingGet

src/index.js:8479-8512

Retrieve all the recordings from a meeting.

Scopes:
  • recording:read:admin recording:read
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#recordingDelete

src/index.js:8549-8587

Delete a meeting's recordings.

Scopes:
  • recording:write:admin recording:write
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • action string The recording delete actions:trash - Move recording to trash.delete - Delete recording permanently.
Zoom#recordingDeleteOne

src/index.js:8628-8674

Delete one meeting recording file.

Scopes:
  • recording:write:admin recording:write
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • recordingId string The recording ID.
  • action string The recording delete actions:trash - Move recording to trash.delete - Delete recording permanently.
Zoom#recordingStatusUpdate

src/index.js:8713-8758

Recover a meeting's recordings.

Scopes:
  • recording:write:admin recording:write
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#recordingStatusUpdateOne

src/index.js:8801-8854

Recover a single recording.

Scopes:
  • recording:write:admin recording:write
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • recordingId string The recording ID.
Zoom#recordingSettingUpdate

src/index.js:8886-8919

Retrieve a meeting recording's settings

Scopes:
  • recording:read:admin recording:read
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#recordingSettingsUpdate

src/index.js:8961-9012

Update a meeting recording's settings

Scopes:
  • recording:write:admin recording:write
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#meetingRecordingRegistrants

src/index.js:9060-9108

List registrants of a meeting recording

Parameters
  • meetingId integer The meeting ID.
  • status string The registrant status:pending - Registrant's status is pending.approved - Registrant's status is approved.denied - Registrant's status is denied.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#meetingRecordingRegistrantCreate

src/index.js:9168-9236

Register a participant for a meeting recording

Parameters
  • meetingId integer The meeting ID.
Zoom#meetingRecordingRegistrantStatus

src/index.js:9278-9327

Update a meeting recording registrant's status

Parameters
  • meetingId integer The meeting ID.
Zoom#recordingRegistrantsQuestionsGet

src/index.js:9358-9391

Retrieve a list of questions that are displayed for users to complete when registering to view a recording.

Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#recordingRegistrantQuestionUpdate

src/index.js:9438-9495

Update registration questions that are to be answered by users while registering to view a recording.

Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#dashboardMeetings

src/index.js:9553-9613

List live meetings or past meetings for a specified period of time.

Scopes:
  • dashboard:read:admin
Parameters
  • type string The meeting types: past - Past meetings.pastOne - Past one user meetings. live - Live meetings.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardMeetingDetail

src/index.js:9650-9688

Retrieve details on live or past meetings.

Scopes:
  • dashboard:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • type string The meeting types: past - Past meetings.pastOne - Past one user meetings.live - Live meetings.
Zoom#dashboardMeetingParticipants

src/index.js:9737-9785

Retrieve a list of participants from live or past meetings.

Scopes:
  • dashboard:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • type string The meeting types: past - Past meetings.pastOne - Past one user meetings.live - Live meetings.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardMeetingParticipantQOS

src/index.js:9826-9872

Retrieve the quality of service for participants from live or past meetings.

Scopes:
  • dashboard:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • participantId string Participant ID.
  • type string The meeting types: past - Past meetings.live - Live Meetings.
Zoom#dashboardMeetingParticipantsQOS

src/index.js:9921-9969

Retrieve a list of meeting participants from live or past meetings and the quality of service they recieved.

Scopes:
  • dashboard:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • type string The meeting types: past - Past meetings.live - Live Meetings.
  • pageSize integer The number of items returned per page.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardMeetingParticipantShare

src/index.js:10018-10066

Retrieve the sharing and recording details of participants from live or past meetings.

Scopes:
  • dashboard:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • type string The meeting types: past - Past meetings.live - Live Meetings.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardWebinars

src/index.js:10124-10184

List all the live or past webinars from a specified period of time.

Scopes:
  • dashboard:read:admin
Parameters
  • type string The webinar type.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardWebinarDetail

src/index.js:10221-10259

Retrieve details from live or past webinars.

Scopes:
  • dashboard:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • type string The webinar type.
Zoom#dashboardWebinarParticipants

src/index.js:10308-10356

Retrieve participants from live or past webinars.

Scopes:
  • dashboard:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • type string The webinar type.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardWebinarParticipantQOS

src/index.js:10397-10443

Retrieve the quality of service that participants from live or past webinars recieved.

Scopes:
  • dashboard:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • participantId string Participant ID.
  • type string The webinar type.
Zoom#dashboardWebinarParticipantsQOS

src/index.js:10492-10540

Retrieve a list of participants from live or past webinars and the quality of service they received.

Scopes:
  • dashboard:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • type string The webinar type.
  • pageSize integer The number of items returned per page.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardWebinarParticipantShare

src/index.js:10589-10637

Retrieve the sharing and recording details of participants from live or past webinars.

Scopes:
  • dashboard:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • type string The webinar type.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardZoomRooms

src/index.js:10677-10712

List all zoom rooms on account.

Scopes:
  • dashboard:read:admin
Parameters
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#dashboardZoomRoom

src/index.js:10767-10830

Retrieve Zoom room on account.

Scopes:
  • dashboard:read:admin
Parameters
  • zoomroomId string The Zoom room ID.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#dashboardCRC

src/index.js:10870-10915

Get the hour by hour CRC Port usage for a specified period of time.

We will report a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10" we will adjust "from" to "2017-09-10".

Scopes:
  • dashboard:read:admin
Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
Zoom#dashboardIM

src/index.js:10967-11022

Retrieve metrics of the Zoom IM.

Scopes:
  • dashboard:read:admin
Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#dashboardClientFeedback

src/index.js:11061-11106

Retrieve Zoom Meetings Client Feedback

Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
Zoom#dashboardZoomRoomIssue

src/index.js:11145-11190

Retrieve Top 25 issues of Zoom Rooms

Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
Zoom#dashboardIssueZoomRoom

src/index.js:11229-11274

Retrieve Top 25 Zoom Rooms with issues

Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
Zoom#dashboardIssueDetailZoomRoom

src/index.js:11328-11391

Retrieve Issue detail of Top 25 Zoom Rooms with issues

Parameters
  • zoomroomId string The Zoom room ID.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#reportDaily

src/index.js:11434-11469

Retrieve daily report to access the account-wide usage for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes. The month selected should fall within the recent six months.

Prerequisites:

Pro, Business, Enterprise, Education, or API Account Account owner or admin permissions

Scopes:
  • report:read:admin
Parameters
  • year integer Year for this report
  • month integer Month for this report
Zoom#reportUsers

src/index.js:11527-11587

Retrieve an active or inactive host report for a specified period of time.

Scopes:
  • report:read:admin
Parameters
  • type string Active or inactive hosts.active - Active hosts. inactive - Inactive hosts.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#reportMeetings

src/index.js:11642-11705

Retrieve a past meeting report for a specified period of time. Meetings will only return in the response if the meeting has two or more unique participants.

Scopes:
  • report:read:admin
Parameters
  • userId string The user ID or email address.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#reportMeetingDetails

src/index.js:11737-11770

Retrieve a detail report for a past meeting.

Scopes:
  • report:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#reportMeetingParticipants

src/index.js:11813-11856

Retrieve a participant report for a past meeting.

Scopes:
  • report:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#reportMeetingPolls

src/index.js:11888-11921

Retrieve a report of poll results for a past meeting.

Scopes:
  • report:read:admin
Parameters
  • meetingId string The meeting ID or meeting UUID. If given the meeting ID it will take the last meeting instance.
Zoom#reportWebinarDetails

src/index.js:11953-11986

Retrieve a report containing past webinar details.

Scopes:
  • report:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
Zoom#reportWebinarParticipants

src/index.js:12029-12072

Retrieve a report on webinar participants.

Scopes:
  • report:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#reportWebinarPolls

src/index.js:12104-12137

Retrieve a report on past webinar polls.

Scopes:
  • report:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
Zoom#reportWebinarQA

src/index.js:12169-12202

Retrieve a report on past webinar Q&As.

Scopes:
  • report:read:admin
Parameters
  • webinarId string The webinar ID or webinar UUID. If given the webinar ID it will take the last webinar instance.
Zoom#reportTelephone

src/index.js:12257-12314

Retrieve a telephone report for a specified period of time.

Please note: the "Toll Report" option will be removed..

Scopes:
  • report:read:admin
Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#reportCloudRecording

src/index.js:12353-12398

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.

Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
Zoom#reportOperationLogs

src/index.js:12449-12504

Retrieve operation logs report

Parameters
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#roles

src/index.js:12536-12560

List Roles on your account

Scopes:
  • role:read:admin
Prerequisites:
  1. Pro, Business, Education, or Enterprise account.
  2. For setting the initial role, you must be the Account Owner.
  3. For subsequent role management, you must be the Account Owner or user with role management permissions.
Zoom#createRole

src/index.js:12605-12643

Each Zoom user automatically has a role which can either be owner, administrator, or a member.

Prerequisites:

An Enterprise, Business, Education or Pro plan. For setting the initial role, you must be the Account Owner. For subsequent role management, you must be the Account Owner or user with role management permissions.

Scopes:
  • role:write:admin
Zoom#roleMembers

src/index.js:12676-12709

List all the members in a specific role.

Scopes:
  • role:read:admin
Parameters
Zoom#AddRoleMembers

src/index.js:12752-12804

Assign members to a role.

Scopes:
  • role:write:admin
Parameters
Zoom#roleMemberDelete

src/index.js:12841-12882

Delete a specific member from a specific role.

Scopes:
  • role:write:admin
Parameters
Zoom#tsp

src/index.js:12909-12933

Retrieve TSP information on account level

Scopes:
  • tsp:read:admin tsp:read
Zoom#tspUpdate

src/index.js:12970-13012

Update TSP information on account level

Scopes:
  • tsp:write:admin tsp:write
Zoom#users

src/index.js:13064-13109

List users on your account.

Scopes:
  • user:read:admin
Parameters
  • status string User statuses:active - Users with an active status.inactive - Users with an inactive status.pending - Users with a pending status.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
  • roleId string The role Id
Zoom#userCreate

src/index.js:13150-13197

Create a user using your account.

Scopes:
  • user:write:admin user:write
Zoom#user

src/index.js:13234-13272

Retrieve a user on your account.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
  • loginType string 0 - Facebook1 - Google99 - API100 - Zoom101 - SSO
Zoom#userUpdate

src/index.js:13324-13384

Update a user on your account.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
  • loginType string 0 - Facebook1 - Google99 - API100 - Zoom101 - SSO
Zoom#userDelete

src/index.js:13445-13503

Delete a user on your account.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
  • action string Delete action options:disassociate - Disassociate a user.delete- Permanently delete a user.Note: To delete pending user in the account, use disassociate
  • transferEmail string Transfer email.
  • transferMeeting boolean Transfer meeting.
  • transferWebinar boolean Transfer webinar.
  • transferRecording boolean Transfer recording.
Zoom#userAssistants

src/index.js:13539-13572

List user assistants.

Assistants are the users to whom the current user has assigned scheduling privilege on the user's behalf.

Prerequisites:

Assistants must be under the current user's account.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
Zoom#userAssistantCreate

src/index.js:13618-13670

Add assistants to a user.

Assistants are the users to whom the current user has assigned scheduling privilege on the user's behalf.

Prerequisites:

Assistants must be under the current user's account.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userAssistantsDelete

src/index.js:13706-13739

Delete all user assistants.

Assistants are the users to whom the current user has assigned scheduling privilege on the user's behalf.

Prerequisites:

Assistants must be under the current user's account.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userAssistantDelete

src/index.js:13779-13820

Delete a specific assistant.

Assistants are the users to whom the current user has assigned scheduling privilege on the user's behalf.

Prerequisites:

Assistants must be under the current user's account.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
  • assistantId string Assistant ID.
Zoom#userSchedulers

src/index.js:13856-13889

List a user's schedulers.

Schedulers in this context are the users on whose behalf the current user can schedule meetings for.

Prerequisites:

Current user must be under the same account as the scheduler.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
Zoom#userSchedulersDelete

src/index.js:13925-13958

Delete all of a user's schedulers.

Schedulers in this context are the users on whose behalf the current user can schedule meetings for.

Prerequisites:

Current user must be under the same account as the scheduler.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userSchedulerDelete

src/index.js:13998-14039

Delete one of the user's schedulers.

Schedulers in this context are the users on whose behalf the current user can schedule meetings for.

Prerequisites:

Current user must be under the same account as the scheduler.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
  • schedulerId string Scheduler's ID.
Zoom#userPicture

src/index.js:14086-14132

Upload a user's profile picture.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
  • picFile file “Content-Type: multipart/form-data; boundary=$boundary” (where $boundary is the unique, semi-random string that does not occur within the file contents). In place of a JSON request body, the multipart/form-data request body looks like this: --$boundary Content-Disposition: form-data; name="pic_file"; filename="$filename" Content-Type: image/jpeg $filecontents --$boundary--It’s also important to note that the line endings are \r\n between the lines
Zoom#userSettings

src/index.js:14169-14207

Retrieve a user's settings.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
  • loginType string 0 - Facebook1 - Google99 - API100 - Zoom101 - SSO
Zoom#userSettingsUpdate

src/index.js:14320-14442

Update a user's settings.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userStatus

src/index.js:14478-14523

Update a user's status.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userPassword

src/index.js:14559-14604

Update a user password.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userPermission

src/index.js:14636-14669

Retrieve a user's permissions.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
Zoom#userPACs

src/index.js:14701-14734

List a user's PAC accounts.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
Zoom#userTSPs

src/index.js:14766-14799

A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.

Scopes:
  • tsp:read:admin tsp:read
Parameters
  • userId string The user ID or email address.
Zoom#userTSPCreate

src/index.js:14845-14901

Add a user's TSP account.

Scopes:
  • tsp:write:admin tsp:write
Parameters
  • userId string The user ID or email address.
Zoom#userTSP

src/index.js:14937-14978

Each user can have a maximum of two TSP accounts. Use this API to retrieve one specific TSP account of a user.

Scopes:
  • tsp:read:admin tsp:read
Parameters
  • userId string The user ID or email address.
  • tspId string TSP account ID.
Zoom#userTSPUpdate

src/index.js:15026-15087

Update a user's TSP account.

Scopes:
  • tsp:write:admin tsp:write
Parameters
  • userId string The user ID or email address.
  • tspId string TSP account ID.
Zoom#userTSPDelete

src/index.js:15123-15164

Delete a user's TSP account.

Scopes:
  • tsp:write:admin tsp:write
Parameters
  • userId string The user ID or email address.
  • tspId string TSP account ID.
Zoom#userToken

src/index.js:15201-15239

Retrieve a user's token.

Scopes:
  • user:read:admin user:read
Parameters
  • userId string The user ID or email address.
  • type string User token types:token - Used for starting meetings with the client SDK.zpk - Used for generating the start meeting URL (Deprecated).zak - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
Zoom#userSSOTokenDelete

src/index.js:15271-15304

Revoke a user's SSO token.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userEmail

src/index.js:15338-15373

Verify if a user's email is registered with Zoom.

Scopes:
  • user:read:admin user:read
Parameters
  • email string The email address to be verified.
Zoom#userEmailUpdate

src/index.js:15409-15454

Update a user's email.

Scopes:
  • user:write:admin user:write
Parameters
  • userId string The user ID or email address.
Zoom#userVanityName

src/index.js:15488-15523

Check if the user's personal meeting room name exists.

Scopes:
  • user:read:admin user:read
Parameters
  • vanityName string Personal meeting room name.
Zoom#webinars

src/index.js:15566-15609

List webinars for a user.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • userId string The user ID or email address.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#webinarCreate

src/index.js:15689-15779

Create a webinar for a user.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • userId string The user ID or email address.
Zoom#webinar

src/index.js:15816-15854

Retrieve a webinar.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
  • occurrenceId string Webinar occurrence id
Zoom#webinarUpdate

src/index.js:15939-16032

Update a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • occurrenceId string Webinar occurrence id. Support change of agenda, start_time, duration, settings: {host_video, panelist_video, hd_video, watermark, auto_recording}
Zoom#webinarDelete

src/index.js:16069-16107

Delete a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • occurrenceId string The meeting occurrence ID.
Zoom#webinarStatus

src/index.js:16146-16191

Update a webinar's status. You can call this API to end an ongoing webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPanelists

src/index.js:16223-16256

List panelists for a webinar.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPanelistCreate

src/index.js:16301-16353

Add panelists to a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPanelistsDelete

src/index.js:16385-16418

Remove all panelists from a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPanelistDelete

src/index.js:16454-16495

Remove a panelist from a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • panelistId integer The panelist ID or panelist email.
Zoom#webinarRegistrants

src/index.js:16557-16618

List registrants for a webinar.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
  • occurrenceId string The meeting occurrence ID.
  • status string The registrant status:pending - Registrant's status is pending.approved - Registrant's status is approved.denied - Registrant's status is denied.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
  • webinarId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#webinarRegistrantCreate

src/index.js:16691-16772

Add a registrant for a webinar.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • occurrenceIds string Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.
  • webinarId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#webinarRegistrantStatus

src/index.js:16821-16876

Update a webinar registrant's status.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • occurrenceId string The meeting occurrence ID.
Zoom#pastWebinars

src/index.js:16908-16941

List of past webinar instances.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPolls

src/index.js:16973-17006

List polls of a webinar

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPollCreate

src/index.js:17051-17106

Create a poll for a webinar

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
Zoom#webinarPollGet

src/index.js:17142-17183

Retrieve a webinar's poll.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
  • pollId string The poll ID
Zoom#webinarPollUpdate

src/index.js:17230-17290

Update a webinar's poll.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • pollId string The poll ID
Zoom#webinarPollDelete

src/index.js:17326-17367

Delete a webinar's poll.

Scopes:
  • webinar:write:admin webinar:write
Parameters
  • webinarId integer The webinar ID.
  • pollId string The poll ID
Zoom#webinarRegistrantsQuestionsGet

src/index.js:17398-17431

List registration questions and fields that are to be answered by users while registering for a webinar.

Parameters
  • webinarId integer The webinar ID.
Zoom#webinarRegistrantQuestionUpdate

src/index.js:17480-17537

Update registration questions and fields that are to be answered by users while registering for a webinar.

Prerequisites:

Registration option for webinar should be set as required to use this API.

Parameters
  • webinarId integer The webinar ID.
Zoom#sendchatbot

src/index.js:17577-17615

Send chatbot messages from your marketplace chatbot app.

Scopes:
  • imchat:bot
Zoom#getchatchannels

src/index.js:17652-17685

This endpoint will be deprecated by the end of June 2019.

Return a user's subscribed channels with IDs.

Scopes:
  • imcontact:read:admin
Parameters
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#meetingInvitation

src/index.js:17717-17750

Retrieve the meeting invitation.

Scopes:
  • meeting:read:admin meeting:read
Parameters
  • meetingId integer The meeting ID.
Zoom#meetingLiveStreamUpdate

src/index.js:17788-17835

Update a meeting's live stream.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
Zoom#meetingLiveStreamStatusUpdate

src/index.js:17875-17924

Update a meeting's live stream status.

Scopes:
  • meeting:write:admin meeting:write
Parameters
  • meetingId integer The meeting ID.
Zoom#dashboardClientFeedbackDetail

src/index.js:17990-18043

Retrieve Zoom Meetings Client Feedback Detail

Parameters
  • feedbackId string Feedback Detail Id
  • from string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • to string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • pageSize integer The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • nextPageToken string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#listimmessages

src/index.js:18104-18162

Retrieve IM Chat messages for a specified period of time.

Note: This API only supports oauth2.

Scopes:
  • imchat:read
Parameters
  • userId string The user ID or email address.
  • chatUser string Chat user's ID or email address.
  • channel string IM Channel's ID.
  • date string IM message's query date time, format as yyyy-MM-dd.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
Zoom#sendimmessages

src/index.js:18204-18244

Send chat messages between two users.

Note: This API only supports

Scopes:
  • imchat:write
Parameters
  • chatUser string Chat user's ID or email address.
Zoom#compliance

src/index.js:18291-18337

Notify Zoom that you comply with the Data Compliance policy which requires you to handle user's data in accordance to the user's preference after the user uninstalls your app.

Make a POST request to https://api.zoom.us/oauth/data/compliance and use Basic Auth with Client ID and Secret for authentication.

Zoom#webinarRegistrantGet

src/index.js:18392-18454

Get details on a specific registrant for a webinar.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • webinarId integer The webinar ID.
  • registrantId string The registrant ID.
  • occurrenceId string The meeting occurrence ID.
  • webinarId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • registrantId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#phoneUser

src/index.js:18497-18538

Retrieve a user's zoom phone profile.

Scopes:
  • phone:read, phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The user ID or email address.
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#updateUserProfile

src/index.js:18584-18624

Update a Zoom Phone user's profile.

Scopes:
  • phone:write phone:write:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#phoneUserSettings

src/index.js:18660-18693

Retrieve a user's zoom phone profile settings.

Scopes:
  • phone:read, phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The user ID or email address.
Zoom#phoneUserCallLogs

src/index.js:18761-18829

Retrieve a zoom phone user's call logs.

Scopes:
  • phone:read, phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The user ID or email address.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
  • from string Start date in 'yyyy-mm-dd' format.
  • to string End date.
  • type string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#phoneUserRecordings

src/index.js:18876-18919

Retrieve a user's zoom phone recordings.

Scopes:
  • phone:read, phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The user ID or email address.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
Zoom#phoneUserVoiceMails

src/index.js:18972-19020

Retrieve a user's zoom phone voicemails.

Scopes:
  • phone:read, phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The user ID or email address.
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
  • status string Status of the voice mail
Zoom#webinarAbsentees

src/index.js:19070-19118

List absentees for a webinar.

Scopes:
  • webinar:read:admin webinar:read
Parameters
  • occurrenceId string The meeting occurrence ID.
  • pageSize integer The number of records returned within a single API call.
  • nextPageToken string The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
  • webinarUuid string The webinar UUID.
Zoom#tspUrlUpdate

src/index.js:19154-19194

A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.

Scopes:
  • tsp:write
Parameters
  • userId string The userId or email address of the user.
Zoom#accountCallLogs

src/index.js:19257-19307

Retrieve call logs for an account.

Scopes:
  • phone:read:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
  3. Account Owner and a role with Zoom Phone Management
Parameters
  • pageSize integer The number of records returned within a single API call.
  • pageNumber integer The current page number of returned records.
  • from string Start date from which you would like to get the call logs. The start date should be within past six months.
  • to string The end date upto which you would like to get the call logs for. The end date should be within past six months.
  • type string The type of the call logs. The value can be either "all" or "missed".
Zoom#assignPhoneNumber

src/index.js:19356-19403

Assign a phone number to a user who has already enabled Zoom Phone.

Scopes:
  • phone:write phone:write:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#UnassignPhoneNumber

src/index.js:19460-19517

Unassign phone number of a Zoom phone user.

After assigning a phone number, you can remove it if you don't want it to be assigned to anyone.

Scopes:
  • phone:write phone:write:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
  3. User must have been previously assigned a Zoom Phone number.
Parameters
  • userId string Provide either userId or email address of the user.
  • phoneNumberId string Provide either phone number or phoneNumberId of the user.
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • phoneNumberId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#assignCallingPlan

src/index.js:19570-19616

Assign calling plan to a Zoom Phone user.

Scopes:
  • phone:write phone:write:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#unassignCallingPlan

src/index.js:19667-19716

Unassign a calling plan that was previously assigned to a Zoom Phone user.

Scopes:
  • phone:write phone:write:admin
Prerequisites:
  1. Business or Enterprise account
  2. A Zoom Phone license
Parameters
  • type string The type of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
  • type string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#retrieveCallStatus

src/index.js:19754-19795

Retrieve the call status of a user's calls.

Parameters
  • userId string The user Id of the user.
  • userId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#accountPlanBaseDelete

src/index.js:19842-19884

Cancel a base plan for a sub account. Only a master account holder who pays for this sub account can cancel the plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session.

Scopes:
  • billing:master
Parameters
  • accountId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#accountPlanAddonCancel

src/index.js:19928-19971

Cancel additional plan for a sub account. Only a Master account holder who pays for this sub account can cancel the add-on. The cancellation does not provide refund for the current subscription. The service remains active for the current session.

Parameters
  • accountId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#reportSignInSignOutActivities

src/index.js:20022-20067

Retrieve a list of sign in / sign out activity logs report of users under a Zoom account.

Parameters
  • from string Start date for which you would like to view the activity logs report.
  • to string End date up to which you would like to view the activity logs report.
  • pageSize integer The number of records to be returned within a single API call
  • nextPageToken string Next page token is used to paginate through large result sets
Zoom#getGroupSettings

src/index.js:20103-20136

Get settings for a group.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:read:admin
Parameters
  • groupId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#updateGroupSettings

src/index.js:20257-20379

Update settings for a group.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
  • groupId string Id of the group.
  • groupId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#getGroupLockSettings

src/index.js:20420-20461

Retrieve a group's locked settings. If you lock a setting, the group members will not be able to modify it individually.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:read:admin
Parameters
  • groupId string Id of the group.
  • groupId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#groupLockedSettings

src/index.js:20573-20684

Update a group's locked settings. If you lock a setting, the group members will not be able to modify it individually.

Prerequisites:

Pro, Business, or Education account

Scopes:
  • group:write:admin
Parameters
  • groupId string The Id of the group.
  • groupId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#getRoleInformation

src/index.js:20729-20770

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.

Use this API to get information including specific privileges assigned to a role.

Prerequisites:

An Enterprise, Business, Education or Pro plan. For role management and updates, you must be the Account Owner or user with role management permissions.

Scopes:
  • role:read:admin
Parameters
  • roleId string Role Id.
  • roleId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#updateRole

src/index.js:20826-20879

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.

Use this API to change the privileges, name and description of a specific role.

Prerequisites:

An Enterprise, Business, Education or Pro plan. For role management and updates, you must be the Account Owner or user with role management permissions.

Scopes:
  • role:write:admin
Parameters
  • roleId string Role Id
  • roleId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#deleteRole

src/index.js:20924-20965

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.

Use this API to delete a role.

Prerequisites:

An Enterprise, Business, Education or Pro plan. For role management and updates, you must be the Account Owner or user with role management permissions.

Scopes:
  • role:write:admin
Parameters
  • roleId string Role Id.
  • roleId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#getPlanUsage

src/index.js:21003-21036

Get information on usage of plans on a Master Account.

Prerequisites:

Account type: Master Account on a paid Pro, Business or Enterprise plan.

Scopes:
  • billing:master
Parameters
  • accountId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.
Zoom#updateAccountOwner

src/index.js:21089-21137

The current account owner can change the owner of an account to another user on the same account.

Use this API to change the owner of an account.

Prerequisites:

Current account owner permissions. Account type must be either Trial with Credit Card, Pro, Education, Business or API Partner Zoom account.

Scopes:
  • account:read:admin, account:write:admin or account:master
Parameters
  • accountId string Account Id of the account.
  • accountId string The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at api.zoom.us/v2/.For instance you can list all users on an account via https://api.zoom.us/v2/users/.