以下提到的account为接入方主播账号或ID或手机号等,每个主播需具有独立唯一的account标识(注意:这个account不是欢拓后台的主播ID)
添加课程
api名称:course.add
,SDK对应方法:courseAdd
应用参数说明:
名称 |
类型 |
必选 |
描述 |
course_name |
string |
Y |
课程名称 |
account |
string |
Y |
接入方主播账号或ID或手机号等,最长32位 |
start_time |
string |
Y |
课程开始时间,格式: 2015-01-10 12:00:00 |
end_time |
string |
Y |
课程结束时间,格式: 2015-01-10 13:00:00 (如果是伪直播,start_time等于end_time时,会自动根据关联信息的时长修改end_time,使伪直播时长等于关联对像的时长) |
nickname |
string |
Y |
主播的昵称 |
accountIntro |
string |
N |
主播的简介 |
options |
object |
N |
其他选项 |
|
|
|
departmentId 部门id,设置课程所属部门 |
|
|
|
barrage 是否开启弹幕:0 关闭,1 开启 |
|
|
|
robotNumber 虚拟用户数量;robotType 虚拟用户昵称类型:0使用真实姓名,1使用网络昵称;adminNotShow 老师与助教是否显示虚拟用户:1不显示,0显示;robotChat 虚拟发言: 1开启,0关闭;adminShowTag 管理页展示标签:1开启,0关闭;zhuboShowTag:主播页展示标签:1开启,0关闭;robotWave:虚拟用户波动范围 0~99999 |
|
|
|
modetype 课程上课的模式: 1 语音云,3 大班(默认),5 小班, 6:大班互动 |
|
|
|
streamMode 小班合流模式配置:1 多人模式,2 双人模式 |
|
|
|
smallType 小班课类型: 1 1V1,2 1V6,3 1V16(默认) |
|
|
|
setDefault 是否将本次课程配置设为该主播的默认配置:1 设为该主播的默认配置,不设置为默认则不传 |
|
|
|
password 主播密码,只有新主播生效。已经存在的主播,密码不会被修改 |
|
|
|
relateType 伪直播关联类型:8 关联剪辑 9 关联课程回放,10 关联视频; relateId 关联的对应课程剪辑ID/课程ID/视频ID,视频ID可以单个,也可以是多个(数组);relateChat 伪直播时,是否发送原课程的聊天:1 是,0 否,relateType为9(关联课程,且关联的课程不为伪直播)时有效 |
|
|
|
scenes。直播类型。1: 教育直播,2: 生活直播。默认 1 |
|
|
|
isSingleMode 是否为单屏模式 0:否 1:是 |
|
|
|
isPublic 是否公开模式 0:否 1:是 |
|
|
|
groupId 课程分类id,分类所属部门要和课程所属部门保持一致 |
|
|
|
pageViewMode 直播模板(scenes=2时可用) 0:二分屏,1:全屏模式,2:课件模式,3:三分屏 |
options示例:{"departmentId":123,"barrage":1}
返回data参数说明:
名称 |
类型 |
描述 |
partner_id |
int |
合作方id |
bid |
int |
欢拓系统的主播id |
course_name |
string |
课程名称 |
start_time |
int |
开始时间戳 |
end_time |
int |
结束时间戳 |
zhubo_key |
string |
主播登录秘钥 |
admin_key |
string |
助教登录秘钥 |
user_key |
string |
学生登录秘钥 |
add_time |
int |
课程创建时间 |
course_id |
int |
课程id |
更新课程信息
api名称:course.update
,SDK对应方法courseUpdate
应用参数说明:
名称 |
类型 |
必选 |
描述 |
course_id |
int |
Y |
课程id |
account |
String |
Y |
接入方主播账号或ID或手机号等 |
course_name |
String |
Y |
课程名称 |
start_time |
int |
Y |
课程开始时间,格式: 2015-01-10 12:00:00 |
end_time |
int |
Y |
课程结束时间,格式: 2015-01-10 13:00:00 |
nickname |
string |
Y |
主播的昵称 |
accountIntro |
string |
N |
主播的简介 |
options |
object |
N |
其它可选参数 |
|
|
|
barrage 是否开启弹幕:0 关闭,1 开启 |
|
|
|
robotNumber 虚拟用户数量;robotType 虚拟用户昵称类型:0使用真实姓名,1使用网络昵称 |
|
|
|
modetype 模式: 1 语音云,3 大班(默认),5 小班, 6:大班互动) |
|
|
|
relateType 伪直播关联类型:8 关联剪辑 9 关联课程回放,10 关联视频; 伪直播开始前6小时内不再允许修改关联关系 |
|
|
|
relateId关联的对应课程剪辑ID/课程ID/视频ID,视频ID可以单个,也可以是多个(数组);伪直播开始前6小时内不再允许修改关联关系 |
|
|
|
relateChat 伪直播时,是否发送原课程的聊天:1 是,0 否,relateType为9(关联课程,且关联的课程不为伪直播)时有效 |
|
|
|
isPublic 是否公开模式 0:否 1:是 |
|
|
|
groupId 课程分类id,分类所属部门要和课程所属部门保持一致 |
options 示例:{"barrage":1}
返回参数说明:code=0为成功,其他值为失败
删除课程信息
api名称:course.delete
,SDK对应方法:courseDelete
名称 |
类型 |
必选 |
描述 |
course_id |
int |
Y |
课程id |
获取课程配置信息
api名称:course.getConfig
,SDK对应方法:courseConfig
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
返回data参数说明:
名称 |
类型 |
描述 |
isPublic |
int |
是否公开课,1:是,0:否 |
modetype |
int |
模式,1:语音云,3:大班,5:小班, 6:大班互动 |
smallType |
int |
在modetype为5的情况下,smallType表示小班类型。1 1V1;2 1V6;3 1V多 |
barrage |
int |
是否开启弹幕,0:关闭,1:开启 |
robot |
array |
robot.number为虚拟用户数量,robot.type为虚拟用户类型(0虚拟用户使用真实姓名,1虚拟用户使用网络昵称),robot.adminNotShow为老师与助教是否显示虚拟用户(1为不显示,0为显示),robot.userTagShow.admin为管理页展示标签(1为显示,0为不显示),robot.userTagShow.zhubo为主播页展示标签(1为显示,0为不显示),robot.wave为虚拟用户波动范围 |
playbackMode |
int |
是否开启课程回放模式,0:关闭,1:开启 |
upLimit |
int |
大班互动连麦人数 |
更新课程配置信息
api名称:course.updateConfig
,SDK对应方法:courseUpdateConfig
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
options |
array |
Y |
配置参数 |
options参数说明:
示例:{"barrage":1}
名称 |
类型 |
必须 |
描述 |
barrage |
int |
N |
弹幕是否开启,0、关闭,1、开启 |
robotEnable |
int |
N |
虚拟用户是否开启,0、关闭,1、开启 |
robotNumber |
int |
N |
虚拟用户数量 |
robotType |
int |
N |
虚拟用户类型,0、虚拟用户使用真实姓名,1、虚拟用户使用网络昵称 |
adminNotShow |
int |
N |
老师与助教不显示虚拟用户,1、不显示,0、显示 |
robotChat |
int |
N |
虚拟用户发言,0、关闭 ,1、开启 |
setDefault |
int |
N |
传入1将此课程配置设为该主播的默认配置,不设置为默认则不传 |
modetype |
int |
N |
课程模式,1、语音云,3、大班(默认),5、小班,,6、大班互动 |
playbackMode |
int |
N |
课程回放, 0、关闭,1、开启,默认开启 |
theftproofEnable |
int |
N |
防盗录是否开启,0关闭,1开启 |
watermarkEnable |
int |
N |
视频水印是否开启,0关闭,1开启 |
watermarkType |
int |
N |
视频水印类型,0图片水印,1文字水印 |
watermarkFile |
file |
N |
视频水印文件(限制为宽200,高75,文件大小为1M) |
watermarkText |
string |
N |
视频水印文字水印,字数限制10 |
watermarkLocation |
int |
N |
视频水印位置,0、左上角,1、右上角,2、左下角,3、右下角 |
upLimit |
int |
N |
连麦人数(适用大班互动) |
adminShowTag |
int |
N |
管理页展示标签,1、显示,0、不显示 |
zhuboShowTag |
int |
N |
主播页展示标签,1、显示,0、不显示 |
robotWave |
int |
N |
虚拟用户波动范围 0~99999 |
返回参数说明:code=0为成功,其他值为失败
虚拟用户导入
api名称:course.robot.set
,SDK对应方法:courseRobotSet
多次设置,后面的会覆盖前面的设置
应用参数说明:
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
userList |
array |
Y |
虚拟用户列表,二维数组,示例:[{"nickname":"xxx","avatar":"http://static-1.talk-fun.com/open/cooperation/default/live-pc/css/img/main/user.png"},{"nickname":"yyy","avatar":"http://static-1.talk-fun.com/open/cooperation/default/live-pc/css/img/main/user.png"}],nickname为用户昵称,avatar为头像,总数不能超过100个 |
total |
int |
N |
虚拟用户总数量,不能超过10000(可以比userList多,但用户列表默认只显示100个用户,userList限制了100个) |
返回参数说明:code=0为成功,其他值为失败
获取课程PPT章节信息
api名称:course.chapter.list
,SDK对应方法:courseChapterList
名称 |
类型 |
必选 |
描述 |
course_id |
int |
Y |
课程ID |
返回data参数说明:
名称 |
类型 |
描述 |
name |
string |
章节名称 |
time |
float |
章节时间(相对直播开始的时间) |
ppt |
string |
ppt图片URL |
page |
int |
PPT页码 |
按照课程ID获取评分自定义项
api名称:course.score.items
,SDK对应方法:courseScoreItems
名称 |
类型 |
必须 |
描述 |
course_id |
string |
Y |
课程ID |
返回data参数说明:
名称 |
类型 |
描述 |
enable |
string |
是否开启评分项 |
config.items |
array |
自定义评分项 |
根据课程ID获取评分详情
api名称:course.score.list
,SDK对应方法:courseScoreList
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
page |
string |
N |
页码,最大值为 10000 |
size |
string |
N |
每页数量,最大值为 1000 |
返回data参数说明:
名称 |
类型 |
描述 |
id |
string |
评分ID |
liveId |
string |
直播ID |
bid |
array |
主播ID |
uid |
array |
评分用户ID |
nickname |
string |
评分用户昵称 |
contentScore |
string |
教学内容评分 |
methodScore |
array |
教学方法评分 |
effectScore |
array |
教学效果评分 |
score |
string |
评分总分 |
time |
string |
时间 |
msg |
string |
留言 |
thirdAccount |
string |
第三方账号 |
itemScore |
array |
自定义评分项 |
itemScore.id |
string |
自定义评分项ID |
itemScore.star |
int |
自定义评分项星星 |
itemScore.score |
string |
自定义评分项分数 |
根据课程ID获取生活直播的邀请榜单列表
api名称:course.inviteRankList
,SDK对应方法:courseInviteRankList
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
page |
string |
N |
页码,最大值为 10000 |
size |
string |
N |
每页数量,最大值为 1000 |
返回data参数说明:
名称 |
类型 |
描述 |
xid |
int |
用户id |
avatar |
string |
用户头像 |
nickname |
string |
用户昵称 |
inviteCount |
int |
邀请人数 |
根据课程ID、邀请人ID获取生活直播的被邀请人列表
api名称:course.inviteRankDetailList
,SDK对应方法:courseInviteRankDetailList
名称 |
类型 |
必选 |
描述 |
course_id |
string |
Y |
课程ID |
xid |
string |
Y |
邀请人用户ID |
page |
string |
N |
页码,最大值为 10000 |
size |
string |
N |
每页数量,最大值为 1000 |
返回data参数说明:
名称 |
类型 |
描述 |
xid |
int |
用户id |
avatar |
string |
用户头像 |
nickname |
string |
用户昵称 |
createTime |
int |
创建时间(10位时间戳) |
设置课程渠道标识
api名称:course.ctagsSet
,SDK对应方法:courseCtagsSet
应用参数说明:
名称 |
类型 |
必须 |
描述 |
course_id |
string |
Y |
课程ID |
options |
object |
N |
其他选项 |
|
|
|
ctags 渠道标识 id=0新增 |
options示例:{"ctags":[{"id":1,"name":"欢拓"}]}
返回参数说明:code=0为成功,其他值为失败
课程转播绑定
api名称:course.rebro.add
,SDK对应方法:courseRebroAdd
应用参数说明:
名称 |
类型 |
必须 |
描述 |
course_id |
string |
Y |
课程ID;同时绑定多个课程,用英文逗号分隔:1,2,3... |
rebroCid |
string |
Y |
被转播的课程id |
返回参数说明:code=0为成功,其他值为失败
课程转播解绑
api名称:course.rebro.delete
,SDK对应方法:courseRebroDelete
应用参数说明:
名称 |
类型 |
必须 |
描述 |
course_id |
string |
Y |
课程ID |
rebroCid |
string |
Y |
被转播的课程id |
返回参数说明:code=0为成功,其他值为失败
课程回放有效期配置
api名称:course.playback.setExpire
,SDK对应方法:coursePlaybackExpireSet
应用参数说明:
名称 |
类型 |
必须 |
描述 |
course_id |
int |
Y |
课程ID |
enable |
int |
Y |
是否关闭回放,0关闭回放 ,1开启回放 |
expire |
int |
Y |
回放有效期,0无限制,不大于30天 |
返回参数说明:code=0为成功,其他值为失败
新增课程分类
api名称:course.group.add
,SDK对应方法:courseGroupAdd
应用参数说明:
名称 |
类型 |
必须 |
描述 |
name |
string |
Y |
分类名称 |
options |
object |
N |
可选参数 |
|
|
|
departmentID,默认无部门 |
返回参数说明:code=0为成功,其他值为失败
编辑课程分类
api名称:course.group.edit
,SDK对应方法:courseGroupEdit
应用参数说明:
名称 |
类型 |
必须 |
描述 |
id |
int |
Y |
分类id |
options |
object |
Y |
可选参数 |
|
|
|
name 分类名称 |
返回参数说明:code=0为成功,其他值为失败
删除课程分类
api名称:course.group.del
,SDK对应方法:courseGroupDel
名称 |
类型 |
必须 |
描述 |
id |
int |
Y |
分类id |
返回参数说明:code=0为成功,其他值为失败
复制课程
api名称:course.copy
,SDK对应方法:courseCopy
应用参数说明:
名称 |
类型 |
必选 |
描述 |
course_name |
string |
Y |
课程名称 |
account |
string |
Y |
接入方主播账号或ID或手机号等,最长32位 |
start_time |
string |
Y |
课程开始时间,格式: 2015-01-10 12:00:00 |
end_time |
string |
Y |
课程结束时间,格式: 2015-01-10 13:00:00 (如果是伪直播,start_time等于end_time时,会自动根据关联信息的时长修改end_time,使伪直播时长等于关联对像的时长) |
nickname |
string |
Y |
主播的昵称 |
accountIntro |
string |
N |
主播的简介 |
sourceCourseId |
int |
Y |
被复制课程ID |
返回data参数说明:
名称 |
类型 |
描述 |
partner_id |
int |
合作方id |
bid |
int |
欢拓系统的主播id |
course_name |
string |
课程名称 |
start_time |
int |
开始时间戳 |
end_time |
int |
结束时间戳 |
zhubo_key |
string |
主播登录秘钥 |
admin_key |
string |
助教登录秘钥 |
user_key |
string |
学生登录秘钥 |
add_time |
int |
课程创建时间 |
course_id |
int |
课程id |
自动脚本设置
api名称:course.script.save
,SDK对应方法:courseScriptSave
应用参数说明:
名称 |
类型 |
必须 |
描述 |
course_id |
int |
Y |
课程id |
options |
object |
Y |
可选项 |
options.enable |
int |
N |
是否开启:0否,1是 |
options.script |
file |
N |
脚本文件 |
返回data参数说明:code=0为成功,其他值为失败
自动脚本删除
api名称:course.script.del
,SDK对应方法:courseScriptDel
应用参数说明:
名称 |
类型 |
描述 |
course_id |
int |
课程id |
返回data参数说明:code=0为成功,其他值为失败