npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bunchtogether/zoom-api-v2

v1.0.5

Published

[![npm version](https://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2.svg)](http://badge.fury.io/js/%40bunchtogether%2Fzoom-api-v2)

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bunchtogetherbunchtogether

Keywords

Readme

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": "[email protected]",
      "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.

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](https://github.com/bunchtog