Mastering Zoom SDK


On this page

Import

In order to use Zoom services, firstly you will need to import Zoom and initialize a zoomService instance within the constructor.

import { Zoom } from '@ionic-native/zoom/ngx';

constructor(private zoomService: Zoom) { }

Initialize Zoom SDK

Initialize the Zoom SDK with SDK key and secret. This method needs to be called when the app fired up (In app.component.ts):

this.zoomService.initialize(SDK_KEY, SDK_SECRET)
  .then((success: any) => console.log(success))
  .catch((error: any) => console.log(error));

Login

Login user with Zoom username and password.

this.zoomService.login(userName, password)
  .then((success: any) => console.log(success))
  .catch((error: any) => console.log(error));

Logout

This method will try to log the user out. If the logout is successful, it will return TRUE, otherwise, it will return FALSE:

this.zoomService.logout()
  .then((success: boolean) => console.log(success))
  .catch((error: any) => console.log(error));

isLoggedIn

This method checks whether a user is logged in or not. It will return true if the user is logged in. False if the user is not logged in.

this.zoomService.isLoggedIn()
  .then((success: boolean) => console.log(success))
  .catch((error: any) => console.log(error));

Meeting Options (Android Only)

You can configure meeting options for each meeting by setting up a JSON object with different options, and then pass to start/join a meeting.

let options = {
  "no_driving_mode":true,
  "no_invite":true,
  "no_meeting_end_message":true,
  "no_titlebar":false,
  "no_bottom_toolbar":false,
  "no_dial_in_via_phone":true,
  "no_dial_out_to_phone":true,
  "no_disconnect_audio":true,
  "no_share":true,
  "no_audio":true,
  "no_video":true,
  "no_meeting_error_message":true
};

Join Meeting

Simply pass meeting number, meeting password, display name to join a meeting:

this.zoomService.joinMeeting(meetingNumber, meetingPassword, displayName, options)
  .then((success: any) => console.log(success))
  .catch((error: any) => console.log(error));

Start an existing meeting for non-login user

If you would like to start an existing meeting for a non-login user, you will need to get a Zoom Access Key (ZAK) from the Zoom API. See Get a user's ZAK token for details. Once you have a ZAK, pass it to the startMeetingWithZAK method to start a meeting.

this.zoomService.startMeetingWithZAK(meetingNumber, vanityId, displayName, zoomAccessToken, userId, options)
  .then((success: any) => console.log(success))
  .catch((error: any) => console.log(error));

Start an existing meeting for logged in user

If you have an existing meeting number/vanity ID and you are already logged in, you can use the startMeeting method:

this.zoomService.startMeeting(meetingNumber, vanityId, options)
  .then((success: any) => console.log(success))
  .catch((error: any) => console.log(error));

Start an instant meeting for logged in user

If you would like to start an instant meeting, after you logged in, call startInstantMeeting method to start an instant meeting.

this.zoomService.startInstantMeeting()
  .then((success: anu) => console.log(success))
  .catch((error: any) => console.log(error));

Set language

If you want to change the language in the Zoom meeting UI (Not your Ionic app), you can pass a valid IETF BCP language tag to setLanguage method to change the in-meeting language:

this.zoomService.setLanguage(language)
  .then((success: anu) => console.log(success))
  .catch((error: any) => console.log(error));

Supported Languages and Parameters

The parameters are unified using IETF BCP 47 (https://tools.ietf.org/html/bcp47).

LanguageLanguage Tag / Parameter
Englishen-US
Simplified Chinesezh-CN
Japaneseja-JP
Germande-DE
Frenchfr-FR
Traditional Chinesezh-TW
Spanishes-419
Russianru-RU
Portuguesept-PT

Next Steps

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.