Zoommtg

Zoommtg

Zoom Meeting namespace.

Methods

callOut(params)

The method will invite yourself to join meeting by phone
Example
Zoommtg.callOut({
	phoneNumber: '+18005551000'
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
phoneNumber string

getAttendeeslist(params)

Get current attendees list
Example
Zoommtg.getAttendeeslist({});
Parameters:
Name Type Description
params Object

init(params)

Init Zoom Meeting
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
debug boolean <optional>
false Turn on debug mode can print log in browser console log
leaveUrl string Post message page url after leave meeting, like “http://www.zoom.us”
showMeetingHeader boolean <optional>
true Show or hide the meeting header, includes meeting number and topic
disableInvite boolean <optional>
false Enable or disable invite function
disableCallOut boolean <optional>
false Enable or disable call out function
disableRecord boolean <optional>
false Enable or disable record function
disableJoinAudio boolean <optional>
false Enable or disable join audio function
success Zoommtg~successCallback Call back function on success
error Zoommtg~errorCallback Call back function on error

join(params)

Join Meeting
Example
Zoommtg.join({
	meetingNumber: 123456789,
	userName: 'Zoomie Userton',
	password: '',
	apiKey: 'API_KEY',
	signature: 'SIGNATURE'
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Default Description
meetingNumber int Zoom meeting number
userName string Display name in meeting
passWord string '' Meeting password, if no password, set to ''
apiKey string REST API Key
signature string See Generating a signature for a How-to

showCalloutFunction(params)

Show/Hide call out function
Example
Zoommtg.showCalloutFunction({
	show: false
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
show boolean

showInviteFunction(params)

Show/Hide invite function
Example
Zoommtg.showInviteFunction({
	show: false
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
show boolean

showJoinAudioFunction(params)

Show/Hide join audio function
Example
Zoommtg.showJoinAudioFunction({
	show: false
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
show boolean

showMeetingHeader(params)

Show/Hide meeting header
Example
Zoommtg.showMeetingHeader({
	show: false
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
show boolean

showRecordFunction(params)

Show/Hide record function
Example
Zoommtg.showRecordFunction({
	show: false
 });
Parameters:
Name Type Description
params Object
Properties
Name Type Description
show boolean

Type Definitions

errorCallback(res)

Error Callback
Parameters:
Name Type Description
res Object Response Object
Properties
Name Type Description
method string API Method
status boolean Status of call
errorCode int Error Code
errorMessage string Error message
result Object Response result object

successCallback(res)

Success Callback
Parameters:
Name Type Description
res Object Response Object
Properties
Name Type Description
method string API Method
status boolean Status of call
errorCode int Error Code
errorMessage string Error message
result Object Response result object