JavaScript Meeting API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

Create A Meeting

Method: Zoom.createMeeting(params,success,error)

Create a meeting on Zoom, return the created meeting URL.

Note:

  1. Instant meeting will not be returned when you call the “Zoom.listmeeting” JavaScript API. So if you want to persistent the meeting info, you have to do it yourself.

Success Callback Parameter:

{
"uuid":"5kEfqpc4REKZvUv+ViljxA==",
"id":884172112,
"host_id":"KqIYBT8nQuCO3HzB7UXLoQ",
"topic":"Test create meeting from JS API",
"password":"dddd",
"status":0,
"option_jbh":true,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
start_time":"2015-04-10T05:00:00Z",
"duration":60,
"timezone":"GMT+8:00",
"start_url":"https://ssotest.zoom.us/s/884172112?zpk=LDRQk0fD5ncMbWB1C5QbWGbrtu8R3M
N-4n6CY6ir0Uc.BwUAAAFMkfW9YgAAHCAkNmFmZjlhZGYtZTUxYi00MjE1LTgzMGQtZDFiMzE5OGIx
N2VlFktxSVlCVDhuUXVDTzNIekI3VVhMb1EWS3FJWUJUOG5RdUNPM0h6QjdVWExvUQpmb3N0Z
XIgaGFuZQByVjNGTE5ncGpWU1I0bHpCUHU1ak1TY2tBc090cHBvRVBKOGhzbnl5NUpKdy5DQUlB
QUFGTWtmVzlZZ0FualFBWVdrNDFXVUY2YzNCTmNtWjBRek5qTmpCSWMxaHVRVDA5RERORFFr
RjFiMmxaVXpOelBRAAAWR2NoOUhiZi1TVDIwWDVOTEo4OW9zZwIC",
"join_url":"https://ssotest.zoom.us/j/884172112?pwd=OowWkZhvqdU%3D",
"created_at":"2015-04-07T03:32:49Z"
}

 Note: 

"status" variable: 0 means meeting not started. 1 means meeting started. 2 means meeting finished.

join_url:

https://zoom.us/j/123456789

, partner can add “uname=xxxx” to the join meeting url to avoid Zoom client showing username dialog. Please note the username should be URL encoded.

https://zoom.us/j/123456789?uname=Flyer%20Li

Delete A Meeting

Delete a meeting on Zoom, return the deleted meeting id.

Method: Zoom.deleteMeeting(params, success, error);

 

Success Callback Parameter:

 
{
"id":"394126589",
"deleted_at":"2015-04-07T04:01:29Z
}

List Meetings

Method: Zoom.listMeeting(params,success,error);

Note: type=4 is PMI, type=5 is Recurring, type=6 is Webinar.

Success Callback Parameter:

 
{{"page_count":1,
"page_number":1,
"page_size":15,
"total_records":2,
"meetings":
[
{
"uuid":"5kEfqpc4REKZvUv+ViljxA==",
"id":884172112,
"host_id":"KqIYBT8nQuCO3HzB7UXLoQ",
"topic":"Test create meeting from JS API",
"password":"dddd",
"status":0,
"option_jbh":true,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
"start_time":"2015-04-10T05:00:00Z",
"duration":60,
"timezone":"GMT+8:00",
"start_url":"https://ssotest.zoom.us/s/884172112?zpk=LDRQk0fD5ncMbWB1C5QbWGbrtu8R3MN-4n6CY6ir0Uc.BwUAAAFMkfW9YgAAHCAkNmFmZjlhZGYtZTUxYi00MjE1LTgzMGQtZDFiMzE5OGIxN2VlFktxSVlCVDhuUXVDTzNIekI3VVhMb1EWS3FJWUJUOG5RdUNPM0h6QjdVWExvUQpmb3N0ZXIgaGFuZQByVjNGTE5ncGpWU1I0bHpCUHU1ak1TY2tBc090cHBvRVBKOGhzbnl5NUpKdy5DQUlBQUFGTWtmVzlZZ0FualFBWVdrNDFXVUY2YzNCTmNtWjBRek5qTmpCSWMxaHVRVDA5RERORFFrRjFiMmxaVXpOelBRAAAWR2NoOUhiZi1TVDIwWDVOTEo4OW9zZwIC",
"join_url":"https://ssotest.zoom.us/j/884172112?pwd=OowWkZhvqdU%3D",
"created_at":"2015-04-07T03:32:49Z"},
{
"uuid":"ej0bvwQPR86mJf9xdE11cw==",
"id":426931111,
"host_id":"KqIYBT8nQuCO3HzB7UXLoQ",
"topic":"Test create meeting from JS API",
"password":"dddd",
"status":0,
"option_jbh":true,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
"start_time":"2015-04-10T05:00:00Z",
"duration":60,
"timezone":"GMT+8:00",
"start_url":"https://ssotest.zoom.us/s/426931111?zpk=LDRQk0fD5ncMbWB1C5QbWGbrtu8R3MN-4n6CY6ir0Uc.BwUAAAFMkfW9YgAAHCAkNmFmZjlhZGYtZTUxYi00MjE1LTgzMGQtZDFiMzE5OGIxN2VlFktxSVlCVDhuUXVDTzNIekI3VVhMb1EWS3FJWUJUOG5RdUNPM0h6QjdVWExvUQpmb3N0ZXIgaGFuZQByVjNGTE5ncGpWU1I0bHpCUHU1ak1TY2tBc090cHBvRVBKOGhzbnl5NUpKdy5DQUlBQUFGTWtmVzlZZ0FualFBWVdrNDFXVUY2YzNCTmNtWjBRek5qTmpCSWMxaHVRVDA5RERORFFrRjFiMmxaVXpOelBRAAAWR2NoOUhiZi1TVDIwWDVOTEo4OW9zZwIC",
"join_url":"https://ssotest.zoom.us/j/426931111?pwd=OowWkZhvqdU%3D", "created_at":"2015-04-07T03:35:03Z"
}
]
}

Get Meeting Info

Get a meeting from Zoom, return the meeting info.

Method: Zoom.getMeeting(params,success,error);

Note: type=4 is PMI, type=5 is Webinar

Success Callback Parameter:

{
"uuid":"9qU8IsjNTUuFFjqyWohT7A==",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "dh23hdu23gd",
"topic": "Topic for this meeting",
"type": 2,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"password": "123",
"option_jbh": false,
"option_start_type":
"video",
"option_host_video": false,
"option_participants_video": false,
"option_audio": "both",
"status": 0
}


Update Meeting Info

Update meeting info on Zoom via meeting id.

Method: Zoom.updateMeeting(params,success,error);

JavaScript Meeting Object Defined and Description

Success Callback Parameter:

{
"id":"394126589",
"updated_at":"2015-04-07T04:01:29Z"
}

Get Personal Meeting Room

Get a personal meeting room from Zoom, return PMI meeting information.

Method: Zoom.getPMI(success,error);

Note: type=4 is PMI

Success Callback Parameter:

{
"uuid":"9qU8IsjNTUuFFjqyWohT7A==",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zpk=hs65q23kd9sqliy612h23k",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "dh23hdu23gd",
"topic": "Personal Meeting Room",
"type": 4,
"start_time": "",
"duration": 30,
"timezone": "America/Los_Angeles",
"password": "123",
"option_jbh": false,
"option_start_type": "video",
"option_host_video": false,
"option_participants_video": false,
"option_audio": "both",
"status": 0

End A Meeting

End a meeting on Zoom, return the ended meeting number.

Method: Zoom.endMeeting(params,success,error);

Success Callback Parameter:

{
"ended_at":"2015-04-07T05:11:25Z",
"id":"245156789"
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk