查询直播信息

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 观众登录秘钥
lotteryTotal int 抽奖总数
livePv int 直播观看次数
pbPv int 回放观看次数
liveUv int 直播观看人数
liveUvPeak int 最高并发数
pbUv int 回放观看人数
zhubo object 主播信息
liveStatus int 直播状态:1 未开始;2 正在直播;3 已结束
robotTotal int 机器人数量
playback int 是否生成回放,0为未生成,1为已生成
videoThumb string 回放视频缩略图
playbackUrl string 回放地址
filesize int 回放大小(如果传了getsize)
scenes int 直播类型。1: 教育直播,2: 生活直播
goodsList object 商品列表,scenes为2时返回
watchUrl string 观众地址,scenes为2时返回
loginUrl string 登录地址,scenes为2时返回
thumb string 封面图
liveCartClicks int 直播时购物车点击数
playbackCartClicks int 回放时购物车点击数
fakelive int 是否为伪直播。0:否,1:是
zhubo参数说明:
名称 类型 描述
bid string 欢拓系统的主播id
partner_id string 合作方id
thirdAccount string 发起直播直播的合作方主播唯一账号或ID
nickname string 主播昵称
intro string 主播介绍
p_150 string 主播缩略图150x150
p_40 string 主播缩略图40x40
goodsList参数说明:
名称 类型 描述
name string 商品名称
img string 商品图片地址
price float 商品现价
originalPrice float 商品原价
tab int 商品标签(特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5)
url string 商品链接
putaway int 商品状态 0下架,1上架,2推荐

直播列表(将返回开始时间在区间内的直播)

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 页码,默认为1。最大值为 9999
size int N 每页数量,默认为10。最大值为 999
options object N 可选参数
status 直播状态:0 为正常状态,-1 为已删除
expire 回放地址有效期:设置返回的回放地址的有效时长,单位秒
getsize 是否获取回放大小:0 否,1 是
departmentId 部门id:只获取某部门的直播
account 主播帐号;accountType 主播帐号类型:1 为欢拓主播帐号(欢拓后台的主播ID,或各个接口中返回的bid字段),2 为接入方主播帐号;account与accountType条件需要同时传入。
course_ids 直播列表:字符串格式: '1,2,3';数组格式: [1,2,3]。
scenes 直播类型:1 教育直播,2 生活直播

当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 学生登录秘钥
lotteryTotal int 抽奖总数
livePv int 直播观看次数
pbPv int 回放观看次数
liveUv int 直播观看人数
liveUvPeak int 最高并发数
pbUv int 回放观看人数
liveStatus int 直播状态:1 未开始;2 正在直播;3 已结束
playback int 是否生成回放,0为未生成,1为已生成
videoThumb string 回放视频缩略图
playbackUrl string 回放地址
filesize int 回放大小(如果传了getsize)
scenes int 直播类型。1: 教育直播,2: 生活直播
thumb string 封面图
p_40 string 头像链接 40*40
p_150 string 头像链接 150*150
robotTotal int 虚拟用户数量
liveCartClicks int 直播时购物车点击数
playbackCartClicks int 回放时购物车点击数
fakelive int 是否为伪直播。0:否,1:是

获取生活直播相关配置

api名称:course.getLifeConfig,SDK对应方法:getLifeConfig

  • 应用参数说明:
名称 类型 必须 描述
course_id string Y 直播id
options array N 传对应模块获取相关配置(可以多个)
pageViewMode 界面模式
background 直播间背景图
intro 直播引导图
banner 广告条
focus 关注按钮
number 观看人数开关
invitationList 邀请榜单开关
countDown 直播倒计时开关
store 商城
service 客服私聊开关
reward 打赏主播开关
inviteRanking 邀请观看开关
redPack 发红包开关
like 点赞开关
more 更多入口
menu 菜单入口开关
chatTime 聊天时间开关
entranceTips 入场提示开关
menuList 菜单设置
goodsList 商品列表
share 分享设置
popUp 弹窗列表
ad 浮动广告开关
adlist 浮动广告
goodsPrompt 商品点击提示

返回data参数

名称 类型 描述
pageViewMode string 界面模式 1全屏模式 0二分屏
background array 直播间背景图,background.enable 是否开启,0未开启 1开启;background.url直播间背景图
intro array 直播引导图,intro.url引导图链接
banner array 广告条,banner.enable是否选择开启,0未选择 1选择;banner.data广告条数组;banner.data.type 类型1链接地址 2拨打电话;banner.data.tel 电话;banner.data.link 链接地址;banner.data.imgurl 手机端广告图链接地址;banner.data.pcImgurl pc端广告图链接地址
focus array 关注按钮;focus.enable 是否选择 0否 1是;focus.data.popUp 进入直播间自动弹出公众号二维码 0否 1是;focus.data.url 公众号二维码
number array 观看人数;number.enable 是否开启 观看人数 0否 1是
invitationList array 邀请榜单开关,invitationList.enable 是否开启 0否 1是
countDown array 直播倒计时开关;countDown.enable 是否开启 0否 1是
store array 商城; store.enable是否开启 0未开启 1开启,store.type 1商品列表,2商城链接,3商城二维码;store.data.url 存储商城链接;store.data.qrcode 商城二维码
service array 客服私聊开关 ;service.enable 0否 1是;示例:{"enable":"1"}
reward array 打赏主播开关;reward.enable 是否开启 0否 1是
inviteRanking array 邀请观看开关;inviteRanking.enable 是否开启 0否 1是
redPack array 发红包开关;redPack.enable 是否开启 0否 1是
like array 点赞开关;like.enable 0否 1是
more array 更多入口;more.data.redPackRecord 红包记录开关 0否 1是;more.data.withdraw 提现开关 0否 1是;more.data.store 商城入口开关,more.data.store.enable 是否开启 0否 1是,more.data.store.url 商城入口链接;more.data.info 个人中心开关 0否 1是;more.data.liveLine 切换线路开关 0否 1是;more.data.report 举报开关 0否 1是
menu array 菜单入口开关,menu.enable 是否开启 0否 1是
chatTime array 聊天时间开关;chatTime.enable 是否开启 0否 1是
entranceTips array 入场提示开关;entranceTips.enable 是否开启 0否 1是
menuList array 菜单设置;字段: title, type, content。分别表示: 菜单名称, 菜单类型,自定义图文内容;菜单类型分为 chat聊天 editor自定义图文 invite邀请榜单 courseware课件
goodsList array 商品列表。字段: name, img, price, originalPrice, tab, url, putaway,pay,qrcode。分别表示: 商品名称, 商品图片地址, 商品现价, 商品原价, 商品标签(特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5), 商品链接, 商品状态:0下架,1上架,2推荐, 购买模式(1,链接购买 2,二维码购买), 商品二维码
share array 分享设置;share.title 分享标题设置,share.title.type 标题类型 1默认当场直播名称 2固定标题, share.title.value 固定标题值;share.description.value 描述;share.img.value 图标url
popUp array 弹窗列表;字段uuid,img, title, url, type, duration。分别表示:弹窗唯id, 广告图链接, 主题, 链接地址, 推送类型 1手动推送 2进入直播间时推送, duration:展示时长
ad array 浮动广告开关(只能在全屏模式下使用),ad.enable 0未开启 1开启
adlist array 浮动广告;字段img, position.top, position.left, scale, link 分别表示:广告图,居上(%),居左(%),大小(%);
goodsPrompt array 商品点击提示;goodsPrompt.enable 0未开启 1开启;goodsPrompt.data 商品点击提示数组;goodsPrompt.data.type 类型 1单独展示 2聊天区展示;goodsPrompt.data.goto 点击信息跳转到对应商品页面 0否 1是;goodsPrompt.data.style 展示样式 1样式一 2样式二;goodsPrompt.data.title 通知标题;goodsPrompt.data.button 按钮文案;goodsPrompt.data.status 参与状态;
popUpSwitch array 宣传图入口;popUpSwitch.enable 0未开启 1开启;popUpSwitch.data.image 入口图标链接;popUpSwitch.data.name 入口名称;popUpSwitch.data.title 弹窗标题;popUpSwitch.playback 回放弹窗 0未开启 1开启,回放可自动推送直播时的宣传图弹窗
userPopUp array 观众点击提示,观众点击宣传图后,直播间所有人将显示通知;userPopUp.enable 0未开启 1开启;userPopUp.data.title 通知标题;userPopUp.data.button 按钮文案;userPopUp.data.joined 参与状态
Copyright Talkfun all right reserved,powered by Gitbook修订时间: 2024-08-07 14:55:33

results matching ""

    No results matching ""