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

ParameterTypeDescriptionExample
titlerequiredClass titlestring
timezonerequiredClass timezoneSee Full list of time-zone
start_timerequiredStart time of class09:30AM
end_timerequiredEnd time of class10:30AM
daterequiredDate of class2014-08-15
currencyoptionalCurrency of class USD
See full Currency List at below.
ispaidoptionalFor class is free or paid0 for free, 1 for paid
is_recurringoptionalclass recurringvalue 1 for recurring
repeatoptionalWhen class repeatsValue between 1 to 6
See full Repeat list at below
weekdaysoptionalNumber for weekdaysComma separated values between 1 to 7
See full weekdays list at below
end_classes_count
OR
end_date
optionalNumber for end class,
Class end date
10,
2014-08-20
seat_attendeesoptionalNumber for attendees in a live class30
recordoptionalRecord 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.
isVideo NewoptionalVideo 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.
isBoardoptionalAllow 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 optionalForce Interface Language- 0 to allow changing interface language by attendees
- Value between 1 to 50
See 'Force Interface Language list' below
isRegion optionalDatacenter region selectionSee 'Datacenter region selection list' below
isCorporateoptionalEnable 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
isScreenshareoptionalEnable screen sharing- 0 to disable screen sharing
- 1 to enable screen sharing
isPrivateChat NewoptionalPrivate 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.
formatoptionalResponse 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

<rsp status="ok">
  <title>schedule</title>
  <method>addclass</method>
  <class_id>12345</class_id>
</rsp>

Error Response

<rsp status="error">
  <method>schedule</method>
  <message>error message</message >
</rsp>

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

[{
   "Status":"OK",
   "method":"addclass",
   "class_id":619,
   "title":"demo-class"
}]

Error Response


[{
   "status":"error",
   "error":"Invalid API KEY"
}]




Currency List


AUD 
CAD 
EUR 
GBP 
NZD 
USD




Force Interface Language


1 =>arabic
2 =>bosnian
3 =>bulgarian
4 =>catalan
5 =>chinese-simplified
6 =>chinese-traditional
7 =>croatian
8 =>czech
9 =>danish
10 =>dutch
11 =>english
12 =>estonian
13 =>finnish
14 =>french
15 =>german
16 =>greek
17 =>haitian-creole
18 =>hebrew
19 =>hindi
20 =>hmong-daw
21 =>hungarian
22 =>indonesian
23 =>italian
24 =>japanese
25 =>kiswahili
26 =>klingon
27 =>korean
28 =>lithuanian
29 =>malayalam
30 =>malay
31 =>maltese
32 =>norwegian-bokma
33 =>persian
34 =>polish
35 =>portuguese
36 =>romanian
37 =>russian
38 =>serbian
39 =>slovak
40 =>slovenian
41 =>spanish
42 =>swedish
43 =>tamil
44 =>telugu
45 =>thai
46 =>turkish
47 =>ukrainian
48 =>urdu
49 =>vietnamese
50 =>welsh






Datacenter region selection List



0 => Intelligent routing to nearest location
1 => US East (Dallas, TX)  
2 => US West (Los Angeles, CA)  
3 => US East (New York)  
4 => Europe (Frankfurt, Germany)  
5 => Europe (London)  
6 => Asia Pacific (Bangalore, India)  
7 => Asia Pacific (Singapore)  
8 => US East (Miami, FL)  
9 => Europe (Milan, Italy)  
10 => Asia Pacific (Tokyo, Japan)  
11 => Middle East (Dubai, UAE)  
12 => Australia (Sydney)  
13 => Europe (Paris, France)  
14 => Asia Pacific (Hong Kong, China)
15 => Europe (Amsterdam, Netherlands)




Repeat List


1 =>Daily (all 7 days)
2=>6 Days(Mon-Sat)
3=>5 Days(Mon-Fri)
4=>Weekly
5=>Once every month
6=>On selected days




Weekdays List


1=> Sunday
2=> Monday
3=> Tuesday
4=> Wednesday
5=> Thursday
6=> Friday
7=> Saturday




TimeZone List


28=>(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London
30=>(GMT) Monrovia, Reykjavik
72=>(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
53=>(GMT+01:00) Brussels, Copenhagen, Madrid, Paris
14=>(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb
71=>(GMT+01:00) West Central Africa
83=>(GMT+02:00) Amman
84=>(GMT+02:00) Beirut
24=>(GMT+02:00) Cairo
61=>(GMT+02:00) Harare, Pretoria
27=>(GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius
35=>(GMT+02:00) Jerusalem
21=>(GMT+02:00) Minsk
86=>(GMT+02:00) Windhoek
31=>(GMT+03:00) Athens, Istanbul, Minsk
2=>(GMT+03:00) Baghdad
49=>(GMT+03:00) Kuwait, Riyadh
54=>(GMT+03:00) Moscow, St. Petersburg, Volgograd
19=>(GMT+03:00) Nairobi
87=>(GMT+03:00) Tbilisi
34=>(GMT+03:30) Tehran
1=>(GMT+04:00) Abu Dhabi, Muscat
88=>(GMT+04:00) Baku
9=>(GMT+04:00) Baku, Tbilisi, Yerevan
89=>(GMT+04:00) Port Louis
47=>(GMT+04:30) Kabul
25=>(GMT+05:00) Ekaterinburg
90=>(GMT+05:00) Islamabad, Karachi
73=>(GMT+05:00) Islamabad, Karachi, Tashkent
33=>(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi
62=>(GMT+05:30) Sri Jayawardenepura
91=>(GMT+05:45) Kathmandu
42=>(GMT+06:00) Almaty, Novosibirsk
12=>(GMT+06:00) Astana, Dhaka
41=>(GMT+06:30) Rangoon
59=>(GMT+07:00) Bangkok, Hanoi, Jakarta
50=>(GMT+07:00) Krasnoyarsk
17=>(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi
46=>(GMT+08:00) Irkutsk, Ulaan Bataar
60=>(GMT+08:00) Kuala Lumpur, Singapore
70=>(GMT+08:00) Perth
63=>(GMT+08:00) Taipei
65=>(GMT+09:00) Osaka, Sapporo, Tokyo
77=>(GMT+09:00) Seoul
75=>(GMT+09:00) Yakutsk
10=>(GMT+09:30) Adelaide
4=>(GMT+09:30) Darwin
20=>(GMT+10:00) Brisbane
5=>(GMT+10:00) Canberra, Melbourne, Sydney
74=>(GMT+10:00) Guam, Port Moresby
64=>(GMT+10:00) Hobart
69=>(GMT+10:00) Vladivostok
15=>(GMT+11:00) Magadan, Solomon Is., New Caledonia
44=>(GMT+12:00) Auckland, Wellington
26=>(GMT+12:00) Fiji, Kamchatka, Marshall Is.
6=>(GMT-01:00) Azores
8=>(GMT-01:00) Cape Verde Is.
39=>(GMT-02:00) Mid-Atlantic
22=>(GMT-03:00) Brasilia
94=>(GMT-03:00) Buenos Aires
55=>(GMT-03:00) Buenos Aires, Georgetown
29=>(GMT-03:00) Greenland
95=>(GMT-03:00) Montevideo
45=>(GMT-03:30) Newfoundland
3=>(GMT-04:00) Atlantic Time (Canada)
57=>(GMT-04:00) Georgetown, La Paz, San Juan
96=>(GMT-04:00) Manaus
51=>(GMT-04:00) Santiago
76=>(GMT-04:30) Caracas
56=>(GMT-05:00) Bogota, Lima, Quito
23=>(GMT-05:00) Eastern Time (US & Canada)
67=>(GMT-05:00) Indiana (East)
11=>(GMT-06:00) Central America
16=>(GMT-06:00) Central Time (US & Canada)
37=>(GMT-06:00) Guadalajara, Mexico City, Monterrey
7=>(GMT-06:00) Saskatchewan
68=>(GMT-07:00) Arizona
38=>(GMT-07:00) Chihuahua, La Paz, Mazatlan
40=>(GMT-07:00) Mountain Time (US & Canada)
52=>(GMT-08:00) Pacific Time (US & Canada)
104=>(GMT-08:00) Tijuana, Baja California
48=>(GMT-09:00) Alaska
32=>(GMT-10:00) Hawaii
58=>(GMT-11:00) Midway Island, Samoa
18=>(GMT-12:00) International Date Line West
105=>(GMT-4:00) Eastern Daylight Time (US & Canada)
13=>GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague