Scheduled Meeting - Create a scheduled meeting
This API creates a scheduled meeting. Scheduled meetings are valid for till after 1 day from the start time of the meeting.
Header Parameters
The content type should be application/json
You need an app created on the JioMeet Platform and using the app credentials you can create a JWT to access this API. The JWT should have an issuer and the key "app" with the app id generated from the Plaform.
Request Body
The topic of the meeting
The start time of the meeting in ISO format
The end time of the meeting in ISO format
This boolean describes whether to auto recording the call. The recording starts automatically when there are more than 1 user in the call if this flag is enabled
advancedOptions object
This boolean describes whether to allow users to join the meeting before the host
This boolean describes whether to enable the waiting room for the meeting
This boolean describes whether to hard mute all participants in the meeting
This boolean describes whether to hard mute all participants in the meeting
This boolean describes whether to enable classroom mode for the meeting
- 200
- 400
- 401
- 412
Success
Schema
The meeting id that can be used to update, delete or fetch this meeting
The 10 digit unique ID of the meeting
The topic of the meeting
This boolean describes whether to auto recording the call. The recording starts automatically when there are more than 1 user in the call if this flag is enabled
The start time of the meeting in ISO format
The end time of the meeting in ISO format
The duration of the meeting in milliseconds
The meeting link that the users will use to join the meeting. These users will be guest users and hence wont have any privileges to alter any meeting settings.
The meeting link that the hosts will use to join the meeting. These users will be host users and hence will have privileges to alter meeting settings.
This identifier allows a user to join with host privileges. To allow a user to join as host, append this parameter in the query parameters of the meetingLink. "hostToken" is the query change
Meeting secret that secures the meeting from unwanted access
The status of the meeting
advancedOptions object
This boolean describes whether to allow users to join the meeting before the host
This boolean describes whether to enable the waiting room for the meeting
This boolean describes whether to hard mute all participants in the meeting
This boolean describes whether to hard mute all participants in the meeting
This boolean describes whether to enable classroom mode for the meeting
{
"jiomeetId": "string",
"topic": "string",
"isAutoRecordingEnabled": true,
"startTime": "string",
"endTime": "string",
"scheduledDuration": 0,
"meetingUrl": "string",
"hostUrl": "string",
"hostToken": "string",
"roomPIN": "string",
"status": "string",
"advancedOptions": {
"joinBeforeHost": true,
"waitingRoom": true,
"participantHardAudioMute": true,
"participantHardVideoMute": true,
"isClassroomMode": true
}
}
Example scheduled meeting response
{
"jiomeetId": "5319535369",
"topic": "My Scheduled Meeting",
"isAutoRecordingEnabled": false,
"startTime": "2023-09-11T12:50:00.000Z",
"endTime": "2023-09-11T13:20:00.000Z",
"scheduledDuration": 1800000,
"meetingUrl": "https://platform.jiomeet.com/guest?meetingId=5319535369&pwd=n5CrU",
"hostUrl": "httpss://platform.jiomeet.com/guest?meetingId=5319535369&pwd=n5CrU&hostToken=Z5gdmTRSb11A",
"hostToken": "Z5gdmTRSb11A",
"advancedOptions": {
"joinBeforeHost": true,
"waitingRoom": false,
"participantHardAudioMute": false,
"participantHardVideoMute": false,
"isClassroomMode": false
},
"status": "active",
"roomPIN": "n5CaU",
"meetingId": "sm-77189593-f31a-4b62-941a-74f9147e465"
}
Schema
Status Code of the API
The error code of the API
The error message of the API
{
"customCode": 0,
"message": "string"
}
Schema
Status Code of the API
The error code of the API
The error message of the API
{
"customCode": 0,
"message": "string"
}
Schema
Status Code of the API
The error code of the API
The errors array which includes objects with a "property" and "message" properties describing the error
{
"customCode": 0,
"message": "string"
}