Schedule a live class
Schedule a live class
Method : POST
Base URL : https://api.braincert.com
API Endpoint : /v2/schedule?apikey=YOUR_API_KEY_HERE
All requests are POST and sent to https://api.braincert.com/v2/schedule?apikey=YOUR_API_KEY_HERE You will retrieve results assuming you have added your appKey, and require parameter.
Request parameters
Parameter
Type
Description
Example
title
required
Class title
string
start_time
required
Start time of class
09:30AM
end_time
required
End time of class
10:30AM
date
required
Date of class
2014-08-15
ispaid
optional
For class is free or paid
0 for free, 1 for paid
is_recurring
optional
class recurring
value 1 for recurring
weekdays
optional
Number for weekdays
Comma separated values between 1 to 7 See full weekdays list at below
end_classes_count OR end_date
optional
Number for end class, Class end date
10, 2014-08-20
seat_attendees
optional
Number for attendees in a live class
30
record
optional
Record this class
- 0 disable recording. - 1 enable recording. Instructor has to manually start/stop recording button. - 2 start recording automatically when class starts. - 3 start recording automatically when class starts and disable instructor from managing the recording button. Recording will be produced at the end of class time.
isRecordingLayout New
optional
Recording Layout
- 0 to use 'Standard layout' for recorded videos that captures minimalistic details such as whiteboard, videos, and chat. (API will assume '0' as default option if you don't pass this parameter). - 1 to use 'Enhanced layout' for recorded videos that captures the entire browser tab including all virtual classroom icons and user interface.
isVideo New
optional
Video output
- 0 Produces multiple recorded video files every time instructor clicks the stop recording button or refresh the browser when session is in progress (API will assume '0' as default option if you don't pass this parameter). - 1 Concatenates all the recorded video files into a single video file at the end of the session.
isBoard
optional
Allow loading only whiteboard or entire app with audio/video, and group chat.
- 0 for whiteboard + audio/video + attendee list + chat (API will assume '0' as default option if you don't pass this parameter). - 1 for whiteboard + attendee list. - 2 for whiteboard + attendee list + chat.
isLang
optional
Force Interface Language
- 0 to allow changing interface language by attendees - Value between 1 to 50 See 'Force Interface Language list' below
isCorporate
optional
Enable webcam and microphone upon entry
- 0 to disable webcam and microphone upon entry. Classroom is moderated and instructor has to pass microphone and webcam controls to attendees (API will assume '0' as default option if you don't pass this parameter) - 1 to allow attendees to enable their microphone and webcam without permission from instructor
isScreenshare
optional
Enable screen sharing
- 0 to disable screen sharing - 1 to enable screen sharing
isPrivateChat New
optional
Private chat
- 0 to allow students to private chat with each other. - 1 to enable only instructor to private chat with students and students cannot private chat with each other.
description
optional
Class Description
string
keyword
optional
keyword
String seperated by a comma
format
optional
Response data format
- xml for XML response, default JSON response
Response XML Example
https://api.braincert.com/v2/schedule?apikey=WbMlO5sAx1fmV&title=schedule&timezone=33&date=2014-11-11&start_time=09:30 AM&end_time=10:30AM& currency=usd&ispaid=0&is_recurring=1&repeat=1&weekdays=1,2,3&end_classes_count=10&seat_attendees=10&record=1&format=xml
Success Response
Error Response
Response JSON Example
https://api.braincert.com/v2/schedule?apikey=WbMlO5sAx1fmV&title=demo-class&timezone=33&date=2014-11-11&start_time=09:30 AM&end_time=10:30AM& currency=usd&ispaid=0&is_recurring=1&repeat=1&weekdays=1,2,3&end_classes_count=10&seat_attendees=10&record=1
Success Response
Error Response
Currency List
Force Interface Language
Datacenter region selection List
Repeat List
Weekdays List
TimeZone List
Last updated