设置客户端回放为全员不可看
此为 LMS 课堂活动接口,用于为课堂活动将客户端回放可观看人员列表置空。
注意
- 关于客户端回放观看的名单设置有以下几个通用逻辑:
- 仅支持课堂活动,仅在课堂结束后可设置(包括接口和后台)。
- 人员默认值=课节授课教师+课节联席教师+课节学生(含插班生)+ 班级下其他老师 + 班级班主任
- 人员可选范围=课节授课教师+课节联席教师+班级下学生+班级下其他老师+班主任 - 调出生
- 根据上面的逻辑,如果学生在加入班级的时候选择不能查看历史回放,那么他会作为历史课堂的调出生,也就是说他无法设置为该课堂可观看名单。
- 目前为了兼容,接口支持传活动id和classId二选一,但是强烈建议传活动id。
- 关于本接口--设置客户端回放为全员不可看
URL
https://root_url/playback/setPlaybackAllForbidden
HTTP Request Methods
编码格式
请求参数
| key |
必填 |
类型 |
说明 |
| X-EEO-SIGN |
是 |
string |
签名 规则见这里 |
| X-EEO-UID |
是 |
string |
机构SID |
| X-EEO-TS |
是 |
string |
时间戳 |
Body 参数
| key |
必填 |
类型 |
说明 |
规则说明 |
| courseId |
是 |
integer |
班级(课程)ID |
|
| activityIds |
否 |
array[integer] |
课堂活动ID数组 |
和课节id二选一,如果有活动id优先使用活动id |
| classIds |
否 |
array[integer] |
课节ID数组 |
和活动id二选一,如果有活动id优先使用活动id |
响应参数
| 参数名 |
类型 |
示例值 |
含义 |
| code |
integer |
1 |
错误码 |
| msg |
string |
"程序正常执行" |
错误信息 |
| data |
object |
null |
返回信息 |
| └ successList |
array[int] |
|
设置成功的活动id/课节id |
| └ failedList |
array[object] |
1 |
设置失败的活动id/课节id和错误信息 |
| └ activityId |
int |
|
传入的活动id |
| └ classId |
int |
|
传入的课节id |
| └ code |
int |
|
错误码 |
| └ msg |
string |
|
错误信息 |
示例
POST /playback/setPlaybackAllForbidden HTTP/1.1
root_url
ceb7a2c0534999960c02c191d409c41e
409864
1722938382
application/json
117
{
"courseId": 414193,
"activityId": [25096097,25096099]
}
curl -X POST \
-H 'Host: root_url' \
-H 'X-EEO-SIGN: ceb7a2c0534999960c02c191d409c41e' \
-H 'X-EEO-UID: 409864' \
-H 'X-EEO-TS: 1722938382' \
-H 'Content-Type: application/json' \
-d '{"courseId": 414193, "activityId": [25096097,25096099]}' \
'https://root_url/playback/setPlaybackAllForbidden'
响应示例(正常时返回的 json 数据包示例)
{
"code": 1,
"msg": "程序正常执行",
"data": {
"successList": [25096097,25096099],
"failedList": []
}
}
错误码说明
| 错误码 |
说明 |
| 147 |
没有此课程信息 |
| 29149 |
活动已删除 |
| 30002 |
活动不存在 |
| 101002005 |
签名异常 |
| 101002006 |
时间戳过期 |
| 101002008 |
时间戳不存在 |
| 121601020 |
业务参数错误 |
| 121601021 |
课程不属于当前机构下 |
| 121601022 |
课程不是标准课 |
| 121601023 |
课程已过期 |
| 121603001 |
课堂信息不存在 |
| 121609004 |
课节不存在或不属于该机构 |
| 121609005 |
课节未结束 |
| 121609006 |
课节未开启录课 |