查询课程信息
api名称:course.get,SDK对应方法courseGet
应用参数说明:
| 名称 |
类型 |
必选 |
描述 |
| course_id |
int |
Y |
课程id |
| expire |
int |
Y |
返回的回放地址的过期时间,单位秒。默认 86400 秒 |
| options |
object |
N |
附加参数 |
|
|
|
getsize 是否获取回放大小:0 否,1 是 |
返回data参数说明:
| 名称 |
类型 |
描述 |
| course_id |
int |
课程id |
| partner_id |
int |
合作方id |
| course_name |
string |
课程名 |
| bid |
int |
欢拓系统的主播id |
| start_time |
int |
课程开始时间,时间戳,精确到秒,下同 |
| end_time |
int |
课程结束时间 |
| add_time |
int |
课程创建时间 |
| status |
int |
状态: 0 正常,-1 已删除 |
| live_stime |
int |
直播开始时间 |
| live_etime |
int |
直播结束时间 |
| duration |
int |
时长(秒) |
| chatTotal |
int |
聊天总数 |
| zhubo_key |
string |
主播登录秘钥 |
| admin_key |
string |
助教登录秘钥 |
| user_key |
string |
学生登录秘钥 |
| questionTotal |
int |
问题总数 |
| voteTotal |
int |
投票总数 |
| flowerTotal |
int |
鲜花总数 |
| lotteryTotal |
int |
抽奖总数 |
| livePv |
int |
直播观看次数,直播结束后生成该数据 |
| pbPv |
int |
回放观看次数 |
| liveUv |
int |
直播观看人数,直播结束后生成该数据 |
| pbUv |
int |
回放观看人数 |
| zhubo |
string |
主播信息 请求接口:course.zhubo.list |
| liveStatus |
int |
直播状态:1 未开始;2 正在直播;3 已结束 |
| onlineTotal |
int |
直播在线人数,liveStatus=2时可以获取该数据,数据延迟大概十分钟 |
| robotTotal |
int |
机器人数量 |
| playback |
int |
是否生成回放,0为未生成,1为已生成 |
| videoThumb |
string |
回放视频缩略图 |
| playbackUrl |
string |
回放地址 |
| filesize |
int |
回放大小(如果传了getsize) |
| scenes |
int |
直播类型。1: 教育直播,2: 生活直播 |
| goodsList |
string |
商品列表,scenes为2时,请求接口:course.goods.list |
| watchUrl |
string |
观众地址,scenes为2时返回 |
| loginUrl |
string |
学员登陆地址 |
| adminLoginUrl |
string |
助教登陆地址 |
| modetype |
int |
模式,1:语音云,3:大班,5:小班, 6:大班互动 |
| smallType |
int |
在modetype为5的情况下,smallType表示小班类型。1 1V1;2 1V6;3 1V多 |
| fakelive |
int |
是否为伪直播。0:否,1:是 |
| ctags |
string |
请求接口:course.channel.list |
| isSingleMode |
int |
是否为单屏模式。0:否,1:是 |
| groupId |
int |
分类id |
| groupName |
string |
分类名称 |
课程列表(将返回开始时间在区间内的课程)
api名称:course.list,SDK对应方法:courseList
应用参数说明
| 名称 |
类型 |
必选 |
描述 |
| start_time |
string |
N |
开始时间区间,格式: 2015-01-01 12:00:00,传空时返回最新创建的课程 |
| end_time |
string |
N |
开始时间区间,格式: 2015-01-01 12:00:00,配合start_time使用,start_time不为空时必选 |
| page |
int |
N |
页码,最大值为 10000 |
| size |
int |
N |
每页数量,最大值为 1000 |
| options |
object |
N |
可选参数 |
|
|
|
status 课程状态:0 为正常状态,-1 为已删除 |
|
|
|
expire 回放地址有效期:设置返回的回放地址的有效时长,单位秒 |
|
|
|
getsize 是否获取回放大小:0 否,1 是 |
|
|
|
departmentId 部门id:只获取某部门的课程 |
|
|
|
account 主播帐号;accountType 主播帐号类型:1 为欢拓主播帐号(欢拓后台的主播ID,或各个接口中返回的bid字段),2 为接入方主播帐号;account与accountType条件需要同时传入。 |
|
|
|
course_ids 课程列表,最多可传50个课程id:字符串格式: '1,2,3';数组格式: [1,2,3]。 |
|
|
|
scenes 直播类型:1 教育直播,2 生活直播 |
|
|
|
orderBy 排序(object),开始时间排序 start_time:desc 降序 |
|
|
|
groupId 分类id |
当start_time不为空时,查询结果有缓存,要实时获取最新创建的记录,请将start_time留空,传空字符串'',或0
返回data参数说明:
| 名称 |
类型 |
描述 |
| course_id |
int |
课程id |
| partner_id |
int |
合作方id |
| course_name |
string |
课程名 |
| start_time |
int |
课程开始时间 |
| end_time |
int |
课程结束时间 |
| add_time |
int |
课程创建时间 |
| live_stime |
int |
课程直播开始时间 |
| live_etime |
int |
课程直播结束时间 |
| duration |
int |
时长(秒) |
| status |
int |
状态 0正常,-1已删除 |
| bid |
int |
欢拓系统的主播id |
| chatTotal |
int |
聊天总数 |
| zhubo_key |
string |
主播登录秘钥 |
| admin_key |
string |
助教登录秘钥 |
| user_key |
string |
学生登录秘钥 |
| questionTotal |
int |
问题总数 |
| voteTotal |
int |
投票总数 |
| flowerTotal |
int |
鲜花总数 |
| lotteryTotal |
int |
抽奖总数 |
| livePv |
int |
直播观看次数 |
| pbPv |
int |
回放观看次数 |
| liveUv |
int |
直播观看人数 |
| pbUv |
int |
回放观看人数 |
| liveStatus |
int |
直播状态:1 未开始;2 正在直播;3 已结束 |
| playback |
int |
是否生成回放,0为未生成,1为已生成 |
| videoThumb |
string |
回放视频缩略图 |
| playbackUrl |
string |
回放地址 |
| filesize |
int |
回放大小(如果传了getsize) |
| scenes |
int |
直播类型。1: 教育直播,2: 生活直播 |
| modetype |
int |
模式,1:语音云,3:大班,5:小班, 6:大班互动 |
| smallType |
int |
在modetype为5的情况下,smallType表示小班类型。1 1V1;2 1V6;3 1V多 |
| fakelive |
int |
是否为伪直播。0:否,1:是 |
| isSingleMode |
int |
是否为单屏模式。0:否,1:是 |
| groupId |
int |
分类id |
| groupName |
string |
分类名称 |
云点播列表
api名称:course.vodList,SDK对应方法:vodList
应用参数说明
| 名称 |
类型 |
必选 |
描述 |
| page |
int |
N |
页码,最大值为 10000 |
| size |
int |
N |
每页数量,最大值为 1000 |
| options |
object |
N |
可选参数 |
|
|
|
status 课程状态:0 为正常状态,-1 为已删除 |
|
|
|
departmentId 部门id:只获取某部门的课程 |
|
|
|
course_ids 课程列表,最多可传50个课程id:字符串格式: '1,2,3';数组格式: [1,2,3]。 |
返回data参数说明:
| 名称 |
类型 |
描述 |
| course_id |
int |
课程id |
| course_name |
string |
课程名 |
| add_time |
int |
课程创建时间 |
| duration |
int |
时长(秒) |
| status |
int |
状态 0正常,-1已删除 |
| bid |
int |
欢拓系统的主播id |
| user_key |
string |
学生登录秘钥 |
| pbPv |
int |
回放观看次数 |
| pbUv |
int |
回放观看人数 |
| previewUrl |
string |
预览地址 |
| convertInfo.status |
int |
转码状态 0.转码完成 1.等待转码 2.视频转码中 3.转码失败 |
| convertInfo.process |
number |
转码进度 |
| convertInfo.duration |
string |
视频时长 |
| convertInfo.filesize |
number |
视频大小 |
| convertInfo.unit |
string |
视频大小单位 |
分类列表
api名称:course.group.list,SDK对应方法:courseGroupList
应用参数说明:
| 名称 |
类型 |
必须 |
描述 |
| page |
int |
Y |
页码 |
| options |
object |
N |
可选参数 |
|
|
|
departmentID 部门id |
返回data参数说明:
| 名称 |
类型 |
描述 |
| id |
string |
分类id |
| name |
string |
分类名称 |
| departmentID |
string |
部门id |
| createTime |
string |
创建时间 |
| updateTime |
string |
更新时间 |
福袋记录
api名称:course.luckyBag,SDK对应方法:luckyBag
应用参数说明:
| 名称 |
类型 |
必须 |
描述 |
| page |
int |
Y |
分页 |
| options |
obj |
Y |
course_id 课程id |
返回data参数说明:code=0成功,其他为失败;每页返回100条记录
| 名称 |
类型 |
描述 |
| id |
string |
福袋id |
| liveid |
string |
直播记录id |
| course_id |
string |
课程id |
| roomid |
string |
房间id |
| prize |
string |
奖品名称 |
| prizeNum |
string |
奖品个数 |
| participantNum |
string |
参与人数 |
| winnerNum |
string |
中奖人数 |
| publisher |
string |
发起者 |
| publishTime |
string |
发布时间 |
福袋中奖记录
api名称:course.luckyBag.detail,SDK对应方法:luckyBagDetail
应用参数说明:
| 名称 |
类型 |
必须 |
描述 |
| id |
int |
Y |
福袋id |
| page |
int |
Y |
分页 |
返回data参数说明:code=0成功,其他为失败;每页返回100条记录
| 名称 |
类型 |
描述 |
| uid |
string |
用户id |
| nickname |
string |
中奖者 |
| receiveInfo |
string |
领奖信息 |