课堂直播回放参数设置

此接口用于修改LMS课堂的网页直播回放相关参数。

注意事项

  • classId 和 activityId 至少传一个，两者均传时优先使用 activityId。
  • 除标识字段外，其余可选参数至少传一个才会触发实际修改。
  • 非双师子课堂不支持设置 useCoMainRecord。
  • 开课前 20 分钟内、上课中、以及上课结束后，部分参数不可编辑。具体参考ClassIn 帮助中心

URL

https://root_url/lms/activity/setWebcast

HTTP Request Methods

  • POST

编码格式

  • UTF-8

请求参数

Header 参数

参数名 类型 必填 说明
X-EEO-SIGN string 是 签名，规则见签名文档
X-EEO-UID string 是 机构 SID
X-EEO-TS string 是 时间戳
Content-Type string 是 固定值：application/json

Body 参数（JSON 格式）

参数名 类型 必填 说明
courseId integer 否 课程 ID
classId integer 否* 课堂 ID，与 activityId 二选一，优先取 activityId
activityId integer 否* 活动 ID，与 classId 二选一，优先取 activityId
recordState integer 否 是否开启录课，0=关闭，1=开启
recordType integer 否 录课类型，0=录制教室，1=录制现场，2=都录
liveState integer 否 是否开启直播，0=关闭，1=开启
openState integer 否 是否公开回放，0=关闭，1=开启
useCoMainRecord integer 否 是否使用双师主课堂录制（仅双师子课堂可设置）
omoStationBroadcast integer 否 是否开启 OMO 站播，0=关闭，1=开启
watchByLogin integer 否 是否需要登录才能观看，0=否，1=是
watchPassword string 否 直播观看密码
allowUnloggedChat integer 否 是否允许未登录用户聊天，0=否，1=是
webcastAllForbidden integer 否 网页直播是否禁言，0=否，1=是
liveAndPlaybackViewingSet integer 否 直播回放观看权限设置：1-获得链接的用户均可观看（默认） 2-开启部分可见（参考后面设置），开启此设置时，必须同时开启上面的"观看时要求用户登录ClassIn账号"，否则该功能不生效，开启后，才可以设置观看成员，
liveAndPlaybackClassMemberState integer 否 本课堂成员（包括课堂老师、联席老师、学生、插班生及旁听）可看 0-未勾选，1-勾选（默认）
liveAndPlaybackUserState integer 否 是否指定学生观看 0-未勾选（默认），1-勾选，如果勾选，需要同时传 liveAndPlaybackStudentUids
liveAndPlaybackStudentUids array[integer] 否 可观看直播回放的学生 UID 列表
webcastIntroduce string 否 网页直播简介
customColumn string 否 机构自定义内容，原文返回
  • classId 与 activityId 至少传其中一个；除这两个字段外，其余可选参数至少传一个。

响应参数

参数名 类型 说明
code integer 状态码，1 表示成功
msg string 状态描述信息
data object 返回数据，可以为 null

请求示例

curl --location --request POST 'https://{root_url}/lms/activity/setWebcast' \
--header 'X-EEO-SIGN: {{sign}}' \
--header 'X-EEO-UID: {{UID}}' \
--header 'X-EEO-TS: {{timeStamp}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "courseId": 323232,
    "activityId": 123456,
    "recordState": 1,
    "recordType": 0,
    "liveState": 1,
    "openState": 1,
    "watchByLogin": 0,
    "webcastIntroduce": "本次直播课程简介"
}'

响应示例

成功响应

{
    "code": 1,
    "msg": "程序正常执行",
    "data": {
        "classId": 123456,
        "liveUrl": "https://www.eeo.cn/live.php?lessonKey=0bd41fae62e09a79",
        "liveInfo": {
            "RTMP": "rtmp://liveplay.eeo.cn/classlive/576f5a8ccf87-18329173b4b9e9fda?txSecret=40df809c82efe5db702a563566a07353&txTime=7d8d37cd",
            "HLS": "https://liveplay.eeo.cn/classlive/576f5a8ccf87-18329173b4b9e9fda.m3u8?txSecret=40df809c82efe5db702a563566a07353&txTime=7d8d37cd",
            "FLV": "https://liveplay.eeo.cn/classlive/576f5a8ccf87-18329173b4b9e9fda.flv?txSecret=40df809c82efe5db702a563566a07353&txTime=7d8d37cd"
        }
    }
}

错误码说明

通用错误码

错误码 说明
101001001 业务参数错误
101002005 签名异常
101002006 时间戳过期
101002008 时间戳不存在

业务错误码

错误码 说明
104 未知错误
145 该单课已结束
350 开课前20分钟内不能修改课堂名称、上课时间、云盘资源、台上人数、录课、直播
121601005 不支持设置网页直播
121601006 不支持设置录制现场
121601009 机构无直播权限
121601010 机构无录播权限
121601031 课堂不属于该机构
121601045 课堂已删除
121604007 不支持设置 OMO 站播
121604008 非双师子课堂不支持 useCoMainRecord 设置
122301037 录课直播相关参数不匹配

results matching ""

    No results matching ""