Zoom Conferencing API
API change historyList of APIs related to Conferencing (using Zoom)
Add batch Meetings according to NUS calendar
Add batch Meetings according to NUS calendar with ACL.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Input to create
{
"moduleID": "string",
"timetableInfos": [
{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"venue": "string",
"activityText": "string",
"modGrp": "string"
}
],
"lessonID": "string",
"isSendEmail": true,
"isPublishRecordURL": true,
"isWaitingRoom": true,
"meetingAuthentication": true,
"muteUponEntry": true,
"recordType": 0,
"authenticationOpt": 0,
"alternativeHosts": "string",
"meetingType": 0,
"exportMultimediaWeb": true,
"channelID": "string",
"channelName": "string",
"publishMutimediaChannel": true
}{
"description": "Input for Scheduled Meetings according to timetable",
"type": "object",
"properties": {
"moduleID": {
"format": "uuid",
"description": "ModuleID",
"type": "string"
},
"timetableInfos": {
"description": "List of timetable info",
"type": "array",
"items": {
"description": "-",
"type": "object",
"properties": {
"access": {
"description": "Access rights defined for the zoom meeting to be created.",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "Start Date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End Date",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"activityText": {
"description": "Activity Text",
"type": "string"
},
"modGrp": {
"description": "Class Number",
"type": "string"
}
}
}
},
"lessonID": {
"format": "uuid",
"description": "lesson ID when adding Zoom meeting to learning flow",
"type": "string"
},
"isSendEmail": {
"description": "Set true to send an email into partificants, otherwise false for without notification.",
"type": "boolean"
},
"isPublishRecordURL": {
"description": "Publish Cloud Record URL\r\nto publish Zoom cloud recording automatically when it is available after the 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"
},
"recordType": {
"format": "int32",
"description": "1. Cloud Recording\r\n2. Local Recording",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"authenticationOpt": {
"format": "int32",
"description": "1. 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",
"maximum": 2,
"minimum": 1,
"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",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"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"
}
}
}{
"moduleID": "string",
"timetableInfos": [
{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"venue": "string",
"activityText": "string",
"modGrp": "string"
}
],
"lessonID": "string",
"isSendEmail": true,
"isPublishRecordURL": true,
"isWaitingRoom": true,
"meetingAuthentication": true,
"muteUponEntry": true,
"recordType": 0,
"authenticationOpt": 0,
"alternativeHosts": "string",
"meetingType": 0,
"exportMultimediaWeb": true,
"channelID": "string",
"channelName": "string",
"publishMutimediaChannel": true
}{
"description": "Input for Scheduled Meetings according to timetable",
"type": "object",
"properties": {
"moduleID": {
"format": "uuid",
"description": "ModuleID",
"type": "string"
},
"timetableInfos": {
"description": "List of timetable info",
"type": "array",
"items": {
"description": "-",
"type": "object",
"properties": {
"access": {
"description": "Access rights defined for the zoom meeting to be created.",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "Start Date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End Date",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"activityText": {
"description": "Activity Text",
"type": "string"
},
"modGrp": {
"description": "Class Number",
"type": "string"
}
}
}
},
"lessonID": {
"format": "uuid",
"description": "lesson ID when adding Zoom meeting to learning flow",
"type": "string"
},
"isSendEmail": {
"description": "Set true to send an email into partificants, otherwise false for without notification.",
"type": "boolean"
},
"isPublishRecordURL": {
"description": "Publish Cloud Record URL\r\nto publish Zoom cloud recording automatically when it is available after the 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"
},
"recordType": {
"format": "int32",
"description": "1. Cloud Recording\r\n2. Local Recording",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"authenticationOpt": {
"format": "int32",
"description": "1. 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",
"maximum": 2,
"minimum": 1,
"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",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"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"
}
}
}{
"moduleID": "string",
"timetableInfos": [
{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"venue": "string",
"activityText": "string",
"modGrp": "string"
}
],
"lessonID": "string",
"isSendEmail": true,
"isPublishRecordURL": true,
"isWaitingRoom": true,
"meetingAuthentication": true,
"muteUponEntry": true,
"recordType": 0,
"authenticationOpt": 0,
"alternativeHosts": "string",
"meetingType": 0,
"exportMultimediaWeb": true,
"channelID": "string",
"channelName": "string",
"publishMutimediaChannel": true
}{
"description": "Input for Scheduled Meetings according to timetable",
"type": "object",
"properties": {
"moduleID": {
"format": "uuid",
"description": "ModuleID",
"type": "string"
},
"timetableInfos": {
"description": "List of timetable info",
"type": "array",
"items": {
"description": "-",
"type": "object",
"properties": {
"access": {
"description": "Access rights defined for the zoom meeting to be created.",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "Start Date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End Date",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"activityText": {
"description": "Activity Text",
"type": "string"
},
"modGrp": {
"description": "Class Number",
"type": "string"
}
}
}
},
"lessonID": {
"format": "uuid",
"description": "lesson ID when adding Zoom meeting to learning flow",
"type": "string"
},
"isSendEmail": {
"description": "Set true to send an email into partificants, otherwise false for without notification.",
"type": "boolean"
},
"isPublishRecordURL": {
"description": "Publish Cloud Record URL\r\nto publish Zoom cloud recording automatically when it is available after the 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"
},
"recordType": {
"format": "int32",
"description": "1. Cloud Recording\r\n2. Local Recording",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"authenticationOpt": {
"format": "int32",
"description": "1. 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",
"maximum": 2,
"minimum": 1,
"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",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"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"
}
}
}{
"moduleID": "string",
"timetableInfos": [
{
"access": {
"groupAccess": [
{
"groupID": "string",
"accessRole": {}
}
],
"userAccess": [
{
"userID": "string",
"accessRole": {}
}
],
"publicAccess": {},
"inheritedResourceID": "string"
},
"startDate": "string",
"endDate": "string",
"venue": "string",
"activityText": "string",
"modGrp": "string"
}
],
"lessonID": "string",
"isSendEmail": true,
"isPublishRecordURL": true,
"isWaitingRoom": true,
"meetingAuthentication": true,
"muteUponEntry": true,
"recordType": 0,
"authenticationOpt": 0,
"alternativeHosts": "string",
"meetingType": 0,
"exportMultimediaWeb": true,
"channelID": "string",
"channelName": "string",
"publishMutimediaChannel": true
}{
"description": "Input for Scheduled Meetings according to timetable",
"type": "object",
"properties": {
"moduleID": {
"format": "uuid",
"description": "ModuleID",
"type": "string"
},
"timetableInfos": {
"description": "List of timetable info",
"type": "array",
"items": {
"description": "-",
"type": "object",
"properties": {
"access": {
"description": "Access rights defined for the zoom meeting to be created.",
"allOf": [
{
"description": "input access with role definition",
"type": "object",
"properties": {
"groupAccess": {
"description": "Group access rights defined for this resource",
"type": "array",
"items": {
"description": "group role access",
"required": [
"accessRole",
"groupID"
],
"type": "object",
"properties": {
"groupID": {
"format": "uuid",
"description": "the group id",
"type": "string"
},
"accessRole": {
"description": "the role defined for the group",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"userAccess": {
"description": "Individual user access rights which is different from the groups the user belongs to (if any)",
"type": "array",
"items": {
"description": "user role access",
"required": [
"accessRole",
"userID"
],
"type": "object",
"properties": {
"userID": {
"format": "uuid",
"description": "individual id of the user",
"type": "string"
},
"accessRole": {
"description": "The role defined for the user",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
}
}
}
},
"publicAccess": {
"description": "the access rights which the user defined for public. null means NO_ACCESS",
"allOf": [
{
"format": "int32",
"description": "customized user role for IVLE.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
]
},
"inheritedResourceID": {
"format": "uuid",
"description": "not null means it follow permission from another resource",
"type": "string"
}
}
}
]
},
"startDate": {
"format": "date-time",
"description": "Start Date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End Date",
"type": "string"
},
"venue": {
"description": "Venue",
"type": "string"
},
"activityText": {
"description": "Activity Text",
"type": "string"
},
"modGrp": {
"description": "Class Number",
"type": "string"
}
}
}
},
"lessonID": {
"format": "uuid",
"description": "lesson ID when adding Zoom meeting to learning flow",
"type": "string"
},
"isSendEmail": {
"description": "Set true to send an email into partificants, otherwise false for without notification.",
"type": "boolean"
},
"isPublishRecordURL": {
"description": "Publish Cloud Record URL\r\nto publish Zoom cloud recording automatically when it is available after the 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"
},
"recordType": {
"format": "int32",
"description": "1. Cloud Recording\r\n2. Local Recording",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"authenticationOpt": {
"format": "int32",
"description": "1. 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",
"maximum": 2,
"minimum": 1,
"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",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"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"
}
}
}Responses
201 Created
Returns the meeting added records
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"
}
}
}{
"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"
}
}
}{
"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"
}string{
"type": "string"
}string{
"type": "string"
}403 Forbidden
Login user not authorized to perform this action
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}500 Internal Server Error
Server Error
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}Code samples
@ECHO OFF
curl -v -X POST "https://luminus.azure-api.net/zoom/Meeting/ScheduledMeetings"
-H "Content-Type: application/json-patch+json"
-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/ScheduledMeetings?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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/ScheduledMeetings");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json-patch+json");
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/ScheduledMeetings?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/ScheduledMeetings";
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:@"POST"];
// Request headers
[_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
[_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/ScheduledMeetings');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/zoom/Meeting/ScheduledMeetings?%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
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/zoom/Meeting/ScheduledMeetings?%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/ScheduledMeetings')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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