Web Client SDK

Please note that as of January 10th, all older versions of the Web SDK (versions 1.8.3 and below) will no longer have computer audio functionality within meetings. Please upgrade to version 1.8.5 or above to avoid service disruption.

Zoom offers a web based HTML5 client that is used in environments where the end users cannot download zoom desktop clients due to internal IT restrictions or in very low bandwidth environments.

The web client lets end users join a meeting, receive screen share from other attendees, join the meeting through the phone and leave the meeting. Zoom has added a Web SDK as part of our developer platform to enable developers to embed this into their web apps. Key functions that are exposed include: init meeting config, join meeting, show/hide invite function, show/hide meeting header, get attendees list, call out, invite by phone, mute, unmute, mute all, unmute all, rename, expel, record, lock meeting, leave meeting, end meeting.

Supported Browsers: Google Chrome, Safari, and Mozilla Firefox with their latest version

Getting Started with Meetings

Web-Client-SDK Overview

Using the SDK

Refer to the Web SDK Documentation

Upcoming changes

Upgrading from 1.8.3 to 1.8.6

Since we replaced jQuery with Axios, you will need to change the following line.

default en-US.json

$.i18n -> ZoomMtg.i18n

case 1: load en-US, jp-JP, zh-CN, but use jp-JP by default

ZoomMtg.i18n.load('en-US');
ZoomMtg.i18n.load('jp-JP');
ZoomMtg.i18n.load('zh-CN');
ZoomMtg.i18n.reload('jp-JP');

case 2: only load jp-JP
ZoomMtg.i18n.load('jp-JP');
ZoomMtg.i18n.reload('jp-JP');

case 3: load youself json file

ZoomMtg.i18n.load('you jason url', 'you-lang-name');
ZoomMtg.i18n.reload('you-lang-name');

other: if you joined meeting and want change language, you need add another api
ZoomMtg.reRender({lang: 'zoom support language or you-lang-name' });

Dependencies

"dependencies": {
	"react": "16.8.6",
	"react-dom": "16.8.6",
	"redux": "3.7.2",
	"react-redux": "7.1.0",
	"lodash": "^4.17.14",
	"redux-thunk": "2.2.0"
}

CDN Accelerated

Global CDN source.zoom.us

China CDN jssdk.zoomus.cn

Include the source

<script src="https://source.zoom.us/zoom-meeting-1.8.6.min.js"></script>

or

npm install @zoomus/[email protected]

zoomus-jssdk move to @zoomus/websdk

import { ZoomMtg } from 'zoomus-jssdk';
change to
import { ZoomMtg } from '@zoomus/websdk';

Please notice, 1.8.6 release with two ways, the normal way and npm way(need babel and webpack).

At first, you invoke those three API to init jssdk.

console.log('checkSystemRequirements');
console.log(JSON.stringify(ZoomMtg.checkSystemRequirements()));

// it's option if you want to change the WebSDK dependency link resources. setZoomJSLib must be run at first
// if (!china) ZoomMtg.setZoomJSLib('https://source.zoom.us/1.8.6/lib', '/av'); // CDN version default
// else ZoomMtg.setZoomJSLib('https://jssdk.zoomus.cn/1.8.6/lib', '/av'); // china cdn option
// ZoomMtg.setZoomJSLib('http://localhost:9999/node_modules/@zoomus/websdk/dist/lib', '/av'); // Local version default, Angular Project change to use cdn version

ZoomMtg.preLoadWasm();
ZoomMtg.prepareJssdk();

Go to see sample web app (CDN version) how to update 1.8.6

Screen share

ZoomMtg.init({
...
screenShare: true, // default, and it also require account's sharing setting enabled.
...    
})

Chat

ZoomMtg.init({
...
isSupportChat: true, // default, and it also require account's sharing setting enabled.
...    
})

Webinar notice

If you want to join webinar you will need to add your email to the userEmail property within the join method and set the role to 0 within the meetingConfig function.

ZoomMtg.join({
...
userEmail: "[email protected]",
...    
})

 role: 0

Video, Computer Audio and Sharing Supported browser

Please note: The WebSDK doesn't support IE10 and Edge Legacy currently.

Support

For any issues regarding our Web Client SDK, please visit our new Community Support Forum at

https://devforum.zoom.us/

Register your API Key/Secret

Transitioning-your-developer-apps-to-zooms-marketplace

Quick start

More detail

https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/getting-started/integrate-the-sdk

sample web app (CDN version) with dependecies.

git clone https://github.com/zoom/sample-app-web.git --branch master --depth 1
cd sample-app-web/CDN
npm install
npm run start

sample web app (local version)

git clone https://github.com/zoom/sample-app-web.git --branch master --depth 1
cd sample-app-web/Local
npm install
npm run start

open browser http://localhost:9999

run demo with https

we provide a https option, other machines can join the demo and test audio and video feature.

notice: the certification signed by localhost. don't use in your production.

npm run https

open browser https://localhost:9999

License

Use of this software is subject to important terms and conditions as set forth in the License file

Please refer to LICENSE.md file for details