Zoom Conferencing API

API change history

List of APIs related to Conferencing (using Zoom)

Get sync zoom data

Get sync data from zoom to LumiNUS.

Try it

Request

Request URL

https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync

Request parameters

ID

string

Format - uuid. Meeting Id

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns meeting information

Representations

{
  "description": "Zoom meeting object.",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "The Meeting ID.",
      "type": "string"
    },
    "name": {
      "description": "The Meeting Name.",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "the date which this resource is open to students.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "the date which this resource is closed from students.",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this record is created.",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this record.",
      "type": "string"
    },
    "readonlyAccess": {
      "description": "whether the login user has read only access.",
      "type": "boolean"
    },
    "userID": {
      "description": "The NUSNETID of the user who created this meeting.",
      "type": "string"
    },
    "userName": {
      "description": "The name of the user who created this meeting.",
      "type": "string"
    },
    "email": {
      "description": "The email address of the user who created this meeting.",
      "type": "string"
    },
    "topic": {
      "description": "The topic of the meeting.",
      "type": "string"
    },
    "apiUserName": {
      "description": "The API username for zoom.",
      "type": "string"
    },
    "meetingID": {
      "description": "The meeting id used in joining a zoom meeting.",
      "type": "string"
    },
    "meetingDuration": {
      "format": "int32",
      "description": "The number of duration  of a meeting.",
      "type": "integer"
    },
    "meetingPassword": {
      "description": "The system generated password to used in joining a zoom meeting.",
      "type": "string"
    },
    "joinUrl": {
      "description": "Join url for meeting",
      "type": "string"
    },
    "hostKey": {
      "description": "Host Key for meeting",
      "type": "string"
    },
    "isSendEmail": {
      "description": "Send email to notify or not",
      "type": "boolean"
    },
    "isPublishRecordURL": {
      "description": "Publish Cloud Record URL",
      "type": "boolean"
    },
    "isSetPassword": {
      "description": "Password for joining meeting",
      "type": "boolean"
    },
    "isWaitingRoom": {
      "description": "Enable waiting room option",
      "type": "boolean"
    },
    "meetingAuthentication": {
      "description": "Enable meeting authentication",
      "type": "boolean"
    },
    "muteUponEntry": {
      "description": "Enable mute upon entry",
      "type": "boolean"
    },
    "notFoundInZoom": {
      "description": "Meeting not found in Zoom",
      "type": "boolean"
    },
    "recordType": {
      "description": "Recording Type",
      "allOf": [
        {
          "format": "int32",
          "description": "Avaliable Recording Types",
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer"
        }
      ]
    },
    "authenticationOpt": {
      "format": "int32",
      "description": "Authentication Optins, \r\n1. Sign in to NUS Zoom account https://nus-sg.zoom.us \r\nauthentication_domains : .u.yale-nus.edu.sg,*.u.nus.edu,*.comp.nus.edu.sg,*.yale-nus.edu.sg,*.nus.edu.sg,*.u.duke.nus.edu,*.duke-nus.edu.sg\r\n2. Sign in to Zoom",
      "type": "integer"
    },
    "alternativeHosts": {
      "description": "Alternative host's emails or IDs: multiple values separated by a comma.",
      "type": "string"
    },
    "meetingType": {
      "format": "int32",
      "description": "1. Exam option meeting Type\r\n2. Custom option meeting type\r\n3. Time table option meeting type",
      "type": "integer"
    },
    "moduleID": {
      "format": "uuid",
      "description": "Course id.",
      "type": "string"
    },
    "exportMultimediaWeb": {
      "description": "Export Zoom cloud recording\r\nto export Zoom cloud recording to multimedia web when it is available after the meeting. Need to active LTI ZoomPanoto first.",
      "type": "boolean"
    },
    "channelID": {
      "format": "uuid",
      "description": "ChannelID",
      "type": "string"
    },
    "channelName": {
      "description": "channel name",
      "type": "string"
    },
    "publishMutimediaChannel": {
      "description": "publish Mutimedia Channel\r\npublish status of Mutimedia Channel set",
      "type": "boolean"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "name": "string",
  "startDate": "string",
  "endDate": "string",
  "createdDate": "string",
  "creatorID": "string",
  "readonlyAccess": true,
  "userID": "string",
  "userName": "string",
  "email": "string",
  "topic": "string",
  "apiUserName": "string",
  "meetingID": "string",
  "meetingDuration": 0,
  "meetingPassword": "string",
  "joinUrl": "string",
  "hostKey": "string",
  "isSendEmail": true,
  "isPublishRecordURL": true,
  "isSetPassword": true,
  "isWaitingRoom": true,
  "meetingAuthentication": true,
  "muteUponEntry": true,
  "notFoundInZoom": true,
  "recordType": {},
  "authenticationOpt": 0,
  "alternativeHosts": "string",
  "meetingType": 0,
  "moduleID": "string",
  "exportMultimediaWeb": true,
  "channelID": "string",
  "channelName": "string",
  "publishMutimediaChannel": true
}

{
  "description": "Zoom meeting object.",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "The Meeting ID.",
      "type": "string"
    },
    "name": {
      "description": "The Meeting Name.",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "the date which this resource is open to students.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "the date which this resource is closed from students.",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this record is created.",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this record.",
      "type": "string"
    },
    "readonlyAccess": {
      "description": "whether the login user has read only access.",
      "type": "boolean"
    },
    "userID": {
      "description": "The NUSNETID of the user who created this meeting.",
      "type": "string"
    },
    "userName": {
      "description": "The name of the user who created this meeting.",
      "type": "string"
    },
    "email": {
      "description": "The email address of the user who created this meeting.",
      "type": "string"
    },
    "topic": {
      "description": "The topic of the meeting.",
      "type": "string"
    },
    "apiUserName": {
      "description": "The API username for zoom.",
      "type": "string"
    },
    "meetingID": {
      "description": "The meeting id used in joining a zoom meeting.",
      "type": "string"
    },
    "meetingDuration": {
      "format": "int32",
      "description": "The number of duration  of a meeting.",
      "type": "integer"
    },
    "meetingPassword": {
      "description": "The system generated password to used in joining a zoom meeting.",
      "type": "string"
    },
    "joinUrl": {
      "description": "Join url for meeting",
      "type": "string"
    },
    "hostKey": {
      "description": "Host Key for meeting",
      "type": "string"
    },
    "isSendEmail": {
      "description": "Send email to notify or not",
      "type": "boolean"
    },
    "isPublishRecordURL": {
      "description": "Publish Cloud Record URL",
      "type": "boolean"
    },
    "isSetPassword": {
      "description": "Password for joining meeting",
      "type": "boolean"
    },
    "isWaitingRoom": {
      "description": "Enable waiting room option",
      "type": "boolean"
    },
    "meetingAuthentication": {
      "description": "Enable meeting authentication",
      "type": "boolean"
    },
    "muteUponEntry": {
      "description": "Enable mute upon entry",
      "type": "boolean"
    },
    "notFoundInZoom": {
      "description": "Meeting not found in Zoom",
      "type": "boolean"
    },
    "recordType": {
      "description": "Recording Type",
      "allOf": [
        {
          "format": "int32",
          "description": "Avaliable Recording Types",
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer"
        }
      ]
    },
    "authenticationOpt": {
      "format": "int32",
      "description": "Authentication Optins, \r\n1. Sign in to NUS Zoom account https://nus-sg.zoom.us \r\nauthentication_domains : .u.yale-nus.edu.sg,*.u.nus.edu,*.comp.nus.edu.sg,*.yale-nus.edu.sg,*.nus.edu.sg,*.u.duke.nus.edu,*.duke-nus.edu.sg\r\n2. Sign in to Zoom",
      "type": "integer"
    },
    "alternativeHosts": {
      "description": "Alternative host's emails or IDs: multiple values separated by a comma.",
      "type": "string"
    },
    "meetingType": {
      "format": "int32",
      "description": "1. Exam option meeting Type\r\n2. Custom option meeting type\r\n3. Time table option meeting type",
      "type": "integer"
    },
    "moduleID": {
      "format": "uuid",
      "description": "Course id.",
      "type": "string"
    },
    "exportMultimediaWeb": {
      "description": "Export Zoom cloud recording\r\nto export Zoom cloud recording to multimedia web when it is available after the meeting. Need to active LTI ZoomPanoto first.",
      "type": "boolean"
    },
    "channelID": {
      "format": "uuid",
      "description": "ChannelID",
      "type": "string"
    },
    "channelName": {
      "description": "channel name",
      "type": "string"
    },
    "publishMutimediaChannel": {
      "description": "publish Mutimedia Channel\r\npublish status of Mutimedia Channel set",
      "type": "boolean"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "name": "string",
  "startDate": "string",
  "endDate": "string",
  "createdDate": "string",
  "creatorID": "string",
  "readonlyAccess": true,
  "userID": "string",
  "userName": "string",
  "email": "string",
  "topic": "string",
  "apiUserName": "string",
  "meetingID": "string",
  "meetingDuration": 0,
  "meetingPassword": "string",
  "joinUrl": "string",
  "hostKey": "string",
  "isSendEmail": true,
  "isPublishRecordURL": true,
  "isSetPassword": true,
  "isWaitingRoom": true,
  "meetingAuthentication": true,
  "muteUponEntry": true,
  "notFoundInZoom": true,
  "recordType": {},
  "authenticationOpt": 0,
  "alternativeHosts": "string",
  "meetingType": 0,
  "moduleID": "string",
  "exportMultimediaWeb": true,
  "channelID": "string",
  "channelName": "string",
  "publishMutimediaChannel": true
}

{
  "description": "Zoom meeting object.",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "The Meeting ID.",
      "type": "string"
    },
    "name": {
      "description": "The Meeting Name.",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "the date which this resource is open to students.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "the date which this resource is closed from students.",
      "type": "string"
    },
    "createdDate": {
      "format": "date-time",
      "description": "The date this record is created.",
      "type": "string"
    },
    "creatorID": {
      "format": "uuid",
      "description": "the ID of the user who created this record.",
      "type": "string"
    },
    "readonlyAccess": {
      "description": "whether the login user has read only access.",
      "type": "boolean"
    },
    "userID": {
      "description": "The NUSNETID of the user who created this meeting.",
      "type": "string"
    },
    "userName": {
      "description": "The name of the user who created this meeting.",
      "type": "string"
    },
    "email": {
      "description": "The email address of the user who created this meeting.",
      "type": "string"
    },
    "topic": {
      "description": "The topic of the meeting.",
      "type": "string"
    },
    "apiUserName": {
      "description": "The API username for zoom.",
      "type": "string"
    },
    "meetingID": {
      "description": "The meeting id used in joining a zoom meeting.",
      "type": "string"
    },
    "meetingDuration": {
      "format": "int32",
      "description": "The number of duration  of a meeting.",
      "type": "integer"
    },
    "meetingPassword": {
      "description": "The system generated password to used in joining a zoom meeting.",
      "type": "string"
    },
    "joinUrl": {
      "description": "Join url for meeting",
      "type": "string"
    },
    "hostKey": {
      "description": "Host Key for meeting",
      "type": "string"
    },
    "isSendEmail": {
      "description": "Send email to notify or not",
      "type": "boolean"
    },
    "isPublishRecordURL": {
      "description": "Publish Cloud Record URL",
      "type": "boolean"
    },
    "isSetPassword": {
      "description": "Password for joining meeting",
      "type": "boolean"
    },
    "isWaitingRoom": {
      "description": "Enable waiting room option",
      "type": "boolean"
    },
    "meetingAuthentication": {
      "description": "Enable meeting authentication",
      "type": "boolean"
    },
    "muteUponEntry": {
      "description": "Enable mute upon entry",
      "type": "boolean"
    },
    "notFoundInZoom": {
      "description": "Meeting not found in Zoom",
      "type": "boolean"
    },
    "recordType": {
      "description": "Recording Type",
      "allOf": [
        {
          "format": "int32",
          "description": "Avaliable Recording Types",
          "enum": [
            0,
            1,
            2
          ],
          "type": "integer"
        }
      ]
    },
    "authenticationOpt": {
      "format": "int32",
      "description": "Authentication Optins, \r\n1. Sign in to NUS Zoom account https://nus-sg.zoom.us \r\nauthentication_domains : .u.yale-nus.edu.sg,*.u.nus.edu,*.comp.nus.edu.sg,*.yale-nus.edu.sg,*.nus.edu.sg,*.u.duke.nus.edu,*.duke-nus.edu.sg\r\n2. Sign in to Zoom",
      "type": "integer"
    },
    "alternativeHosts": {
      "description": "Alternative host's emails or IDs: multiple values separated by a comma.",
      "type": "string"
    },
    "meetingType": {
      "format": "int32",
      "description": "1. Exam option meeting Type\r\n2. Custom option meeting type\r\n3. Time table option meeting type",
      "type": "integer"
    },
    "moduleID": {
      "format": "uuid",
      "description": "Course id.",
      "type": "string"
    },
    "exportMultimediaWeb": {
      "description": "Export Zoom cloud recording\r\nto export Zoom cloud recording to multimedia web when it is available after the meeting. Need to active LTI ZoomPanoto first.",
      "type": "boolean"
    },
    "channelID": {
      "format": "uuid",
      "description": "ChannelID",
      "type": "string"
    },
    "channelName": {
      "description": "channel name",
      "type": "string"
    },
    "publishMutimediaChannel": {
      "description": "publish Mutimedia Channel\r\npublish status of Mutimedia Channel set",
      "type": "boolean"
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

403 Forbidden

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/zoom/Meeting/{ID}/Sync?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/zoom/Meeting/{ID}/Sync?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://luminus.azure-api.net/zoom/Meeting/{ID}/Sync')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body