Get Class Launch URL

Method : POST

Base URL : https://api.braincert.com

API Endpoint : /v2/getclasslaunch?apikey=YOUR_API_KEY_HERE

All requests are POST and sent to https://api.braincert.com/v2/getclasslaunch?apikey=YOUR_API_KEY_HERE You will retrieve results assuming you have added your appKey, and require parameter.

Request parameters

Parameter	Type	Description	Example
class_id	required	Class id	10
userId	required	User id	35
userName	required	User Name	string
isTeacher	required	isTeacher	0 for Student, 1 for teacher
lessonName	required	lesson Name	string
courseName	required	Course Name	string
isExtend	optional	Extend class duration	- 0 Allow instructor to extend classroom time using the class timer option under 'class settings' (API will assume '0' as default option if you don't pass this parameter). - 1 Remove the timer option to extend the class duration in timer popup.
format	optional	Response data format	xml for XML response, default JSON response

Example request:

https://api.braincert.com/v2/getclasslaunch?apikey=WbMlO5sAx1fmV&class_id=34315&userId=19&userName=Teacher&isTeacher=1&courseName=education
&lessonName=tester&lessonTime=60&isRecord=0

Response XML Example

https://api.braincert.com/v2/getclasslaunch?apikey=WbMlO5sAx1fmV&format=xml

Success Response

<rsp status="ok">
  <method>getclasslaunch</method>
  <class_id>682</class_id>
  <launchurl>https://api.braincert.com/html5/build/whiteboard.php?token=okkNDA4b31SpArZ8hDDFA6jRAbeMHS02qltYcIJuD3n3slWLnXbHnaY92o2938snNI6BaQSbd2ndhutkHalWQnabd82CX
  </launchurl>
  <encryptedlaunchurl>https://api.braincert.com/html5/build/whiteboard.php?token=okkNDA4b31SpArZ8hDDFA6jRAbeMHS02qltYcIJuD3n3slWLnXbHnaY92o2938snNI6BaQSbd2ndhutkHalWQnabd82CX
  </encryptedlaunchurl>
</rsp>

Error Response

<rsp status="error">
   <errors> error </errors>
</rsp>

Response JSON Example

https://api.braincert.com/v2/getclasslaunch?apikey=WbMlO5sAx1fmV

Success Response

{
  "status":"ok",
  "class_id":"682",
  "method":"getclasslaunch",
  "launchurl":"https://api.braincert.com/html5/build/whiteboard.php?token=okkNDA4b31SpArZ8hDDFA6jRAbeMHS02qltYcIJuD3n3slWLnXbHnaY92o2938snNI6BaQSbd2ndhutkHalWQnabd82CX",
  "encryptedlaunchurl":"https://api.braincert.com/html5/build/whiteboard.php?token=okkNDA4b31SpArZ8hDDFA6jRAbeMHS02qltYcIJuD3n3slWLnXbHnaY92o2938snNI6BaQSbd2ndhutkHalWQnabd82CX"
}

Error Response

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