描述

通过此接口可配置课中工具,来决定课堂前台界面某些功能按钮是否显示。例如:文档、白板、答题等按钮是否显示

接口地址

http://api-class.e.vhall.com/api/class/configure/configure-class-tools

请求参数

公共参数需要每次请求都附带上,详细内容请参考公共参数

参数名 类型 必选 说明
config_type int 1 针对用户名下所有课堂进行全局设置 2 针对单独课堂进行设置(区分文档布局和白板布局)
class_id string 课堂ID(当config_type=2时 class_id必须传入)
tool_doc int 课中工具文档是否显示 1显示 0隐藏 (默认显示,当config_type=1时,tool_doc和tool_whiteBoard参数必须选择一个,或当config_type=2时并且课堂为文档布局时,tool_doc和tool_whiteBoard参数必须选择一个,当config_type=2时并且课堂为单视频布局时,不处理文档和白板字段)
tool_whiteBoard int 课中工具白板是否显示 1显示 0隐藏 (默认显示,当config_type=1时,tool_doc和tool_whiteBoard参数必须选择一个,或当config_type=2时并且课堂为文档布局时,tool_doc和tool_whiteBoard参数必须选择一个,当config_type=2时并且课堂为单视频布局时,不处理文档和白板字段)
tool_sharingDesktop int 课中工具共享桌面是否显示 1显示 0隐藏 (默认显示)
tool_answer int 课中工具答题是否显示 1显示 0隐藏 (默认显示)
tool_upload_doc int 用户课中上传文档按钮是否显示 1显示 0隐藏 (默认显示)
tool_mediaplayer int 课中工具插播是否显示 1显示 0隐藏 (默认显示)
tool_exam int 课中工具考试是否显示 1显示 0隐藏 (默认显示)
tool_answercard int 课中工具答题器是否显示 1显示 0隐藏 (默认显示)
tool_questionandanswer int 课中工具问答是否显示 1显示 0隐藏 (默认显示)

响应参数

返回数据如下:

参数名 类型 说明
code int 响应状态码 200 代表成功
msg string 响应失败时的描述

响应示例

{
    "code": 200,
    "msg": "",
    "data": []
}

错误码

code 含义
10005 课程不存在
10037 课中不允许更改活动配置
10038 课中工具参数配置错误