描述
通过接口创建课程直播
接口地址
http://api-class.e.vhall.com/api/class/create
请求参数
公共参数需要每次请求都附带上,详细内容请参考公共参数
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
child_id | int | 否 | 子账户ID |
subject | string | 是 | 课程标题, 字数上限<23个字符 |
start_time | int | 否 | Linux时间戳,直播开始时间默认为当前时间 |
duration | int | 否 | 课程时长(单位:分钟)默认为45分钟 |
desc | string | 是 | 课程描述, 字数上限<400个字符 |
layout | int | 是 | 课程布局 1:视频模式;3:文档模式; |
type | int | 是 | 课程类型 0:公开课;1:小课堂; |
interact_max_num | int | 否 | 【不填写参数】当课程类型=0时,连麦人数默认为7。当课程类型=1时,连麦人数默认为1。【填写参数】连麦人数 1:1V4路;3:1V8路;5:1V12路;7:1V1路。当课程类型=0时,连麦人数参数只可输入7。当课程类型=1时,连麦人数的参数可输入1、3、5,默认为1 |
interactive_mode | int | 否 | 不传默认标准模式 互动模式(只针对小课堂生效) 0:标准模式;1:极速模式; |
提示:课程创建成功后,课程类型、课程布局、连麦人数这三个参数不可修改。
响应参数
返回形如''{"code":200,"msg":"success","data":''的json。data值的数据类型如下:
参数名 | 类型 | 说明 |
---|---|---|
class_id | string | 创建成功,返回课程ID |
响应示例
{
"code": "200",
"msg": "创建成功",
"data": {
"class_id":"edu_xxx"
}
}
错误码
code | 含义 |
---|---|
10000 | 标题不能为空 |
10001 | 标题不能超过23个字符 |
10002 | 简介不能超过400个字符 |
10003 | 课程类型不能为空 |
10008 | 开始时间格式不正确 |
10009 | 课程布局参数不正确 |
10010 | 课程时长参数不正确 |
10011 | 课程简介不能为空 |
10015 | 课程时长不能超过780分钟 |
10016 | 开始时间不能小于当前时间 |
10024 | 连麦人数参数不合法 |
10025 | 连麦扩容包已经过期 |
10026 | 您还未开通多路连麦扩容包 |
10027 | 小课堂不支持此连麦人数类型 |
10028 | 公开课只支持1V1连麦人数 |
10029 | 互动模式参数错误 |
500 | 创建失败 |