Create Classroom

This interface is used to create a classroom activity under a unit.

Note:

• This interface only supports the creation of standard classrooms and does not support the creation of dual-teacher sub-classerooms.
• The parameters of screenMode (screen mode) and teachMode (teaching mode) are not needed. They are assigned appropriate values based on the value of cameraHide (whether to hide the seat area).
  • If cameraHide=0 (seat area shown), then teachMode=1 (online classroom) and screenMode=1 (standard mode).
  • If cameraHide=1 (seat area hidden), then teachMode=2 (smart classroom), and screenMode=2 (large-screen mode).
• This interface does not support selecting the participants of the classroom activity; the default setting is to Publish to all members.
• This interface only supports the creation of published classrooms and does not support drafts.
• If cloud recording is enabled but web live streaming is not activated, the data will return the classroom web-live player address live_url, while the pulling stream address live_info will be empty.
• If both cloud recording and web live streaming are enabled, three pulling stream addresses (RTMP, HLS, FLV) will be generated and bound to the classroom. The data will return the classroom web-live player address live_url and the pulling stream addresses live_info. If the web-live streaming is later canceled, the three pulling stream addresses will still exist and remain bound to the classroom.
• If the classroom does not enable cloud recording, both the web-live player address live_url and the pulling stream addresses live_info in the data will be empty.
• recordType, recordState, liveState, and openState constitute a complete set of parameters and cannot be partially passed; otherwise, an error will occur.

URL

https://root_url/lms/activity/createClass

HTTP Request Methods

• POST

coding Format

• UTF-8

Request Data

Header Parameters

Body Parameters

Response Data

Sample

• HTTP request

POST /lms/activity/createClass HTTP/1.1
Host: root_url
X-EEO-SIGN: 5cb85cc272274a4353a9dc4c8dcdf0fc
X-EEO-UID: 409864
X-EEO-TS: 1722938160
Content-Type: application/json
Content-Length: 274

{
    "courseId": 414193,
    "unitId": 26020897,
    "name": "API Created Classroom",
    "teacherUid": 409864,
    "startTime": 1723010760,
    "endTime": 1723016760,
    "liveState": 1,
    "openState": 1,
    "recordState": 1,
    "recordType": 0
}

• Shell cURL analog request instruction

curl -X POST \
     -H 'Host: root_url' \
     -H 'X-EEO-SIGN: 5cb85cc272274a4353a9dc4c8dcdf0fc' \
     -H 'X-EEO-UID: 409864' \
     -H 'X-EEO-TS: 1722938160' \
     -H 'Content-Type: application/json' \
     -d '{"courseId": 414193, "unitId": 26020897, "name": "API Created Classroom", "teacherUid": 409864, "startTime": 1723010760, "endTime": 1723016760, "liveState": 1, "openState": 1, "recordState": 1, "recordType": 0}' \
     'https://root_url/lms/activity/createClass'

Response Sample（The normal return json packet example）

{
    "code": 1,
    "msg": "Execution successful",
    "data": {
        "activityId": 25107347,
        "classId": 1152680,
        "live_info": {
            "RTMP": "rtmp://liveplay.eeo.cn/eeolive/576f5a8c97de-18329123b10cec7d2?txSecret=c10b423a82cab861860081c02d03d87b&txTime=7d8d37cd",
            "HLS": "https://liveplay.eeo.cn/eeolive/576f5a8c97de-18329123b10cec7d2.m3u8?txSecret=c10b423a82cab861860081c02d03d87b&txTime=7d8d37cd",
            "FLV": "https://liveplay.eeo.cn/eeolive/576f5a8c97de-18329123b10cec7d2.flv?txSecret=c10b423a82cab861860081c02d03d87b&txTime=7d8d37cd"
        },
        "live_url": "https://www.eeo.cn/live.php?lessonKey=3dca7b0e14e3bb35",
        "name": "api-0829"
    }
}

Error Code Descriptions