Giao diện này được sử dụng để tạo buổi học (Lesson/Classroom).
Ghi chú:
- API này chỉ hỗ trợ tạo buổi học bình thường, không hỗ trợ tạo buổi học liên kết cho tính năng Lớp học liên kết (Dual teacher lesson).
- Số lượng buổi học trong một lớp có giới hạn.
- Tham số
screenModevàteachModekhông cần truyền bởi vì sẽ được định dạng theo thiết lậpcameraHide- Nếu
cameraHide=0(hiển thị bục giảng), thìteachMode=1vàscreenMode=1. - Nếu
cameraHide=1(không hiển thị bục giảng), thìteachMode=2vàscreenMode=2.
- Nếu
- Giao diện này không cho phép lựa chọn danh sách người tham gia hoạt động; mặc định
Publish to all members. - Sau khi tạo buổi học sẽ ở trạng thái hiển thị công khai – không thể tạo buổi học với dạng nháp thông qua API.
- Nếu buổi học được thiết lập tự động Ghi hình lưu về Cloud nhưng không mở livestream thì
datasẽ vẫn trả vềlive_url, nhưng phầnlive_infosẽ trống. - Nếu bật cả tự động Ghi hình lưu về Cloud và livestream thì 3 thông tin pulling stream addresses (RTMP, HLS, FLV) sẽ được tạo và gắn với buổi học. Thông tin
datasẽ trả vềlive_urlvà pulling streamlive_info. Nếu tính năng livestream bị tắt sau khi buổi học được tạo thì 3 thông tin pulling stream vẫn tồn tại. - Nếu không bật tự động ghi hình thì cả thông tin
live_urlvà pulling streamlive_infođều trống. recordType,recordState,liveState, vàopenStatelà các tham số bắt buộc truyền và liên quan với nhau, không được bỏ trống, nếu không sẽ bị báo lỗi.
Note:
- This interface only supports the creation of standard classrooms and does not support the creation of dual-teacher sub-classerooms.
- There is a limit on the total number of classes that can be created under a single course. If this limit is exceeded, an error will occur.
- The number of activities that can be created under a single unit (including classroom) is limited to 100. Exceeding this limit will result in an error.
- The parameters of
screenMode(screen mode) andteachMode(teaching mode) are not needed. They are assigned appropriate values based on the value ofcameraHide(whether to hide the seat area).- If
cameraHide=0(seat area shown), thenteachMode=1(online classroom) andscreenMode=1(standard mode). - If
cameraHide=1(seat area hidden), thenteachMode=2(smart classroom), andscreenMode=2(large-screen mode).
- If
- 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
datawill return the classroom web-live player addresslive_url, while the pulling stream addresslive_infowill 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
datawill return the classroom web-live player addresslive_urland the pulling stream addresseslive_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_urland the pulling stream addresseslive_infoin thedatawill be empty. recordType,recordState,liveState, andopenStateconstitute a complete set of parameters and cannot be partially passed; otherwise, an error will occur.
URL
https://api.eeo.cn/lms/activity/createClass
HTTP Request Methods
- POST
Coding Format
- UTF-8
Request Data
Header Parameters
| Key | Bắt buộc | Định dạng | Mô tả |
|---|---|---|---|
| X-EEO-SIGN | Bắt buộc | string | Signature; tham khảo cách tạo tại đây |
| X-EEO-UID | Bắt buộc | string | SID (Xem dữ liệu này tại Trang quản lý classin.com trong mục API) |
| X-EEO-TS | Bắt buộc | string | Timestamp (Thời gian UNIX Epoch là số giây đã trôi qua kể từ 00:00:00 (giờ chuẩn quốc tế) vào ngày 1 tháng 1 năm 1970) |
Body Parameters
Response Data
| Key | Định dạng | Phản hồi | Ý nghĩa |
|---|---|---|---|
| code | integer | 1 | Mã lỗi |
| msg | string | “Execution successful” | |
| data | object | ||
| └ activityId | integer | 25096094 | ID của hoạt động |
| └ classId | integer | 1141162 | ID buổi học |
| └ name | string | “API Created Classroom” | Tên lớp |
| └ live_info | object | ||
| └ RTMP | string | Địa chỉ pull stream theo giao thức RTMP | |
| └ HLS | string | Địa chỉ pull stream theo giao thức HLS | |
| └ FLV | string | Địa chỉ pull stream theo giao thức FLV | |
| └ live_url | string | Địa chỉ trang phát livestream/ phát lại ghi hình |
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"
}
}
