HTTP接口
创建直播间
通过该接口可以创建直播间,接口请求地址为:
https://api.csslcloud.net/api/room/create
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | |
name | 直播间名称,最大字符40 | 标题头尾的空格字符会自动删除 |
desc | 直播间描述,最大字符5000 | |
templatetype | 直播模板类型,请求模板信息接口可获得模板类型的详细信息。 | |
authtype | 验证方式,0:接口验证,需要填写下面的checkurl;1:密码验证,需要填写下面的playpass;2:免密码验证;3:名称密码验证;4:报名观看验证;5:白名单验证6:免登录验证 | |
publisherpass | 推流端密码,即讲师密码 | |
assistantpass | 助教端密码 | 当开启主持人模式时,主持人密码与助教密码一致。 |
playpass | 播放端密码 | 可选 |
checkurl | 验证地址 | 可选 |
barrage | 是否开启弹幕。0:不开启;1:开启 | 可选,默认为0 |
foreignpublish | 推流方式:0-客户端推流,1-第三方推流,2-回放推流,3-点播推流,4-网页推流(目前仅研讨课使用) | 可选,默认为0;赋值1时,必须开启网页登录的主持人模式,支持模板类型1、2、3、6;liveScene参数为1时,该值必须为4,表示网页推流。 |
openlowdelaymode | 开启直播低延时模式。0:不开启;1:开启 | 可选,默认为0 |
openchatmanage | 开启聊天审核。0:不开启;1:开启 | 可选,默认为0 |
showusercount | 在页面显示当前在线人数。0:不显示;1:显示 | 可选,默认0,不显示当前人数,模板一暂不支持此设置 |
openhostmode | 开启主持人模式,"0"表示不开启;"1"表示开启 | 可选,默认为0,开通主持人模式权限后方可设置 |
hostloginmode | 主持人登录模式,"0"表示网页登录;"1"表示客户端登录 | 可选,默认为0,客户端登录只支持模板类型4、5 |
warmvideoid | 插播暖场视频,填写同一账号下云点播视频vid | 可选,默认关闭;参数值为空,表示关闭 |
livestarttime | 直播开始时间;格式:yyyy-MM-dd HH:mm:ss | 可选,默认为空 |
playerbackgroundhint | 播放器提示语。未直播时播放器将显示该提示语 | 可选,最多15个字符 |
playerbackgroundimageuri | 播放器背景图地址(最大不能超过200个字符),直播未开始时播放器将显示该图片 | 可选 |
manuallyrecordmode | 手动录制模式。0:关闭;1:开启 | 可选,默认关闭 |
clientdocpermissions | 讲师文档权限。0:关闭;1:开启 | 可选,默认关闭; |
repeatedloginsetting | 重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效 | 可选,默认0 |
maxaudiencenum | 直播间并发人数上限 | 可选,默认为0,表示不做限制 |
documentdisplaymode | 文档显示模式。1:适合窗口;2:适合宽度 | 可选,适合窗口 |
openlivecountdown | 倒计时功能。0:关闭;1:开启 | 可选,默认关闭 |
showlectueronlinenum | 讲师端显示在线人数。0:不显示;1:显示 | 可选,默认显示 |
showassistonlinenum | 助教主持人端显示在线人数。0:不显示;1:显示 | 可选,默认显示 |
hideexitbutton | 隐藏观看端退出按钮。0:不开启;1:开启 | 可选,默认为0 |
alarms | 直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符 | 可选,默认为空 |
openTextPicLive | 移动H5页面是否显示图文直播。0:隐藏;1:显示 | 可选,默认为0 (需开通权限) |
inRemindFlag | 进入直播是否提醒:1-是;0-否 | 可选,默认为0 |
inRole | 进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | 可选,默认为1,2,3,4 |
inBeContent | 进入直播提醒内容前段 | 可选,inBeContent和inAfContent加起来字符限制10个 |
inAfContent | 进入直播提醒内容后段 | 可选,inBeContent和inAfContent加起来字符限制10个 |
outRemindFlag | 退出直播是否提醒:1-是;0-否 | 可选,默认为0 |
outRole | 退出直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | 可选,默认为1,2,3,4 |
outBeContent | 退出直播提醒内容前段 | 可选,outBeContent和outAfContent加起来字符限制10个 |
outAfContent | 退出直播提醒内容后段 | 可选,outBeContent和outAfContent加起来字符限制10个 |
privateChat | 私聊开关,1: 开启,0: 关闭 | 可选,默认1: 开启 |
customMaxBitrateFlag | 是否启用直播间自定义推流最大码率配置,1.是; 0.否 | 可选,默认0:否 |
customMaxBitrate | 直播间最大推流码率值 | 可选,码率值(100-5000) ,customMaxBitrateFlag为1时必填 |
globalSkinSwitch | 账户级别模板开关,账户级别默认为常规模板,如果开启新模板需要将此参数设置为关闭 0:关闭 1:开启 | 可选,默认1:开启 |
templateVersion | 引用的页面模板 1:常规模板 2:新模板 | 可选,默认1:常规模板 |
practiceAnswerUserHide | 随堂测答题人数隐藏 0:显示 1:隐藏 | 可选,默认0:显示 |
replayDocShowStatus | 回放文档目录是否显示 0:隐藏 1:显示 | 可选,默认0:隐藏 |
openmarquee | 跑马灯功能。0:关闭;1:开启 | 可选,默认为0 |
marFontSize | 跑马灯字体大小,最小值:12,最大值:50,开启跑马灯生效 | 可选,默认为20 |
marFontColor | 跑马灯字体颜色,内容为十六进制颜色,开启跑马灯生效 | 可选,默认为 #ffffff |
marFontSpeed | 跑马灯速度,可选值:0.5、1.0、1.5、2.0,开启跑马灯生效 | 可选,默认为1.0 |
likeSwitch | 直播间点赞开关,0为关闭(默认),1为开启,其他值将失败 | 可选,默认为0 |
giftGlobalSwitch | 直播间引用全局打赏礼物开关,0为关闭(默认),1为开启,其他值将失败 | 可选,默认为0 |
shareSwitch | 直播与回放分享开关,0为关闭,1为开启(默认),其他值将失败 | 可选,默认为1 |
threePartScreenMode | 三分屏开关,1:开启,0:关闭(默认),其他值将失败。备注: 三分屏模式只有在直播间为文档模式时生效, 开启后,移动端可同时观看视频、文档、聊天等功能 | 可选,默认为0 |
roomIcon | 直播间图标开关,1:开启,0:关闭(默认)。注:直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
roomIconUrl | 直播间图标地址。注: 直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
liveStartTimeSwitch | 直播开始时间展示开关,1:开启,0:关闭(默认) | 可选,默认为0 |
watchFrequencySwitch | 直播是否显示观看次数开关,1:开启,0:关闭(默认) | 可选,默认为0 |
chatSyncUrl | 直播间聊天同步url,长度小于等于250字符,http或https协议,使用前需要开通权限 | 可选,默认为"" |
goodsSwitch | 直播带货开关,1:开启,0:关闭(默认) | 可选,默认为0 |
mobileViewMode | 移动端观看模式 1:横屏 2:竖屏(需要开通竖屏观看权限),只在纯视频模式下支持 | 可选,默认为1 |
liveScene | 直播场景,0:大班课(默认),1:研讨会 | 可选,默认为0 |
seminarMaxStreams | 研讨会嘉宾连麦人数。该值受限于当前账号开通的最大连麦数 | liveScene参数为1时,必选。可选值为2、4、7、10、13、16(解释:2表示1V1,4表示1V3,7表示1V6,以此类推) |
seminarResolution | 研讨会连麦分辨率。该值受限于当前账号开通的最大推流分辨率 | liveScene参数为1时,必选。可选值为240、480、720、1080 |
seminarMainSpeakerAuth | 研讨会会议主持人认证类型,可选0:接口验证,1:单密码验证 | liveScene参数为1时,必选。 |
seminarMainSpeakerAuthUrl | 研讨会会议主持人接口验证地址。 | 可选,seminarMainSpeakerAuth为0时必传。 |
seminarMainSpeakerAuthPass | 研讨会会议主持人验证密码。 | 可选,seminarMainSpeakerAuth为1时必传。 |
seminarSecondSpeakerAuth | 研讨会嘉宾认证类型。可选:0接口验证,1:单密码验证,2免密码 | liveScene参数为1时,必选。 |
seminarSecondSpeakerAuthUrl | 研讨会嘉宾接口验证地址。 | 可选,seminarSecondSpeakerAuth为0时必传。 |
seminarSecondSpeakerAuthPass | 研讨会嘉宾验证密码。 | 可选,seminarSecondSpeakerAuth为1时必传。 |
pcFullScreenMode | PC播放器全屏模式。0:网页全屏;1:系统全屏 | 可选,默认为0 |
banChatInIdle | 非直播中禁言。1:开启,0:关闭(默认) | 可选,默认为0 |
multipleVoice | 多人连麦开关:0-关闭,1-开启 | 可选,默认为0 |
multipleVoiceResolution | 多人连麦分辨率,multipleVoice =1 此值生效,1 - 640*480; 2 - 1280*720 | 可选,默认为1 |
multipleVoiceMaxStream | 最大实际连麦数量,multipleVoice =1 此值生效 1v1 赋值2,1v6赋值7, 默认开启情况下,为7 | 可选,默认为7 |
multipleVoiceMergeType | 多人连麦合流布局,multipleVoice =1此值生效,合流回放视频布局, 取值说明:1为主视频模式,5、宫格模式 默认1,取值范围:[1,5] | 可选,默认为1 |
unlimitedShowPage | 免登录是否展示登录页面,1:开启,0:关闭(默认) | 可选,默认为0 |
chatIconStu | 学员支持聊天发送图片开关,0:关闭 1:开启 | 可选,默认为0 |
chatbotOpen | 打开虚拟聊天开关,0:关闭 1:开启 | 可选,默认为0 |
replayPcDisablePip | 回放禁用PC画中画开关,0:关闭 1:开启 | 可选,默认为0 |
返回数据包含如下字段:
字段名 | 说明 |
result | 请求结果。OK:成功;FAIL:失败 |
room | 直播间信息 |
room包含如下字段:
字段名 | 说明 |
id | 直播间id |
publishUrls | 推流地址,第三方推流的直播间可以获取到此参数 |
JSON格式的返回信息如下:
{
"result": "OK",
"room": {
"id": "76620AD36E2F23719C33DC5901307461",
"publishUrls": [
"rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
]
}
}
编辑直播间
通过该接口可以编辑直播间的信息,接口请求地址为:
https://api.csslcloud.net/api/room/update
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
name | 直播间名称,最大字符40 | 可选,标题头尾的空格字符会自动删除 |
desc | 直播间描述,最大字符5000 | 可选 |
templatetype | 直播模板类型,请求模板信息接口可获得模板类型的详细信息。 | 可选 |
authtype | 验证方式,0:接口验证,需要填写下面的checkurl;1:密码验证,需要填写下面的playpass;2:免密码验证;3:名称密码验证;4:报名观看验证;5:白名单验证6:免登录验证 | 可选 |
publisherpass | 推流端密码,即讲师密码 | 可选 |
assistantpass | 助教端密码 | 可选,当开启主持人模式时,主持人密码与助教密码一致。 |
playpass | 播放端密码 | 可选 |
checkurl | 验证地址 | 可选 |
barrage | 是否开启弹幕。0:不开启;1:开启 | 可选 |
openlowdelaymode | 开启直播低延时模式。0为关闭;1为开启 | 可选 |
openchatmanage | 开启聊天审核。0:不开启;1:开启 | 可选,默认为0 |
showusercount | 在页面显示当前在线人数,0表示不显示;1表示显示 | 可选,模板一暂不支持此设置 |
warmvideoid | 插播暖场视频,填写同一账号下云点播视频vid | 可选,参数值为空,表示关闭 |
livestarttime | 直播开始时间;格式;yyyy-MM-dd HH:mm:ss | 可选 |
playerbackgroundhint | 播放器提示语。未直播时播放器将显示该提示语 | 可选,最多15个字符 |
playerbackgroundimageuri | 播放器背景图地址(最大不能超过200个字符),直播未开始时播放器将显示该图片 | 可选 |
manuallyrecordmode | 手动录制模式。0:关闭;1:开启 | 可选 |
clientdocpermissions | 讲师文档权限。0:关闭;1:开启 | 可选 |
repeatedloginsetting | 重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效 | 可选 |
maxaudiencenum | 直播间并发人数上限 | 可选 |
documentdisplaymode | 文档显示模式。1:适合窗口;2:适合宽度 | 可选 |
openlivecountdown | 开启倒计时功能。0:不开启;1:开启 | 可选 |
showlectueronlinenum | 讲师端显示在线人数。0:不显示;1:显示 | 可选 |
showassistonlinenum | 助教主持人端显示在线人数。0:不显示;1:显示 | 可选 |
hideexitbutton | 隐藏观看端退出按钮。0:不开启;1:开启 | 可选,默认为0 |
alarms | 直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符 | 可选 |
inRemindFlag | 进入直播是否提醒:1-是;0-否 | 可选,默认为0 |
inRole | 进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | 可选,默认为1,2,3,4 |
inBeContent | 进入直播提醒内容前段 | 可选,inBeContent和inAfContent加起来字符限制10个 |
inAfContent | 进入直播提醒内容后段 | 可选,inBeContent和inAfContent加起来字符限制10个 |
outRemindFlag | 退出直播是否提醒:1-是;0-否 | 可选,默认为0 |
outRole | 退出直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | 可选,默认为1,2,3,4 |
outBeContent | 退出直播提醒内容前段 | 可选,outBeContent和outAfContent加起来字符限制10个 |
outAfContent | 退出直播提醒内容后段 | 可选,outBeContent和outAfContent加起来字符限制10个 |
openTextPicLive | 移动H5页面是否显示图文直播。0:隐藏;1:显示 | 可选,默认为0 (需开通权限) |
privateChat | 私聊开关,1: 开启,0: 关闭 | 可选,默认1: 开启 |
customMaxBitrateFlag | 是否启用直播间自定义推流最大码率配置,1.是; 0.否 | 可选,默认0:否 |
customMaxBitrate | 直播间最大推流码率值 | 可选,码率值(100-5000) ,customMaxBitrateFlag为1时必填 |
globalSkinSwitch | 账户级别模板开关,账户级别默认为常规模板,如果开启新模板需要将此参数设置为关闭 0:关闭 1:开启 | 可选,默认1:开启 |
templateVersion | 引用的页面模板 1:常规模板 2:新模板 | 可选,默认1:常规模板 |
practiceAnswerUserHide | 随堂测答题人数隐藏 0:显示 1:隐藏 | 可选,默认0:显示 |
replayDocShowStatus | 回放文档目录是否显示 0:隐藏 1:显示 | 可选,默认0:隐藏 |
openmarquee | 跑马灯功能。0:关闭;1:开启 | 可选,默认为0 |
marFontSize | 跑马灯字体大小,最小值:12,最大值:50,开启跑马灯生效 | 可选,默认为20 |
marFontColor | 跑马灯字体颜色,内容为十六进制颜色,开启跑马灯生效 | 可选,默认为 #ffffff |
marFontSpeed | 跑马灯速度,可选值:0.5、1.0、1.5、2.0,开启跑马灯生效 | 可选,默认为1.0 |
likeSwitch | 直播间点赞开关,0为关闭(默认),1为开启,其他值将失败 | 可选,默认为0 |
giftGlobalSwitch | 直播间引用全局打赏礼物开关,0为关闭(默认),1为开启,其他值将失败 | 可选,默认为0 |
shareSwitch | 直播与回放分享开关,0为关闭,1为开启(默认),其他值将失败 | 可选,默认为1 |
threePartScreenMode | 三分屏开关,1:开启,0:关闭(默认),其他值将失败。备注: 三分屏模式只有在直播间为文档模式时生效, 开启后,移动端可同时观看视频、文档、聊天等功能 | 可选,默认为0 |
roomIcon | 直播间图标开关,1:开启,0:关闭(默认)。注: 直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
roomIconUrl | 直播间图标地址。注: 直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
liveStartTimeSwitch | 直播开始时间展示开关,1:开启,0:关闭(默认) | 可选,默认为0 |
watchFrequencySwitch | 直播是否显示观看次数开关,1:开启,0:关闭(默认) | 可选,默认为0 |
chatSyncUrl | 直播间聊天同步url,长度小于等于250字符,http或https协议,使用前需要开通权限 | 可选,取值为""标识关闭直播间聊天同步 |
goodsSwitch | 直播带货开关,1:开启,0:关闭(默认) | 可选,默认为0 |
mobileViewMode | 移动端观看模式 1:横屏 2:竖屏(需要开通竖屏观看权限),只在纯视频模式下支持 | 可选,默认为1 |
seminarStreams | 研讨会连麦人数 | 可选,该值受限于当前账号开通的最大连麦数。可选值为2、4、7、10、13、16(解释:2表示1V1,4表示1V3,7表示1V6,以此类推) |
seminarResolution | 研讨会分辨率 | 可选,该值受限于当前账号开通的最大推流分辨率。可选值为240、480、720、1080 |
seminarMainSpeakerAuth | 研讨会会议主持人认证类型,可选0:接口验证,1:单密码验证 | 可选 |
seminarMainSpeakerAuthUrl | 研讨会会议主持人接口验证地址。 | 可选,seminarMainSpeakerAuth为0时必传。 |
seminarMainSpeakerAuthPass | 研讨会会议主持人验证密码。 | 可选,seminarMainSpeakerAuth为1时必传。 |
seminarSecondSpeakerAuth | 研讨会嘉宾认证类型。可选:0接口验证,1:单密码验证,2免密码 | 可选 |
seminarSecondSpeakerAuthUrl | 研讨会嘉宾接口验证地址。 | 可选,seminarSecondSpeakerAuth为0时必传。 |
seminarSecondSpeakerAuthPass | 研讨会嘉宾验证密码。 | 可选,seminarSecondSpeakerAuth为1时必传。 |
secondaryVerifySwitch | 次要验证开关,1:开启,0:关闭(默认) | |
secondaryViewerLimitEntryText | 次要验证入口文本, 默认值:进入直播 | |
secondaryViewerLimitTitle | 次要验证弹窗标题, 默认值:欢迎观看本次直播 | |
secondaryViewerLimitItems | 次要验证弹窗内容: "[{\"typeStr\":\"nickName\",\"title\":\"昵称\",\"content\":\"请输入昵称\"},{\"typeStr\":\"pass\",\"title\":\"观众密码\",\"content\":\"请输入观众密码\",\"passwordTypeStr\":\"password\"}]" | |
secondaryVerifySetting | 次要验证观看条件配置: "{\"loginType\":1,\"password\":\"123\"}" | |
pcFullScreenMode | PC播放器全屏模式。0:网页全屏;1:系统全屏 | 可选,默认为0 |
banChatInIdle | 非直播中禁言。1:开启,0:关闭(默认) | 可选,默认为0 |
multipleVoice | 多人连麦开关:0-关闭,1-开启 | 可选,默认为0 |
multipleVoiceResolution | 多人连麦分辨率,multipleVoice =1 此值生效,1 - 640*480; 2 - 1280*720 | 可选,默认为1 |
multipleVoiceMaxStream | 最大实际连麦数量,multipleVoice =1 此值生效 1v1 赋值2,1v6赋值7, 默认开启情况下,为7 | 可选,默认为7 |
multipleVoiceMergeType | 多人连麦合流布局,multipleVoice =1此值生效,合流回放视频布局, 取值说明:1为主视频模式,5、宫格模式 默认1,取值范围:[1,5] | 可选,默认为1 |
chatbotOpen | 打开虚拟聊天开关,1开启,0反之 | 可选,默认为0 |
unlimitedShowPage | 免登录是否展示登录页面,1:开启,0:关闭(默认) | 可选,默认为0 |
chatIconStu | 学员支持聊天发送图片开关,0:关闭 1:开启 | 可选,默认为0 |
replayPcDisablePip | 回放禁用PC画中画开关,0:关闭 1:开启 | 可选,默认为0 |
secondaryViewerLimitItems包含以下字段:
字段名 | 说明 |
typeStr | 弹窗内容类型。 nickName:昵称, pass:密码, statement:声明, text:文本 |
title | 标题 |
content | 内容 |
statementTypeStr | 声名类型。 typeStr为statement时该字段有值。 externalLink:外链, customText:自定义文本 |
mandatoryStatement | 是否强制阅读声明。 typeStr为statement时该字段有值。 true:强制阅读, false:非强制阅读 |
passwordTypeStr | 密码框类型。 typeStr为pass时该字段有值。 password:密码框, text:文本框 |
secondaryVerifySetting包含以下字段:
字段名 | 说明 |
loginType | 登录类型 0:API接口验证, 1:单密码, 2:免密码, 3:名称密码验证(白名单1.0),4:报名观看, 5:白名单验证 |
password | 密码。 loginType为1时 |
checkUrl | 校验URL。 loginType为0时 |
namePasswordVerify | 名称密码验证。 loginType为3时 |
signUpToWatchConfig | 报名观看。 loginType为4时 |
whitelist | 白名单验证。 loginType为5时 |
JSON格式的返回信息如下:
{
"result": "OK"
}
关闭直播间
通过该接口将直播间关闭,接口请求地址为:
https://api.csslcloud.net/api/room/close
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK"
}
备注:如果直播间正在进行直播,将无法关闭,返回错误信息包含:invalid operation
开启直播间
通过该接口将已关闭直播间开启,接口请求地址为:
https://api.csslcloud.net/api/room/open
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK"
}
删除直播间
通过该接口可删除直播间,同时会删除该直播间下全部直播和回放,不可恢复,接口请求地址为:
https://api.csslcloud.net/api/room/delete
需要传递以下参数:
参数 | 说明 |
roomids | 直播间id,支持多个,id之间以英文逗号","分隔,批量删除数量不能超过100个 |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK"
}
获取直播间列表
通过该接口可以获取用户的直播间列表信息
https://api.csslcloud.net/api/room/info
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
startcreatetime | 直播间创建开始时间 | 可选,如果填写该参数则endcreatetime参数必填,格式: yyyy-MM-dd HH:mm:ss (最多查询一天数据) |
endcreatetime | 直播间创建结束时间 | 可选,如果填写该参数则startcreatetime参数必填,格式: yyyy-MM-dd HH:mm:ss (最多查询一天数据) |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
pageindex | 页码 |
count | 直播间总数 |
rooms | 直播间列表信息 |
rooms包含多个直播间信息,直播间包含以下字段:
字段名 | 说明 |
id | 直播间id |
name | 直播间名称 |
desc | 直播间描述 |
status | 直播间状态,10:正常; 20:关闭; 40:已封禁 |
publisherPass | 推流端密码 |
playPass | 播放端密码 |
assistantPass | 助教密码,当开启主持人模式时,主持人密码与助教密码一致。 |
checkUrl | 验证地址 |
templateType | 模板类型 |
authType | 验证类型 |
barrage | 是否开启弹幕,0:不开启;1:开启 |
publishUrls | 推流地址,第三方推流直播间可以获取到此参数 |
openLowDelayMode | 开启低延时模式,"0"表示不开启;"1"表示开启 |
delayTime | 延时时间,单位秒。低延时模式下该值为0. |
showUserCount | 在页面显示用户在线人数,"0"表示不显示;"1"表示显示 |
openHostMode | 开启主持人模式,"0"表示不开启;"1"表示开启 |
hostLoginMode | 主持人登录模式,"0"表示网页登录;"1"表示客户端登录 |
foreignPublish | 推流方式:0-客户端推流,1-第三方推流,2-回放推流,3-点播推流,4-网页推流(目前仅研讨课使用)。可选,默认为0;赋值1时,必须开启网页登录的主持人模式,支持模板类型1、2、3、6;liveScene参数为1时,该值必须为4,表示网页推流。 |
warmVideoId | 插播暖场视频,为空,表示关闭 |
liveStartTime | 直播开始时间 |
playerBackgroundHint | 播放器提示语 |
manuallyRecordMode | 手动录制模式。0:关闭;1:开启 |
clientDocPermissions | 讲师文档权限。0:关闭;1:开启 |
repeatedLoginSetting | 重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效 |
maxAudienceNum | 直播间并发人数上限 |
documentDisplayMode | 文档显示模式。1:适合窗口;2:适合宽度 |
openLiveCountdown | 开启倒计时功能。0:不开启;1:开启 |
showLectuerOnlineNum | 讲师端显示在线人数。0:不显示;1:显示 |
showAssistOnlineNum | 助教主持人端显示在线人数。0:不显示;1:显示 |
openMarquee | 跑马灯功能。0:关闭;1:开启 |
openChatManage | 聊天审核是否开启。0:不开启;1:开启 |
hideExitButtonFlag | 隐藏观看端退出按钮。0:不开启;1:开启 |
alarms | 直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符 |
createTime | 创建时间 ,格式:yyyy-MM-dd HH:mm:ss |
platform | 平台,1.云直播;5.云课堂; |
JSON格式的返回信息如下:
{
"result": "OK",
"pageIndex": 1,
"count": 1,
"rooms": [
{
"id": "76620AD36E2F23719C33DC5901307461",
"name": "直播间名称",
"desc": "直播间描述",
"status": 10,
"publisherPass": "PubToken",
"playPass": "PlayToken",
"assistantPass": "assToken",
"checkUrl": "http://check.xxx.com/api/viewer/check",
"templateType": 1,
"authType": 1,
"barrage": 1,
"publishUrls": [
"rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
],
"openLowDelayMode": "1",
"delayTime": "0",
"showUserCount": "1",
"openHostMode": "0",
"hostLoginMode": "0",
"foreignPublish": 0,
"warmVideoId": "",
"liveStartTime": "2015-01-02 12:30:01",
"playerBackgroundHint": "你好",
"manuallyRecordMode": "0",
"clientDocPermissions": "0",
"openMarquee": "0",
"repeatedLoginSetting": "0",
"maxAudienceNum": "100",
"documentDisplayMode": "1",
"openLiveCountdown": "0",
"alarms": "",
"openChatManage": "0",
"showLectuerOnlineNum": "0",
"showAssistOnlineNum": "0",
"hideExitButtonFlag": "0"
}
]
}
获取直播间信息
通过该接口可以获取直播间的信息,接口请求地址为:
https://api.csslcloud.net/api/room/search
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户id |
返回数据包含如下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
room | 直播间信息 |
room包含以下字段:
字段名 | 说明 | |
id | 直播间id | |
name | 直播间名称 | |
desc | 直播间描述 | |
status | 直播间状态,10:正常; 20:关闭; 40:已封禁 | |
publisherPass | 推流端密码 | |
playPass | 播放端密码 | |
assistantPass | 助教密码,当开启主持人模式时,主持人密码与助教密码一致。 | |
checkUrl | 验证地址 | |
templateType | 模板类型 | |
authType | 验证类型 | |
barrage | 是否开启弹幕,0:不开启;1:开启 | |
publishUrls | 推流地址,第三方推流直播间可以获取到此参数 | |
openLowDelayMode | 开启低延时模式,"0"表示不开启;"1"表示开启 | |
delayTime | 延时时间,单位秒。低延时模式下该值为0. | |
showUserCount | 在页面显示用户在线人数,"0"表示不显示;"1"表示显示 | |
openHostMode | 开启主持人模式,"0"表示不开启;"1"表示开启 | |
hostLoginMode | 主持人登录模式,"0"表示网页登录;"1"表示客户端登录 | |
foreignPublish | 推流方式:0-客户端推流,1-第三方推流,2-回放推流,3-点播推流,4-网页推流(目前仅研讨课使用)。可选,默认为0;赋值1时,必须开启网页登录的主持人模式,支持模板类型1、2、3、6;liveScene参数为1时,该值必须为4,表示网页推流。 | |
warmVideoId | 插播暖场视频,为空,表示关闭 | |
liveStartTime | 直播开始时间 | |
playerBackgroundHint | 播放器提示语 | |
playerBackgroundImageUri | 播放器背景图地址,直播未开始时播放器将显示该图片 | |
manuallyRecordMode | 手动录制模式。0:关闭:开启 | |
clientDocPermissions | 讲师文档权限。0:关闭;1:开启 | |
repeatedLoginSetting | 重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效 | |
maxAudienceNum | 直播间并发人数上限 | |
documentDisplayMode | 文档显示模式。1:适合窗口;2:适合宽度 | |
openLiveCountdown | 开启倒计时功能。0:不开启;1:开启 | |
showLectuerOnlineNum | 讲师端显示在线人数。0:不显示;1:显示 | |
showAssistOnlineNum | 助教主持人端显示在线人数。0:不显示;1:显示 | |
openMarquee | 跑马灯功能。0:关闭;1:开启 | |
marFontSize | 跑马灯字体大小,最小值:12,最大值:50,默认20,开启跑马灯生效 | |
marFontColor | 跑马灯字体颜色,内容为十六进制颜色,默认#ffffff,开启跑马灯生效 | |
marFontSpeed | 跑马灯速度,可选值:0.5、1.0、1.5、2.0,默认1.0,开启跑马灯生效 | |
openChatManage | 聊天审核是否开启。0:不开启;1:开启 | |
hideExitButtonFlag | 隐藏观看端退出按钮。0:不开启;1:开启 | |
alarms | 直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符 | |
openTextPicLive | 移动H5页面是否显示图文直播。0:隐藏;1:显示 | |
inRemindFlag | 进入直播是否提醒:1-是;0-否 | |
inRole | 进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | |
inBeContent | 进入直播提醒内容前段 | |
inAfContent | 进入直播提醒内容后段 | |
outRemindFlag | 退出直播是否提醒:1-是;0-否 | |
outRole | 退出直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割 | |
outBeContent | 退出直播提醒内容前段 | |
outAfContent | 退出直播提醒内容后段 | |
privateChat | 私聊开关,1: 开启,0: 关闭 | |
customMaxBitrateFlag | 是否开启直播间自定义推流最大码率,1.是; 0.否 | |
customMaxBitrate | 直播间自定义最大推流码率值 | |
createTime | 创建时间 ,格式:yyyy-MM-dd HH:mm:ss | |
platform | 平台,1.云直播;5.云课堂; | |
likeSwitch | 直播间点赞开关,0为关闭(默认),1为开启 | |
giftGlobalSwitch | 直播间引用全局打赏礼物开关,0为关闭(默认),1为开启 | |
shareSwitch | 直播与回放分享开关,0为关闭,1为开启(默认) | |
threePartScreenMode | 三分屏开关,1:开启,0:关闭(默认)。备注: 三分屏模式只有在直播间为文档模式时生效, 开启后,移动端可同时观看视频、文档、聊天等功能 | |
roomIcon | 直播间图标开关,1:开启,0:关闭(默认)。注: 直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
roomIconUrl | 直播间图标地址。注: 直播间图标开关打开才可以保存直播间图标地址 | 可选,默认为0 |
liveStartTimeSwitch | 直播开始时间展示开关,1:开启,0:关闭(默认) | 可选,默认为0 |
watchFrequencySwitch | 直播是否显示观看次数开关,1:开启,0:关闭(默认) | 可选,默认为0 |
goodsSwitch | 直播带货开关,1:开启,0:关闭(默认) | |
mobileViewMode | 移动端观看模式 1:横屏 2:竖屏,只在纯视频模式下支持 | |
secondaryVerifySwitch | 次要验证开关,1:开启,0:关闭(默认) | |
secondaryViewerLimitEntryText | 次要验证入口文本 默认值:进入直播 | |
secondaryViewerLimitTitle | 次要验证弹窗标题 默认值:欢迎观看本次直播 | |
secondaryViewerLimitItems | 次要验证弹窗内容 | |
secondaryVerifySetting | 次要验证观看条件配置 | |
seminarSettings | 研讨会配置 | |
pcFullScreenMode | PC播放器全屏模式。0:网页全屏;1:系统全屏 | |
banChatInIdle | 非直播中禁言。1:开启,0:关闭(默认) | |
multipleVoice | 多人连麦开关:0-关闭,1-开启 | |
multipleVoiceResolution | 多人连麦分辨率,multipleVoice =1 此值生效,1 - 640*480; 2 - 1280*720 | |
multipleVoiceMaxStream | 最大实际连麦数量,multipleVoice =1 此值生效 1v1 赋值2,1v6赋值7, 默认开启情况下,为7 | |
multipleVoiceMergeType | 多人连麦合流布局,multipleVoice =1此值生效,合流回放视频布局, 取值说明:1为主视频模式,5、宫格模式 默认1,取值范围:[1,5] | |
chatbotOpen | 打开虚拟聊天开关,1开启,0反之 | |
unlimitedShowPage | 免登录是否展示登录页面,1:开启,0:关闭(默认) | |
chatIconStu | 学员支持聊天发送图片开关,0:关闭(默认) 1:开启 | |
lecturerClientCode | 讲师客户端开播码 | |
hostClientCode | 主持人客户端开播码 | |
replayPcDisablePip | 回放禁用PC画中画开关,0:关闭 1:开启 |
seminarSettings包含以下字段:
字段名 | 说明 |
seminarStreams | 研讨会连麦人数 |
seminarResolution | 研讨会分辨率 |
seminarMainSpeakerAuth | 研讨会会议主持人认证类型,可选0:接口验证,1:单密码验证 |
seminarMainSpeakerAuthUrl | 研讨会会议主持人接口验证地址。seminarMainSpeakerAuth为0时必须。 |
seminarMainSpeakerAuthPass | 研讨会会议主持人验证密码。seminarMainSpeakerAuth为1时必须。 |
seminarSecondSpeakerAuth | 研讨会嘉宾认证类型。可选:0接口验证,1:单密码验证,2免密码 |
seminarSecondSpeakerAuthUrl | 研讨会嘉宾接口验证地址。seminarSecondSpeakerAuth为0时必须。 |
seminarSecondSpeakerAuthPass | 研讨会嘉宾验证密码。seminarSecondSpeakerAuth为1时必须。 |
secondaryViewerLimitItems包含以下字段:
字段名 | 说明 |
typeStr | 弹窗内容类型。 nickName:昵称, pass:密码, statement:声明, text:文本 |
title | 标题 |
content | 内容 |
statementTypeStr | 声名类型。 typeStr为statement时该字段有值。 externalLink:外链, customText:自定义文本 |
mandatoryStatement | 是否强制阅读声明。 typeStr为statement时该字段有值。 true:强制阅读, false:非强制阅读 |
passwordTypeStr | 密码框类型。 typeStr为pass时该字段有值。 password:密码框, text:文本框 |
secondaryVerifySetting包含以下字段:
字段名 | 说明 |
loginType | 登录类型。 0:API接口验证, 1:单密码, 2:免密码, 3:名称密码验证(白名单1.0),4:报名观看, 5:白名单验证 |
password | 密码。 loginType为1时 |
checkUrl | 校验URL。 loginType为0时 |
namePasswordVerify | 名称密码验证。 loginType为3时 |
signUpToWatchConfig | 报名观看。 loginType为4时 |
whitelist | 白名单验证。 loginType为5时 |
JSON格式的返回信息如下:
{
"result":"OK",
"room":{
"id":"76620AD36E2F23719C33DC5901307461",
"name":"直播间名称",
"desc":"直播间描述",
"status":10,
"publisherPass":"PubToken",
"playPass":"PlayToken",
"assistantPass":"assToken",
"checkUrl":"http://check.xxx.com/api/viewer/check",
"templateType":1,
"authType":1,
"barrage":1,
"publishUrls":[
"rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
"rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
],
"openLowDelayMode":"1",
"delayTime":"0",
"showUserCount":"1",
"openHostMode":"0",
"hostLoginMode":"0",
"foreignPublish":0,
"warmVideoId":"",
"liveStartTime":"2015-01-02 12:30:01",
"playerBackgroundHint":"你好",
"manuallyRecordMode":"0",
"clientDocPermissions":"0",
"openMarquee":"0",
"marFontSize":20,
"marFontSpeed":"1.0",
"marFontColor":"#ffffff",
"repeatedLoginSetting":"0",
"maxAudienceNum":"100",
"openTextPicLive":"0",
"documentDisplayMode":"1",
"openLiveCountdown":"0",
"alarms":"",
"openChatManage":"0",
"showLectuerOnlineNum":"0",
"showAssistOnlineNum":"0",
"hideExitButtonFlag":"0",
"inRemindFlag":"1",
"inBeContent":"欢迎",
"inAfContent":"进入直播间",
"inRole":[
1,
4,
2,
3
],
"outRemindFlag":"1",
"outBeContent":"",
"outAfContent":"离开直播间",
"outRole":[
1,
4,
2,
3
],
"secondaryVerifySwitch":"1",
"secondaryViewerLimitTitle":"欢迎观看本次直播",
"secondaryViewerLimitEntryText":"进入直播",
"secondaryViewerLimitItems":"[{\"typeStr\":\"nickName\",\"title\":\"昵称\",\"content\":\"请输入昵称\"},{\"typeStr\":\"pass\",\"title\":\"观众密码\",\"content\":\"请输入观众密码\",\"passwordTypeStr\":\"password\"}]",
"secondaryVerifySetting":"{\"accountId\":\"AF58B89EF2C17DA4\",\"roomId\":\"01352D302200B1A79C33DC5901307461\",\"loginType\":1,\"password\":\"123\"}",
"unlimitedShowPage": "0"
}
}
获取直播列表
通过该接口获取指定直播间下历史直播信息,接口请求地址为:
https://api.csslcloud.net/api/v2/live/info
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | 可选, 不存在该参数时,查询当前账户下的直播 |
userid | CC账户ID | 必选 |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
starttime | 查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数,该查询是按直播的开始时间作为查询条件的。 | 可选,如果填写该参数则endtime参数必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00" |
endtime | 查询截止时间 | 可选 ,如果填写该参数则starttime必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-02 12:30:00" |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 直播总数 |
pageIndex | 页码 |
lives | 直播列表信息 |
lives包含以下字段:
字段名 | 说明 |
id | 直播id |
roomId | 直播间id |
startTime | 开始直播时间 |
endTime | 结束直播时间 |
templateType | 模板类型 |
sourceType | 直播来源类型,0:正常直播;1:合并回放生成; 2:迁移回放生成; 3:上传回放生成 |
JSON格式的返回信息如下:
{
"result": "OK",
"count": "100",
"pageIndex": "1",
"lives": [
{
"id": "753C612EB38A8D5A",
"startTime": "2015-01-01 00:00:00",
"endTime": "2015-01-01 23:00:00",
"recordVideoStatus": 0,
"templateType": 5,
"sourceType": 0
},
...
]
}
删除直播
通过该接口可以删除直播,同时会删除该直播下的全部回放,删除后不可恢复,接口请求地址为:
https://api.csslcloud.net/api/live/delete
需要传递以下参数:
参数 | 说明 |
liveids | 直播id,支持多个,id之间以英文逗号","分隔,批量删除数量不能超过100个 |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK"
}
查询回放列表
通过该接口可以分页获取回放列表的信息,接口请求地址为:
https://api.csslcloud.net/api/v2/record/info
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
starttime | 查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数,该查询是按直播的开始时间作为查询条件的。 | 可选,如果填写该参数则endtime参数必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00" |
endtime | 查询截止时间 | 可选 ,如果填写该参数则starttime必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-02 12:30:00" |
liveid | 直播id | 可选,将只查询该直播下的回放信息 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 回放总数 |
pageIndex | 页码 |
records | 回放列表信息 |
records包含以下字段:
字段名 | 说明 |
id | 回放id |
liveId | 直播id |
startTime | 开始录制时间 |
stopTime | 结束录制时间 |
recordStatus | 录制状态,0表示录制未结束,1表示录制完成(回放生成,不包括离线CCR) |
recordVideoId | 录制视频id,如果recordStatus为0则返回-1 |
replayUrl | 回放地址,当recordStatus为0时返回"" |
offlinePackageUrl | 离线包http下载地址,注:只有开通离线播放权限才会返回该参数 |
httpsOfflinePackageUrl | 离线包https下载地址,注:只有开通离线播放权限才会返回该参数 |
offlinePackageMd5 | 离线包md5,注:只有开通离线播放权限才会返回该参数 |
offlinePackageSize | 离线包文件大小,单位Byte,注:只有开通离线播放权限才会返回该参数 |
templateType | 模板类型 |
sourceType | 回放来源,0:录制; 1:合并; 2:迁移; 3:上传 |
title | 回放标题 |
desc | 回放描述 |
JSON格式的返回信息如下:
{
"result": "OK",
"count": "100",
"pageIndex": "1",
"records": [
{
"id": "753C612EB38A8D5A",
"liveId": "853C612EB38A8D5A",
"startTime": "2015-01-01 00:00:00",
"stopTime": "2015-01-01 23:00:00",
"recordStatus": 1,
"recordVideoId": "953C612EB38A8D5A",
"replayUrl": "https://xxx",
"offlinePackageUrl": "http://yyy",
"httpsOfflinePackageUrl": "https://yyy",
"offlinePackageMd5": "xxxxxdddddddddddddddddddddddddddd",
"offlinePackageSize": 2350422,
"templateType": 5,
"sourceType": 1,
"title": "回放标题",
"desc": "回放描述"
},
...
]
}
查询回放信息
通过该接口获取单个回放信息,接口请求地址为:
https://api.csslcloud.net/api/v2/record/search
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | |
recordid | 回放id |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
record | 回放信息 |
record包含以下字段:
字段名 | 说明 |
id | 回放Id |
liveId | 直播Id |
startTime | 开始录制时间, 格式为"yyyy-MM-dd HH:mm:ss" |
stopTime | 结束录制时间, 格式为"yyyy-MM-dd HH:mm:ss", 如果录制未结束,该值则为"" |
recordStatus | 录制状态,0表示录制未结束,1表示录制完成 |
replayUrl | 回放地址,当recordStatus为0时返回"" |
recordVideoId | 录制视频id,如果recordStatus为0则返回-1 |
offlinePackageUrl | 离线包http下载地址,注:只有开通离线播放权限才会返回该参数 |
httpsOfflinePackageUrl | 离线包https下载地址,注:只有开通离线播放权限才会返回该参数 |
offlinePackageMd5 | 离线包md5,注:只有开通离线播放权限才会返回该参数 |
offlinePackageSize | 离线包文件大小,单位Byte,注:只有开通离线播放权限才会返回该参数 |
downloadUrl | 回放视频http下载地址,该下载地址具有时效性,有效时间为2小时 |
httpsDownloadUrl | 回放视频https下载地址,该下载地址具有时效性,有效时间为2小时 |
templateType | 模板类型 |
sourceType | 回放来源,0:录制; 1:合并; 2:迁移; 3:上传 |
title | 回放标题 |
desc | 回放描述 |
JSON格式的返回信息如下:
{
"result": "OK",
"record": {
"id": "753C612EB38A8D5A",
"liveId": "853C612EB38A8D5A",
"startTime": "2015-01-01 00:00:00",
"stopTime": "2015-01-01 23:00:00",
"recordStatus": 1,
"recordVideoId": "953C612EB38A8D5A",
"replayUrl": "https://xxx",
"offlinePackageUrl": "http://yyy",
"httpsOfflinePackageUrl": "https://yyy",
"offlinePackageMd5": "xxxxxdddddddddddddddddddddddddddd",
"offlinePackageSize": 2350422,
"downloadUrl": "http://zzz",
"httpsDownloadUrl": "https://zzz",
"templateType": 5,
"sourceType": 1,
"title": "回放标题",
"desc": "回放描述"
}
}
合并回放
通过该接口可以对同一直播间下相同模板类型的回放进行合并,接口请求地址为:
https://api.csslcloud.net/api/live/merge
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
roomid | 直播间id | 必须 |
recordids | 回放ID集合 | 必须,中间以英文逗号间隔,最多支持3个回放合并 |
返回数据:
{
"result": "OK",
"recordid": "1898E3CD7F97BEED", // 合并生成新的回放ID
"liveid": "327123EAC6A40A10"// 合并生成新的直播ID
}
编辑回放
通过该接口编辑回放信息,接口请求地址为:
https://api.csslcloud.net/api/record/edit
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必填 |
recordid | 回放id | 必填 |
title | 回放标题,最大字符40 | 必填,标题头尾的空格字符会自动删除 |
desc | 回放描述,最大字符5000 | 可选 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
JSON格式的返回信息如下:
{
"result": "OK"
}
删除回放
通过该接口删除一个或多个回放信息,删除后不可恢复,接口请求地址为:
https://api.csslcloud.net/api/record/delete
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | |
recordids | 回放id | 支持多个回放id,id之间以英文逗号","分隔,批量删除数量不能超过100个 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
JSON格式的返回信息如下:
{
"result": "OK"
}
获取正在直播的直播间列表
该接口可获取用户账号下所有正在进行直播的直播间列表,接口请求地址为:
https://api.csslcloud.net/api/rooms/broadcasting
需要传递以下参数:
参数 | 说明 |
userid | CC账户ID |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
rooms | 房间列表 |
房间列表含有以下字段:
字段名 | 说明 |
roomId | 房间ID |
liveId | 正在直播的直播ID |
startTime | 直播开始时间,格式为"yyyy-MM-dd HH:mm:ss" |
JSON格式的返回信息如下:
{
"result": "OK",
"rooms": [
{
"roomId": "76620AD36E2F23719C33DC5901307461",
"liveId": "63835A29B2A11961",
"startTime": "2016-11-28 20:00:00"
},
...
]
}
获取直播间直播状态
通过该接口获取直播间的直播状态,接口请求地址为:
https://api.csslcloud.net/api/rooms/publishing
需要传递以下参数:
参数 | 说明 |
roomids | 直播间id(以英文逗号,区分),批量查询直播间数量不能超过100个 |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK",
"rooms": [
{
"liveStatus": 0,
"roomId": "E568A3195950ED7C9C33DC5901307461"
},
{
"startTime": "2016-11-28 20:00:00",
"liveStatus": 1,
"liveId": "3F35109F9F77F2A8",
"roomId": "76620AD36E2F23719C33DC5901307461"
}
]
}
返回信息:
参数 | 说明 |
result | "OK":请求成功,否则请求失败 |
rooms | 返回查询直播间信息 |
liveStatus | 0:直播未开始,1:正在直播 |
startTime | 直播开始时间,若直播未开始,不返回该参数 |
liveId | 直播ID,若直播未开始,不返回该参数 |
roomId | 直播间ID |
获取直播间连接数
通过该接口可以获取直播间的连接数统计信息,请求次数上限为2次/分钟,接口请求地址为:
https://api.csslcloud.net/api/statis/connections
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
starttime | 开始时间,精确到秒,例:"2015-01-02 12:30:00" |
endtime | 结束时间,精确到秒,例:"2015-01-02 13:30:00",endtime和starttime相差不能超过7天 |
返回字段包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
roomId | 直播间id |
connections | 连接统计信息 |
connections包含以下字段:
字段名 | 说明 |
time | 统计时间点 |
count | 连接总数 |
replayCount | 回放连接总数 |
JSON格式的返回信息如下:
{
"result": "OK",
"roomId": "76620AD36E2F23719C33DC5901307461",
"connections": [
{
"time": "2016-11-28 20:00:30",
"count": 9527,
"replayCount": 7259
},
...
]
}
获取直播间模板信息
通过该接口可以获取直播间各模板信息,接口请求地址为:
https://api.csslcloud.net/api/viewtemplate/info
需要传递以下参数:
参数 | 说明 |
userid | CC账户ID |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
templates | 模板信息 |
viewTemplates包含多个模板信息,模板信息包含一些字段:
字段名 | 说明 |
type | 模板类型 |
name | 模板名称 |
desc | 模板描述 |
iconPath | 模板图标路径 |
pdfView | 是否开启pdf视图,0:不开启;1:开启 |
chatView | 是否开启聊天视图,0:不开启;1:开启 |
qaView | 是否开启问答视图,0:不开启;1:开启 |
JSON格式的返回信息如下:
{
"result": "OK",
"templates": [
{
"type": 2,
"name": "模板二",
"desc": "视频,聊天,问答",
"iconPath": "ltab4",
"chatView": 1,
"pdfView": 0,
"qaView": 1
},
...
]
}
获取直播间代码
通过该接口可以获取直播间的代码信息,包括观看地址信息、客户端登陆地址、助教端登录地址、推流地址(只有第三方推流直播间才可以获取到)、图文直播发布页地址(只有开启图文直播权限才可以获取到)。接口请求地址为:
https://api.csslcloud.net/api/room/code
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
roomId | 直播间id |
clientLoginUrl | 客户端登录地址 |
assistantLoginUrl | 助教端登录地址 |
viewUrl | 观看地址 |
publishUrls | 推流地址,第三方推流直播间可以获取到此参数 |
hostLoginUrl | 如果直播间为主持人模式,则返回主持人登录地址 |
promulgatorUrl | 如果账号开通了图文直播权限,则返回图文直播发布地址 |
JSON格式的返回信息如下:
{
"result": "OK",
"roomId": "76620AD36E2F23719C33DC5901307461",
"clientLoginUrl": "https://view.csslcloud.net/api/view/lecturer?roomid=76620AD36E2F23719C33DC5901307461&userid=753C612EB38A8D5A",
"assistantLoginUrl": "https://view.csslcloud.net/api/view/assistant?roomid=xxxx&userid=xxxx",
"viewUrl": "https://view.csslcloud.net/api/view/index?roomid=xxxx&userid=xxxx",
"publishUrls": [
"rtmp://xxxx.xxxx.net/live/xxxx",
"rtmp://xxxx.xxxx..net/live/xxxx",
"rtmp://xxxx.xxxx..net/live/xxxx"
],
"hostLoginUrl": "https://view.csslcloud.net/api/view/manage?roomid=xxxx&userid=xxxx",
"promulgatorUrl": "https://xxx.xxx.net/api/view/promulgator?roomId=xxxx&accountId=xxxx"
}
获取直播间内用户进出信息
通过该接口可以获取直播间内用户进入,离开行为的统计,接口请求地址为:
https://api.csslcloud.net/api/statis/room/useraction
需要传入以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
starttime | 查询起始时间,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00" |
endtime | 查询截止时间,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过1天 |
action | 按进入或离开查询,0表示进入直播间,1表示离开直播间 |
pageindex | 可选,查询页码,默认为1 |
pagenum | 可选,单页所查询的数据条数,默认为50,最大阈值为1000 |
返回数据包括以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
action | 0表示进入直播间,1表示离开直播间 |
userActions | 用户进入、离开行为记录 |
userActions包括用户的行为信息,包括以下字段:
字段名 | 说明 |
userId | 用户Id,此Id为进入、离开行为的用户Id |
userName | 用户登录名称 |
userIp | 用户IP地址 |
time | 用户进入或离开时间 |
JSON格式的返回信息如下:
{
"result": "OK",
"userActions": [
{
"userId": "780",
"userName": "张三",
"userIp": "111.206.170.241",
"time": "2019-01-17 17:18:21.0"
},
...
],
"action": 0,
"pageIndex": 1,
"count": 5
}
获取观看直播的访问记录
通过该接口可以获取观看直播的访问记录,接口请求地址为:
https://api.csslcloud.net/api/statis/live/useraction
注意:该接口仅支持查询2018年12月1日以后的直播
参数 | 说明 | 备注 |
userid | CC账户ID | |
liveid | 直播id | |
pagenum | 每页显示的个数 | 可选,默认值为50,最大阈值为1000 |
pageindex | 页码 | 可选,默认值为1 |
返回值说明:
参数名称 | 参数类型 | 参数说明 |
result | 字符串 | 请求是否成功。OK:成功;FAIL:失败 |
count | 数字 | 总访问次数 |
pageIndex | 数字 | 当前页码 |
viewerId | 字符串 | 用户ID |
viewerName | 字符串 | 用户昵称 |
viewerIp | 字符串 | 用户IP |
city | 字符串 | 用户地域 |
enterTime | 字符串 | 进入时间 |
leaveTime | 字符串 | 离开时间 |
watchTime | 数字 | 直播观看时长,单位:秒 |
terminal | 数字 | 终端类型,0表示PC端,1表示移动端 |
customInfo | 字符串 | json格式字符串,自定义用户信息 |
userRole | 数字 | 用户角色,1:主讲、推流端角色, 2:助教端角色,3:主持人角色,4:学生、观看端角色 |
JSON格式的返回信息如下:
{
"result": "OK",
"userEnterLeaveActions": [
{
"viewerId": "d7ba862174754b1cb88138b8c3d94018",
"viewerName": "21",
"viewerIp": "111.26.170.241",
"city": "中国\t北京\t北京\t",
"enterTime": "2019-02-12 14:01:07",
"leaveTime": "2019-02-12 14:01:51",
"watchTime": 26,
"terminal": 0,
"customInfo": "",
"userRole": 1
},
{
"viewerId": "a9a589134a2e4037938d85a63cfb28bb",
"viewerName": "二叉",
"viewerIp": "111.26.170.241",
"city": "中国\t北京\t北京\t",
"enterTime": "2019-02-12 14:01:15",
"leaveTime": "2019-02-12 14:01:51",
"watchTime": 26,
"terminal": 0,
"customInfo": "",
"userRole": 4
}
],
"pageIndex": 1,
"count": 2
}
获取直播互动的统计信息
通过该接口可以获取直播互动的统计信息,接口请求地址为:
https://api.csslcloud.net/api/statis/interactive
参数 | 说明 | 备注 |
userid | CC账户ID | |
liveid | 直播id | |
pagenum | 每页显示的个数 | 可选,默认值为50,最大阈值为1000 |
pageindex | 页码 | 可选,默认值为1 |
返回值说明:
参数名称 | 参数类型 | 参数说明 |
result | 字符串 | 请求是否成功。OK:成功;FAIL:失败 |
count | 数字 | 总人数 |
pageIndex | 数字 | 当前页码 |
viewerId | 字符串 | 用户ID |
viewerName | 字符串 | 用户昵称 |
watchTime | 数字 | 直播观看时长(秒) |
enterLeaveCount | 数字 | 进出次数 |
chatCount | 数字 | 聊天次数 |
questionCount | 数字 | 提问次数 |
rollcallCount | 数字 | 签到次数 |
questionnaireCount | 数字 | 答卷次数 |
classroomExaminationCount | 数字 | 随堂测次数,2020-09-23以后的直播可以获取此参数 |
punchCount | 数字 | 打卡次数,2022-08-18以后的直播可以获取此参数 |
watchTimeStr | 字符串 | 观看时长,2022-08-18以后的直播可以获取此参数 |
JSON格式的返回信息如下:
{
"result": "OK",
"count": 2,
"pageIndex": 1,
"liveViewerStatisConclusions": [
{
"viewerId": "27e7ce350aed4011873b384bbc1296d3",
"viewerName": "12",
"watchTime": 223,
"enterLeaveCount": 1,
"chatCount": 0,
"questionCount": 0,
"rollcallCount": 0,
"questionnaireCount": 0,
"classroomExaminationCount": 0,
"punchCount": 0,
"watchTimeStr": "0时01分37秒"
},
{
"viewerId": "300227588049",
"viewerName": "web空 ",
"watchTime": 223,
"enterLeaveCount": 1,
"chatCount": 0,
"questionCount": 0,
"rollcallCount": 0,
"questionnaireCount": 0,
"classroomExaminationCount": 0,
"punchCount": 0,
"watchTimeStr": "0时01分37秒"
}
]
}
获取观看直播的统计信息
通过该接口可获取观看直播的统计信息,请求次数上限为200次/分钟,统计延迟30分钟,请在直播结束30分钟以后查询。 接口请求地址为:
https://api.csslcloud.net/api/statis/userview
注意:该接口仅支持查询2019年1月1日以后的直播
需要传递以下参数:
参数 | 说明 |
liveid | 直播id |
userid | CC账户ID |
JSON格式的返回信息如下:
{
"result": "OK",
"status": 1,
"liveId": "xxxxxxxx",
"maxConcurrent": 100,
"maxConcurrentTime": "2021-06-18 15:58:14",
"totalCount": 1000,
"uaCount": {
"pc": 100,
"mobile": 900
},
"customUaCount": {
"customua1": 100,
"customua2": 200
...
}
}
返回值说明:
参数名称 | 参数类型 | 参数说明 |
result | 字符串 | 请求是否成功。OK:成功;FAIL:失败 |
liveId | 字符串 | 查询直播ID |
status | 数字 | 0:统计未完成,1:统计完成 |
maxConcurrent | 数字 | 直播最大并发人数 |
maxConcurrentTime | 字符串 | 直播最大并发时间 |
totalCount | 数字 | 总观看数 |
uaCount | 对象 | 默认ua统计信息 |
pc | 数字 | 默认ua统计PC观看总数 |
mobile | 数字 | 默认ua统计Mobile观看总数 |
customUaCount | 对象 | 用户自定义uatype统计观看数 |
获取单个直播回放的观看统计信息
通过该接口可以获取单个回放观看用户登录,退出行为统计(仅支持获取最近一年内的数据)。接口请求地址为:
https://api.csslcloud.net/api/statis/record/useraction
需要传入以下参数:
参数 | 说明 |
recordid | 录制id |
userid | CC账户ID |
starttime | 查询起始时间,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00" |
endtime | 查询截止时间,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过7天 |
action | 按登录或退出行为类型查询,0表示登录,1表示退出 |
pageindex | 可选,查询页码,默认为1 |
pagenum | 可选,单页所查询的数据条数,默认为50,最大阈值为1000 |
返回数据包括以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 数据总条数 |
pageIndex | 当前页码 |
action | 0表示登录,1表示退出 |
userActions | 用户登录、退出行为记录 |
userActions包括用户的行为信息,包括以下字段:
字段名 | 说明 |
userId | 用户Id,此Id为登录、退出行为的用户Id |
userName | 用户登录名称 |
userIp | 用户IP地址 |
time | 用户进入或离开时间 |
UAType | 观看渠道; 0:PC; 1:移动; |
socketId | 登陆socketId; |
JSON格式的返回信息如下:
{
"result": "OK",
"userActions": [
{
"userId": "8662c8b4de7c4d758146186402e9b00b",
"userName": "cccc",
"userIp": "111.206.170.241",
"time": "2019-01-03 14:11:23.0",
"UAType": 0,
"socketId": "cPFmY6NM-30Xgp0cA9VI"
},
{
"userId": "8662c8b4de7c4d758146186402e9b00b",
"userName": "aaaa",
"userIp": "111.206.170.241",
"time": "2019-01-03 14:12:42.0",
"UAType": 0,
"socketId": "nqKZutf8ITiq32gpAoN2"
},
{
"userId": "2ab26606d60241afb1d0c09652840686",
"userName": "abc",
"userIp": "111.206.170.241",
"time": "2019-01-04 09:36:13.0",
"UAType": 0,
"socketId": "0AU3i2SITqJ31zA3AZ4N"
}
],
"action": 0,
"pageIndex": 1,
"count": 3
}
获取所有直播回放的观看统计信息
通过该接口可以获取观看直播回放的用户登录,退出行为统计(仅支持获取最近一年内的数据)。接口请求地址为:
https://api.csslcloud.net/api/statis/user/record/useraction
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
starttime | 查询起始时间 | 必须,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00" |
endtime | 查询截止时间 | 必须,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过1天 |
action | 按登录或退出行为类型查询,0表示登录,1表示退出 | |
pageindex | 查询页码 | 可选,默认为1 |
pagenum | 单页所查询的数据条数 | 可选,默认为50,最大阈值为1000 |
返回数据包括以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 数据总条数 |
pageIndex | 当前页码 |
action | 0表示登录,1表示退出 |
userActions | 用户登录、退出行为记录 |
userActions包括用户的行为信息,包括以下字段:
字段名 | 说明 |
recordId | 回放Id |
roomId | 直播间Id |
userId | 用户Id,此Id为登录、退出行为的用户Id |
userName | 用户登录名称 |
userIp | 用户IP地址 |
time | 用户进入或离开的时间 |
UAType | 观看渠道; 0:PC; 1:移动; |
socketId | 登陆socketId; |
JSON格式的返回信息如下:
{
"result": "OK",
"userActions": [
{
"userId": "c0f67aec0dcd4b47a6e646653bbd7a35",
"userName": "ccc",
"userIp": "111.206.10.21",
"time": "2019-01-02 14:27:46.0",
"recordId": "D66B63F89917A1CB",
"roomId": "82C9DDA7A237303A9C33DC5901307461",
"UAType": 1,
"socketId": "6TtduOdVCFjG3shJAKkv"
},
{
"userId": "c0f67aec0dcd4b47a6e646653bbd7a35",
"userName": "bbb",
"userIp": "111.206.10.21",
"time": "2019-01-02 14:28:17.0",
"recordId": "D66B63F89917A1CB",
"roomId": "82C9DDA7A237303A9C33DC5901307461",
"UAType": 1,
"socketId": "XImavxYecG-Q9_R2BYbA"
},
{
"userId": "e194b87b469e441ab896ea87f2937cbf",
"userName": "aaa",
"userIp": "111.206.10.41",
"time": "2019-01-02 17:19:47.0",
"recordId": "B9344394BF816F90",
"roomId": "086C4E55A8B5FEC19C33DC5901307461",
"UAType": 1,
"socketId": "u0-9FjWsZKpPcFivFLMr"
}
],
"action": 0,
"pageIndex": 1,
"count": 3
}
获取聊天信息
通过该接口可以分页获取直播的聊天信息,接口请求地址为:
https://api.csslcloud.net/api/live/chatmsg
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
liveid | 直播id | |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 聊天总数 | chatMsgs | 聊天列表信息 |
chatMsgs包含以下字段:
字段名 | 说明 |
viewerId | 观众id |
viewerName | 观众名称 |
viewerRole | 观众角色(0:未统计,1:主讲,2:助教,3:主持人,4:学员) |
time | 聊天时间 |
content | 聊天内容 |
JSON格式的返回信息如下:
{
"result": "OK",
"count": 1,
"chatMsgs": [
{
"content": "粮仓到底还是满了",
"time": "2016-11-28 20:30:33",
"viewerName": "苍井满",
"viewerId": "0cda7ng03j9502ian",
"viewerRole": 0
}
]
}
获取抽奖信息
通过该接口可以分页获取直播的抽奖信息,接口请求地址为:
https://api.csslcloud.net/api/live/lotterys
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
liveid | 直播id | |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
lotteryRoundCount | 抽奖轮数 | lotteryRounds | 抽奖轮数信息 |
lotteryRounds包含以下字段:
字段名 | 说明 |
lotteryId | 抽奖ID |
lotteryCount | 中奖人数 |
lotteries | 中奖用户信息 |
time | 中奖时间 |
lotteryIndex | 中奖顺序 |
viewerName | 中奖人名称 |
viewerId | 中奖人Id |
lotteryCode | 中奖码 |
JSON格式的返回信息如下:
{
"result": "OK",
"lotteryRounds": [
{
"lotteries": [
{
"time": "2016-11-28 20:30:33",
"lotteryIndex": 1,
"viewerName": "苍井满",
"lotteryCode": 9876,
"viewerId": "0cda7ng03j9502ian"
},
...
],
"lotteryCount": 10,
"lotteryId": "20160928020202222"
}
],
"lotteryRoundCount": 8
}
获取抽奖信息2.0
通过该接口可以分页获取直播的抽奖信息,接口请求地址为:
https://api.csslcloud.net/api/live/lotterys/plus
需要传递以下参数:
参数 | 说明 | 备注 |
roomId | 直播间id | |
accountId | 账户ID | |
liveId | 直播id | |
pageSize | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageNo | 页码 | 可选,系统默认值为1 |
返回数据包含以下字段:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | object | 非必须 | |||
├─ count | number | 非必须 | 直播下有多少场抽奖 | ||
├─ lotterys | object [] | 非必须 | 抽奖列表 | item 类型: object |
|
├─ id | string | 非必须 | 抽奖ID | ||
├─ winUserCount | number | 非必须 | 中奖人数 | ||
├─ completeTime | string | 非必须 | 完成时间 | ||
├─ prize | object | 非必须 | 奖品信息 | ||
├─ name | string | 非必须 | 奖品名称 | ||
├─ winningUsersCollectTemplates | object [] | 非必须 | 用户收集信息模版 | item 类型: object |
|
├─ index | number | 必须 | 索引 | ||
├─ title | string | 必须 | 头信息 | ||
├─ tips | string | 必须 | 描述 | ||
├─ winUsers | object [] | 非必须 | 中奖人员信息 | item 类型: object |
|
├─ userId | string | 必须 | 用户ID | ||
├─ userName | string | 必须 | 用户名称 | ||
├─ userType | number | 必须 | 用户类型 | ||
├─ prizeCode | string | 必须 | 中奖码 | ||
├─ userCollectInfos | object [] | 必须 | 用户收集信息详情 | item 类型: object |
|
├─ index | number | 必须 | 索引,对应模版索引 | ||
├─ value | string | 必须 | 索引值 | ||
success | boolean | 必须 | 是否成功 | ||
error | object | 非必须 | 错误信息 | ||
├─ code | number | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误内容 |
获取问答信息
通过该接口可以分页获取直播的问答信息,接口请求地址为:
https://api.csslcloud.net/api/live/qas
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
liveid | 直播id | |
pagenum | 每页显示的个数 | 可选,系统默认值为50,最大值为100 |
pageindex | 页码 | 可选,系统默认值为1 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
questionCount | 提问总数 | questions | 提问列表信息 |
questions包含以下字段:
字段名 | 说明 |
viewerId | 学员id |
viewerName | 学员名称 |
viewerRole | 回答者角色(0:未统计,1:主讲,2:助教,3:主持人,4:学员) |
time | 操作时间 |
content | 内容 |
answers | 回答列表 |
isPrivate | 是否私密回答(0:公开回答 1:私密回答) |
JSON格式的返回信息如下:
{
"result": "OK",
"questionCount": 1,
"questions": [
{
"viewerName": "铁柱",
"viewerId": "w1c0a9n87lxcm77234mn",
"content": "怎么质检3xing手机?",
"time": "2016-11-28 20:30:50",
"answers": [
{
"content": "手机充上电,OK,换下一个手机,Not OK,换下一个质检员",
"time": "2016-10-10 17:00:50",
"isPrivate": 1,
"viewerName": "全蛋",
"viewerId": "7a9n4m8w1c07lx2cm73n",
"viewerRole": 0
}
]
}
]
}
获取签到信息
通过该接口可以获取直播的签到信息,接口请求地址为:
https://api.csslcloud.net/api/live/rollcall
需要传递以下参数:
参数 | 说明 | 备注 |
roomid | 直播间id | |
userid | CC账户ID | |
liveid | 直播id |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
count | 签到次数 | rollcalls | 签到列表信息 |
rollcalls包含以下字段:
字段名 | 说明 |
totalNum | 总人数 |
duration | 签到时长 |
time | 操作时间 |
rollcallId | 签到ID |
checkedNum | 签到人数 |
JSON格式的返回信息如下:
{
"result": "OK",
"count": 4,
"rollcalls": [
{
"totalNum": 3,
"duration": 10,
"time": "2016-11-28 20:20:20",
"rollcallId": "13358DE27D943A99",
"checkedNum": 0
}
]
}
获取签到用户信息
通过该接口获取签到用户信息,接口请求地址为:
https://api.csslcloud.net/api/v2/live/rollcall/viewers
需要传递以下参数:
参数 | 说明 |
roomid | 直播间id |
userid | CC账户ID |
liveid | 直播id |
rollcallid | 签到ID |
pageindex | 可选,查询页码,默认为1 |
pagenum | 可选,单页所查询的数据条数,默认为50,最大阈值为100 |
返回数据包含以下字段:
字段名 | 说明 |
result | 请求是否成功。OK:成功;FAIL:失败 |
viewers | 签到用户列表信息 |
viewers包含以下字段:
字段名 | 说明 |
viewerId | 观看者ID |
viewerName | 观看者名称 |
checked | 是否签到,1:签到,0:未签到 |
JSON格式的返回信息如下:
{
"result": "OK",
"viewers": [
{
"viewerName": "铁柱",
"viewerId": "a9a589134a2e4037938d85a63cfb28bb",
"checked": 0
},
...
],
"pageIndex": 1,
"count": 10
}
获取问卷信息
通过该接口获取问卷信息,接口请求地址为:
https://api.csslcloud.net/api/live/questionnaires
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
liveid | 直播id | 必须 |
返回数据:
{
"result": "OK",
"questionnaires": [{ // 问卷信息
"id": "8CF77A91E659162F", // 问卷ID
"title": "用户问卷调查", // 问卷题目
"submitAnswerViewerCount": 100, // 交卷总人数
"subjects": [{ // 问卷题目信息
"id": "C91F302B7655688E", // 题目ID
"index": 0, // 题目索引
"content": "性别?", // 题目内容
"type": 0, // 题目类型:0单选,1多选,2问答
"options": [{ // 选项
"id": "64367D8CDD368AE3", // 选项ID
"index": 0, // 选项索引
"content": "男", // 选项内容
"correct": 0, // 是否正确
"selectedCount": 100 // 选择该项的人数
},{
"id": "906B22CC9DEA925D",
"index": 1,
"content": "女",
"correct": 0,
"selectedCount": 200
},{
"id": "C1CC3275BBCE7F35",
"index": 2,
"content": "保密",
"correct": 1,
"selectedCount": 300
}]
},{
"id": "C91F302B7655688E",
"index": 1,
"content": "掌握的编程语言?",
"type": 1,
"options": [{
"id": "0BB798B9190A7C25",
"index": 0,
"content": "Java",
"correct": 0,
"selectedCount": 1000
},{
"id": "7EFD4A88DEF569AC",
"index": 1,
"content": "Python",
"correct": 0,
"selectedCount": 2000
},{
"id": "CB5F16DD59540FBC",
"index": 2,
"content": "Go",
"correct": 1,
"selectedCount": 2000
},{
"id": "0AC802A9B58C5E83",
"index": 3,
"content": "JavaScript",
"correct": 1,
"selectedCount": 2020
}]
},{
"id": "10EB3D79A0CAD63E",
"index": 2,
"content": "其他技能?",
"type": 1
}]
}
获取用户答卷信息
通过该接口获取用户答卷信息,接口请求地址为:
https://api.csslcloud.net/api/live/questionnaire/viewers
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
liveid | 直播id | 必须 |
questionnaireid | 问卷ID | 必须 |
pageindex | 页码 | 可选,默认1 |
pagenum | 每页显示的个数 | 可选,单页所查询的数据条数,默认为50,最大阈值为500 |
返回数据:
{
"result": "OK",
"submitAnswerViewerCount": 1, // 提交的总人数
"pageNum": 100,
"pageIndex": 1,
"viewers": [{ // 学员提交问卷的详细信息
"id": "9c2ea7b260824f1d8e", // 学员ID
"name": "小明", // 学员名称
"submitTime": "2017-03-31 10:57:31", // 学员提交时间
"answers": [{ // 学员提交答案信息
"subjectId": "C91F302B7655688E", // 题目ID
"selectedOptionId": "64367D8CDD368AE3" // 选择选项ID
},{
"subjectId": "C91F302B7655688E",
"selectedOptionIds": "0BB798B9190A7C25,7EFD4A88DEF569AC,CB5F16DD59540FBC,0AC802A9B58C5E83"
},{
"subjectId": "10EB3D79A0CAD63E",
"answerContent": "云和分布式计算, 统计分析和数据挖掘, Web架构和开发框架, 中间件和集成软, 用户界面设计, 网络和信息安全, 移动开发, SEO/SEM营销, 存储系统和管理"
}]
}
]
}
获取随堂测信息
通过该接口获取随堂测信息,请求接口地址:
https://api.csslcloud.net/api/practice/info
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
liveid | 直播id | 必须 |
pageindex | 页码 | 可选,默认1 |
pagenum | 每页显示的个数 | 可选,单页所查询的数据条数,默认100 区间[1~1000] |
返回参数示例及说明: 成功:
{
"result": "OK",
"count": 1231, // 总共发布了多少次随堂测
"pageIndex": 1, // 第几页
"practices": [ // 随堂测信息
{
"id": "2482038403", // 随堂测ID
"publishTime": "2019-01-12 14:35:12", // 发布时间
"type": 2, // 随堂测类型 判断:0,单选:1,多选:2
"options": [ // 随堂测选项信息
{
"index": 0, // 选项索引
"isCorrect": 1 // 选项是否为正确答案 0 错误 1 正确
},
{
"index": 1, // 选项索引
"isCorrect": 1 // 选项是否为正确答案 0 错误 1 正确
},
{
"index": 2, // 选项索引
"isCorrect": 0 // 选项是否为正确答案 0 错误 1 正确
}
]
}
]
}
失败:
{
"result": "FAIL",
"reason": "错误原因"
}
获取用户提交随堂测信息
通过该接口可以获取用户提交随堂测信息,接口请求地址:
https://api.csslcloud.net/api/practice/submit/info
需要传递以下参数:
参数 | 说明 | 备注 |
userid | CC账户ID | 必须 |
liveid | 直播id | 必须 |
practiceid | 随堂测ID | 必须 |
pageindex | 页码 | 可选,默认1 |
pagenum | 每页显示的个数 | 可选,单页所查询的数据条数,默认100 区间[1~1000] |
返回参数示例及说明: 成功:
{
"result": "OK",
"count": 1231, // 总共有多少个用户提交答案
"pageIndex": 1, // 第几页
"submitDatas": [
{
"viewerId": "432842804", // 观看者ID
"viewerName": "zhangfei", // 观看者昵称
"submitTime": "2019-01-12 15:12:34", // 提交时间
"submitOptions": [0,1,2,3] // 提交的选项索引
}
]
}
失败:
{
"result": "FAIL",
"reason": "具体错误原因"
}
获取直播打卡信息
通过该接口获取直播打卡信息,请求接口地址:
https://api.csslcloud.net/api/punch/list
需要传递以下参数:
参数名称 | 是否必须 | 备注 |
---|---|---|
accountId | 是 | 账户id |
liveId | 是 | 加密直播ID |
pageNo | 是 | 分页页码,最小值为1,默认值为1。 |
pageSize | 是 | 分页大小,最小值为1,最大值为100,默认值为100。 |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | string | 必须 | 错误代码。 | ||
├─ message | string | 必须 | 错误描述。 | ||
data | object | 非必须 | |||
├─ count | number | 必须 | |||
├─ punches | object [] | 必须 | item 类型: object |
||
├─ id | string | 必须 | 打卡ID。 | ||
├─ publisherId | string | 必须 | 发起者 ID。 | ||
├─ publisherName | string | 必须 | 发起者名称。 | ||
├─ createTime | string | 必须 | 打卡开始时间,格式yyyy-MM-dd HH:mm:ss。 | ||
├─ expireTime | string | 非必须 | 打卡到期时间,格式 yyyy-MM-dd HH:mm:ss。打卡无到期时间时,此项不存在。 | ||
├─ allowLater | boolean | 必须 | 是否允许后进入者参与打卡。 | ||
├─ isFinish | boolean | 必须 | 打卡互动是否结束。 | ||
├─ finishTime | string | 非必须 | 打卡结束时间,格式yyyy-MM-dd HH:mm:ss。isFinish=true 时必须。 | ||
├─ total | number | 必须 | 应打卡人数。 | ||
├─ punched | number | 必须 | 实际打卡人数。isFinish=false 时,此值为0,无意义。 |
获取用户打卡记录
通过该接口可以获取用户打卡记录信息,接口请求地址:
https://api.csslcloud.net/api/punch/detail
需要传递以下参数:
参数名称 | 是否必须 | 备注 |
---|---|---|
accountId | 是 | 账户id |
punchId | 是 | 打卡 ID。 |
pageNo | 是 | 分页页码,最小值为1,默认值为1。 |
pageSize | 是 | 分页大小,最小值为1,最大值为100,默认值为100。 |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | 接口处理结果。 | ||
error | object | 非必须 | 失败时的错误信息,success=false时必须。 | ||
├─ code | number | 必须 | 错误代码。 | ||
├─ message | string | 必须 | 错误描述。 | ||
data | object | 非必须 | 成功时返回的数据,success=true时必须。 | ||
├─ punch | object | 必须 | 打卡信息。 | ||
├─ id | string | 必须 | 打卡ID。 | ||
├─ publisherId | string | 必须 | 发起者 ID。 | ||
├─ publisherName | string | 必须 | 发起者名称。 | ||
├─ createTime | string | 必须 | 打卡开始时间,格式yyyy-MM-dd HH:mm:ss。 | ||
├─ total | number | 必须 | 应打卡人数。 | ||
├─ punched | number | 必须 | 实际打卡人数。 | ||
├─ duration | number | 必须 | 打卡持续时间,单位:秒。 无过期时间时,返回完成时间和开始时间的差。 若有过期时间,返回完成时间和开始时间的差和过期时间和开始时间的差之间较小的值 | ||
├─ punchViewers | object [] | 必须 | 参与打卡学员列表,按分页返回。 | item 类型: object |
|
├─ id | string | 必须 | 学员 ID。 | ||
├─ name | string | 必须 | 学员名称。 | ||
├─ createTime | string | 必须 | 参与打卡时间,格式yyyy-MM-dd HH:mm:ss。 | ||
├─ isPunched | boolean | 必须 | 是否打卡。 | ||
├─ punchTime | string | 非必须 | 打卡时间,格式yyyy-MM-dd HH:mm:ss。isPunched=true 时必须。 |
查询账户回调配置
通过该接口可以查询账户回调配置信息,接口请求地址:
https://api.csslcloud.net/api/v1/callbacks
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 用户账户id |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
error | object | 非必须 | |||
├─ code | string | 非必须 | 10000004 | ||
├─ message | string | 非必须 | invalid thqs | ||
data | object | 非必须 | |||
├─ callbacks | object [] | 非必须 | item 类型: object |
||
├─ notifyUrl | string | 非必须 | 回调通知地址 | ||
├─ type | number | 非必须 | 回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用, 6:回放重制回调, 8:伪直播资源准备结果回调 其他值未知 | ||
├─ status | number | 非必须 | 状态标识,0禁用,1启用 |
修改账号回调配置
通过该接口可以修改账号回调配置信息,接口请求地址:
https://api.csslcloud.net/api/v1/callbacks/save
Method: POST
需要传递以下参数:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json;charset=UTF-8 | 是 | application/json;charset=UTF-8 | 请求类型,必须是:application/json;charset=UTF-8 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 用户账户id |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
object [] | 必须 | 数组 | item 类型: object |
||
├─ status | number | 必须 | 状态标识,0禁用,1启用 | ||
├─ notifyUrl | string | 必须 | 回调地址 | ||
├─ type | number | 必须 | 回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用,请不要使用 6:回放重制回调, 8:伪直播资源准备结果回调 |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
error | object | 非必须 | |||
├─ code | number | 非必须 | 10000004 | ||
├─ message | string | 非必须 | invalid thqs |
创建回放重制任务
通过该接口可以创建回放重制任务,接口请求地址:
https://api.csslcloud.net/api/v1/replay/composition/batchAdd
注意事项:
使用该接口需开通回放重制权限,且回放重制可用时长大于0;
回放重制仅支持文档模板的回放,大屏模版的回放不支持重制;
批量创建任务时,若回放id中有一个无法通过以下校验则全部添加失败
- 不合法回放id
- 非文档模板的回放
- 正在重制中的回放id
- 回放状态不可用
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 用户账户id |
replayIds | 是 | A1976C7867397461,A1976C76733D07461 | 回放id,用都逗号分割字符串,回放id数量在1到10之间 |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
data | object | 非必须 | |||
├─ successReplays | object [] | 非必须 | item 类型: object |
||
├─ replayId | string | 非必须 | 成功的回放id | ||
├─ replayCompositionId | string | 非必须 | 回放重制id | ||
error | object | 非必须 | |||
├─ code | string | 非必须 | 10000000 | ||
├─ message | string | 非必须 | Invalid Params |
查询回放重制任务信息
通过该接口可以查询回放重制任务信息,接口请求地址:
https://api.csslcloud.net/api/v1/replay/composition/get
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 用户账户id |
replayCompositionId | 是 | 47aef2d7-c03d-4894-adb2-bb399ab20960 | 回放重制id,添加接口返回id |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
data | object | 非必须 | |||
├─ composition | object | 非必须 | |||
├─ replayCompositionId | string | 非必须 | 回放重制id,添加任务接口返回 | ||
├─ accountId | string | 非必须 | 用户账户id | ||
├─ replayId | string | 非必须 | 回放id | ||
├─ roomId | string | 非必须 | 房间id | ||
├─ videoId | string | 非必须 | 视频id,status值为5时存在值 | ||
├─ title | string | 非必须 | 标题 | ||
├─ duration | number | 非必须 | 时长,单位:秒,status值不为5时,duration值为0 | ||
├─ beginTime | string | 非必须 | 重制开始时间 | ||
├─ status | number | 非必须 | 重制状态,1重制中,5重制成功,-1重制失败,其他值未知 | ||
├─ videoDownLoadUrl | string | 非必须 | 回放重制成功后视频下载地址 | ||
error | object | 非必须 | |||
├─ code | string | 非必须 | 10000014 | ||
├─ message | string | 非必须 | exist invalid param |
查询回放重制列表信息
通过该接口可以查询回放重制任务列表信息,接口请求地址:
https://api.csslcloud.net/api/v1/replay/composition/find
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 用户账户加密id |
startTime | 是 | 2020-11-25 12:12:12 | 开始时间,格式:yyyy-MM-dd HH:mm:ss,需要与结束时间成对存在,开始结束时间范围不能大于7天 |
endTime | 是 | 2020-11-27 12:12:12 | 结束时间,格式:yyyy-MM-dd HH:mm:ss需要与开始时间成对存在,开始结束时间范围不能大于7天 |
pageNo | 是 | 1 | 页码,默认1 |
pageSize | 是 | 50 | 每页数量,默认值50,最大值50 |
searchType | 否 | 1 | 查询类型 1:回放ID 2:视频ID 3:直播间ID,只有searchId存在值并且格式合法时才会检查类型 |
searchId | 否 | 3688DC7A99D6FAEF | 根据查询类型传入对应查询id |
searchStatus | 否 | 5 | 查询状态 重制中 1 成功 5 失败 -1 其它值 未知 |
返回数据说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
error | object | 非必须 | |||
├─ code | integer | 非必须 | 10000014 | ||
├─ message | string | 非必须 | exist invalid param | ||
data | object | 非必须 | |||
├─ compositions | object [] | 非必须 | item 类型: object |
||
├─ replayCompositionId | string | 非必须 | 回放重制id,添加回放重制任务后返回的id | ||
├─ accountId | string | 非必须 | 用户账户id | ||
├─ replayId | string | 非必须 | 回放id | ||
├─ roomId | string | 非必须 | 直播间id | ||
├─ videoId | string | 非必须 | 视频id,status值为5时存在值 | ||
├─ title | string | 非必须 | 标题 | ||
├─ duration | number | 非必须 | 时长,单位:秒,status值不为5时,其值为0 | ||
├─ beginTime | string | 非必须 | 开始时间 | ||
├─ status | number | 非必须 | 状态,1 重制中,5重制成功,-1失败,其它值 未知 | ||
├─ pagination | object | 非必须 | |||
├─ pageNo | number | 非必须 | 页码 | ||
├─ pageSize | number | 非必须 | 每页数量 | ||
├─ totalCount | number | 非必须 | 总数 | ||
├─ pageCount | number | 非必须 | 总页数 |
增加/编辑回放打点信息
通过该接口可以增加/编辑回放打点信息,接口请求地址:
https://api.csslcloud.net/api/replay/mark/point/save
Method: POST
需要传递以下参数:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
accountId | string | 必须 | 账户ID | ||
replayId | string | 必须 | 回放ID | ||
pointTime | integer | 必须 | 打点时间 | ||
desc | string | 必须 | 打点描述(不超过20个字符) | ||
type | string | 必须 | 0:新增 1:编辑 | ||
preTime | string | 非必须 | 修改前的时间点(新增非必填) |
返回数据:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
查询回放打点列表
通过该接口可以查询回放打点信息,接口请求地址:
https://api.csslcloud.net/api/replay/mark/search
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 账户ID |
replayId | 是 | 99C33DC5901307461 | 回放ID |
返回数据:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
data | object | 必须 | |||
├─ points | object [] | 必须 | item 类型: object | ||
├─ time | integer | 必须 | 打点时间(单位:S) | ||
├─ desc | string | 必须 | 打点描述(不超过20个字符) |
删除回放打点
通过该接口可以删除回放打点信息,接口请求地址:
https://api.csslcloud.net/api/replay/mark/point/delete
Method: POST
需要传递以下参数:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
accountId | string | 必须 | 账户ID | ||
replayId | string | 必须 | 回放ID | ||
pointTime | integer | 必须 | 时间点 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
回放剪辑
通过该接口可以发起回放剪辑任务,接口请求地址:
https://api.csslcloud.net/api/v1/record/clip/create
需要传递以下参数:
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 账户ID |
recordId | 是 | 99C33DC5901307461 | 回放ID |
sections | 是 | 0-30,40-70,80-120 | 裁剪段(单位:s),最大裁剪30段,不允许有重叠 |
dstName | 是 | 裁剪-回放标题 | 裁剪后生成回放的标题 |
返回数据:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true/false | ||
data | object | 非必须 | |||
├─ replayId | string | 必须 | 回放ID | ||
├─ liveId | string | 必须 | 直播ID | ||
object | 非必须 | ||||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
回放观看记录(V2版本)
基本信息
Path: https://api.csslcloud.net/api/v2/replay/watch/record
Method: GET
接口描述:
通过该接口可以查询2021-07-01日之后的账号下回放观看记录记录;
注意:最大查询时间间隔 1天;返回数据中无leaveTime表示登录回放后未退出
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
startTime | 是 | 2021-06-08 12:00:00 | 查询开始时间 [日期格式:yyyy-MM-dd HH:mm:ss] |
endTime | 是 | 2021-06-09 12:00:00 | 查询结束时间 [日期格式:yyyy-MM-dd HH:mm:ss] |
pageNo | 是 | 1 | 页码[ >0],默认1 |
pageSize | 是 | 200 | 每页大小 [1-500 ],默认200 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ record | object [] | 非必须 | 观看记录 | item 类型: object | |
├─ playId | string | 必须 | 观看记录ID(唯一) | ||
├─ roomId | string | 必须 | 直播间ID | ||
├─ replayId | string | 必须 | 回放ID | ||
├─ replayTitle | string | 必须 | 回放标题 | ||
├─ userId | string | 必须 | 用户ID | ||
├─ userName | string | 必须 | 用户昵称 | ||
├─ userIp | string | 必须 | 用户IP | ||
├─ userRegion | string | 必须 | 用户IP所在地域(中国-江苏-南京) | ||
├─ uaType | number | 必须 | ua类型 0:PC , 1:移动端 | ||
├─ enterTime | string | 必须 | 进入时间 [日期格式:yyyy-MM-dd HH:mm:ss] | ||
├─ leaveTime | string | 非必须 | 离开时间 [日期格式:yyyy-MM-dd HH:mm:ss],非必须,当没有离开时间时不返回 | ||
├─ userCustomInfo | string | 非必须 | 用户自定义备注信息 | ||
├─ pagination | object | 非必须 | 分页信息 | ||
├─ totalCount | number | 必须 | 总条数 | ||
├─ pageCount | number | 必须 | 总页数 | ||
├─ pageNo | number | 必须 | 当前页码 | ||
├─ pageSize | number | 必须 | 每页条数 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
全局礼物打赏配置
基本信息
Path: https://api.csslcloud.net/api/global/gift/setting/save
Method: POST
接口描述:
通过该接口可以开启或关闭全局礼物打赏开关,直播间通过引用全局礼物开关开启礼物打赏配置;
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
globalGiftSwitch | 是 | 1 | 礼物打赏全局开关 0:关闭 1:开启 默认为关闭状态 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
创建账号礼物打赏信息和修改账号礼物打赏信息
基本信息
Path: https://api.csslcloud.net/api/gift/config/save
Method: POST
接口描述:
通过该接口可以创建账号的礼物打赏信息和修改账号礼物打赏信息;
接口加密方式:THQS加密
(仅Query参数需要THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
giftName | 是 | flower | 礼物名 |
giftThumbnail | 是 | https://t-marketing.csslcloud.net/static/img/魔法棒_400x400.gif | 礼物图片 |
giftStatus | 是 | 1 | 礼物状态 0:禁用 1:启用 默认为启用 |
price | 是 | 10 | 礼物金额,单位:分 |
id | 否 | E0DA951C5D84C9D3 | 礼物id,保存时无需传此值,如果为修改,该值必传 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ giftId | string | 必须 | 礼物id | item 类型: object |
|
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
删除账号礼物打赏配置
基本信息
Path: https://api.csslcloud.net/api/gift/config/delete
Method: POST
接口描述:
通过该接口可以根据礼物id删除账号的礼物打赏配置 注意:默认礼物打赏信息不可以删除
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
giftId | 是 | 16406029CB3DBEB7 | 礼物id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
礼物打赏配置查询
基本信息
Path: https://api.csslcloud.net/api/gift/config
Method: GET
接口描述:
通过该接口可以根据账号id查询账号的礼物打赏配置信息
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
pageNo | 否 | 1 | 页码,默认为1 |
pageSize | 否 | 20 | 每页大小,默认20.最大值50,当传入值大于50时,按照每页50查询 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 必须 | |||
├─ pagination | object | 必须 | 分页信息 | ||
├─ pageNo | string | 必须 | 页码 | ||
├─ pageSize | string | 必须 | 每页条数 | ||
├─ total | string | 必须 | 总条数 | ||
├─ data | object [] | 必须 | 礼物列表 | item 类型: object |
|
├─ id | string | 必须 | 礼物id | ||
├─ giftName | string | 必须 | 礼物名称 | ||
├─ giftThumbnail | string | 必须 | 礼物图片地址 | ||
├─ giftDefault | integer | 必须 | 是否是默认礼物 1: 是 0: 否 | ||
├─ giftStatus | integer | 必须 | 礼物可使用状态 0:禁用 1:启用 默认为启用 | ||
├─ price | integer | 必须 | 礼物价格,单位:分 | ||
├─ specialEffects | integer | 必须 | 礼物显示特效,1:左侧显示 2:居中显示,默认为1 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
修改礼物打赏特效
基本信息
Path: https://api.csslcloud.net/api/gift/effects/update
Method: POST
接口描述:
通过该接口可以修改礼物打赏的显示特效
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
specialEffects | 是 | 1 | 礼物特效 1:左侧显示 2:居中显示 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
直播间点赞配置查询
基本信息
Path: https://api.csslcloud.net/api/like/config
Method: GET
接口描述:
通过该接口可以查询直播间的点赞配置信息
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
roomId | 是 | 1C6EAB2F4056166B9C33DC5901307461 | 直播间id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ config | object | 必须 | 点赞配置 | ||
├─ activityId | string | 必须 | 活动id | ||
├─ basicTimes | integer | 必须 | 基础倍数,即每次点赞相乘的倍数 | ||
├─ basicNumbers | integer | 必须 | 基础点赞数量,点赞时会在此值上面递增 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
直播间点赞配置编辑
基本信息
Path: https://api.csslcloud.net/api/like/config/update
Method: POST
接口描述:
通过该接口可以编辑直播间的点赞配置信息
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
roomId | 是 | 1C6EAB2F4056166B9C33DC5901307461 | 直播间id |
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
basicTimes | 是 | 2 | 基础倍数,即每次点赞相乘的倍数 |
basicNumbers | 是 | 15 | 基础点赞数量,点赞时会在此值上面递增 |
activityId | 是 | G78352F7CB77E1F3 | 活动id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ config | object | 必须 | 点赞配置 | ||
├─ activityId | string | 必须 | 活动id | ||
├─ basicTimes | integer | 必须 | 基础倍数,即每次点赞相乘的倍数 | ||
├─ basicNumbers | integer | 必须 | 基础点赞数量,点赞时会在此值上面递增 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
客户端信息上报数据查询
基本信息
Path: https://api.csslcloud.net/api/live/report/info
Method: GET
接口描述:
通过该接口可以查询客户端直播时上报的设备信息
接口加密方式:THQS加密
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
roomId | 是 | 1C6EAB2F4056166B9C33DC5901307461 | 直播间id |
queryTime | 是 | 2022-8-10 14:30 | 查询当前时刻上报的设备信息,格式: yyyy-MM-dd HH:mm |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ systemVersion | string | 必须 | 操作系统版本 | ||
├─ sdkVersion | string | 必须 | 客户端版本 | ||
├─ reportInfos | object [] | 必须 | 上报的信息数据 | ||
├─ resolution | object | 必须 | 分辨率 | ||
├─ w | integer | 必须 | 宽度 | ||
├─ h | integer | 必须 | 高度 | ||
├─ cpu | number | 必须 | cpu使用率 | ||
├─ memoryTotal | integer | 必须 | 总内存容量 单位M | ||
├─ memoryUse | integer | 必须 | 内存已使用容量 单位M | ||
├─ memoryFree | integer | 必须 | 内存空闲容量 单位M | ||
├─ lostFrameRate | integer | 必须 | 丢帧率 | ||
├─ bitRate | integer | 必须 | 码率 | ||
├─ frameRate | integer | 必须 | 帧率 | ||
├─ time | number | 必须 | 时间戳,单位毫秒 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
JSON格式的返回信息如下:
{
"success":true,
"data":{
"systemVersion":"Windows 10 (10.0)",
"sdkVersion":"windows-app-5.8.2.11",
"reportInfos":[
{
"resolution":{
"h":720,
"w":1280
},
"time":1660185425161,
"memoryTotal":8014,
"memoryUse":226,
"memoryFree":2225,
"frameRate":20,
"lostFrameRate":0,
"bitRate":500,
"cpu":4.1041340827941895
},
{
"resolution":{
"h":720,
"w":1280
},
"time":1660185426162,
"memoryTotal":8014,
"memoryUse":226,
"memoryFree":2225,
"frameRate":20,
"lostFrameRate":0,
"bitRate":500,
"cpu":3.708439588546753
},
{
"resolution":{
"h":720,
"w":1280
},
"time":1660185427162,
"memoryTotal":8014,
"memoryUse":226,
"memoryFree":2226,
"frameRate":20,
"lostFrameRate":0,
"bitRate":500,
"cpu":3.3223042488098145
}
]
}
}
获取直播间直播用户的访问记录
基本信息
Path: https://api.csslcloud.net/api/live/user/useraction
Method: GET
接口描述:
通过该接口可以通过直播间ID获取观看直播的访问记录
接口加密方式:THQS加密
请求参数
Query
参数 | 说明 | 是否必须 | 备注 |
accountId | CC账户ID | 必须 | |
roomId | 直播间ID | 必须 | |
startTime | 学员进入时刻 | 必须 | 学员进入直播间的开始时间, 格式:yyyy-MM-dd HH:mm:ss 示例:2022-08-20 09:12:20 |
endTime | 学员进入时刻 | 必须 | 学员进入直播间的结束时间,和startTime参数的时间间隔最大为24H, 格式:yyyy-MM-dd HH:mm:ss 示例:2022-08-21 09:12:10 |
pageNum | 每页显示的个数 | 非必须 | 可选,默认值为50,最大阈值为1000 |
pageIndex | 页码 | 非必须 | 可选,默认值为1 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ count | string | 必须 | 总条数 | ||
├─ userActions | object [] | 必须 | 用户进出信息 | ||
├─ liveId | string | 必须 | 直播id | ||
├─ userId | string | 必须 | 用户id | ||
├─ userName | string | 必须 | 用户名 | ||
├─ userIp | string | 必须 | 用户ip | ||
├─ city | string | 必须 | 用户地域信息 | ||
├─ enter | string | 必须 | 进入时间,格式:yyyy-MM-dd HH:mm:ss | ||
├─ leave | string | 必须 | 离开时间,格式:yyyy-MM-dd HH:mm:ss | ||
├─ watchDuration | integer | 必须 | 直播观看时长,单位:秒 | ||
├─ terminal | integer | 必须 | 终端类型,0表示PC端,1表示移动端 | ||
├─ customInfo | string | 非必须 | 自定义用户信息 | ||
├─ role | integer | 非必须 | 用户角色,1:主讲、推流端角色, 2:助教端角色,3:主持人角色,4:学生、观看端角色 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
JSON格式的返回信息如下:
{
"success": true,
"data": {
"count": 2,
"userActions": [
{
"userName": "111",
"liveId": "C85C3C21B94CF55C",
"customInfo": "",
"userId": "d01af85f969440c6887b9ef3a13622fb",
"terminal": 0,
"watchDuration": 5015,
"userIp": "192.168.2.204",
"city": "局域网",
"enter": "2022-08-24 16:21:52",
"leave": "2022-08-24 17:45:27",
"role": 4
},
{
"userName": "aaa",
"liveId": "C85C3C21B94CF55C",
"customInfo": "",
"userId": "ff643b0980424ec3b132c65ea0d0b091",
"terminal": 0,
"watchDuration": 5015,
"userIp": "192.168.2.204",
"city": "局域网",
"enter": "2022-08-24 16:21:52",
"leave": "2022-08-24 17:45:27",
"role": 2
}
]
}
}
直播带货-创建商品
基本信息
Path: https://api.csslcloud.net/api/product/create
通过该接口可以创建商品,接口请求地址为:
接口加密方式:THQS加密 (仅Query参数需THQS加密) </p>
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
参数 | 类型 | 说明 | 是否必须 | 备注 |
title | string | 商品名称 | 必须 | 最大支持50字符长度 |
cover | string | 封面 | 必须 | 商品封面图片地址,最大支持300字符长度 |
tag | string | 标签 | 非必须 | 如"香甜,可口" |
desc | string | 描述 | 非必须 | |
originPrice | integer | 划线价格, 单位分 | 必须 | 必须为大于等于0的整数,最大值999999999 |
currentPrice | integer | 购买价格,单位分 | 必须 | 必须为大于等于0的整数,最大值999999999 |
link | string | 通用链接 | 非必须 | 商品通用链接地址,最大长度为500字符 |
linkType | integer | 链接类型:0:通用链接 1:多平台链接,默认为0 | 非必须 | |
platformLink | object [] | 当为多平台链接时传入 | 非必须 | |
├─ terminal | integer | 终端类型 终端:1:PC 2:H5 3: App 4:微信小程序id 5:微信小程序路径 | 必须 | |
├─ link | string | 链接地址 | 必须 | |
button | string | 按钮文案 | 必须 | 最长支持字符长度:200 |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ goodsId | integer | 必须 | 商品id | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
更新商品
基本信息
Path: https://api.csslcloud.net/api/product/update
Method: POST
接口描述:
通过该接口可以编辑更新商品库商品信息
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | C783F0F7CB77E1F3 | 帐号ID |
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
参数 | 类型 | 说明 | 是否必须 | 备注 |
id | integer | 商品id | 必须 | |
title | string | 商品名称 | 必须 | 最大支持50字符长度 |
cover | string | 封面 | 必须 | 商品封面图片地址,最大支持300字符长度 |
tag | string | 标签 | 非必须 | 如"香甜,可口" |
desc | string | 商品描述 | 非必须 | |
originPrice | integer | 划线价格, 单位分 | 必须 | 必须为大于等于0的整数,最大值999999999 |
currentPrice | integer | 购买价格,单位分 | 必须 | 必须为大于等于0的整数,最大值999999999 |
link | string | 通用链接 | 非必须 | 商品通用链接地址,最大长度为500字符 |
linkType | integer | 链接类型:0:通用链接 1:多平台链接,默认为0 | 非必须 | |
platformLink | object [] | 当为多平台链接时传入 | 非必须 | |
├─ terminal | integer | 终端类型 终端:1:PC 2:H5 3: App 4:微信小程序id 5:微信小程序路径 | 必须 | |
├─ link | string | 链接地址 | 必须 | |
button | string | 按钮文案 | 必须 | |
status | integer | 产品状态 1:开启 0:关闭 | 必须 | |
gmtCreate | number | 商品上架时间,单位毫秒 | 必须 |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
删除商品库商品信息
基本信息
Path: https://api.csslcloud.net/api/product/delete
Method: GET
接口描述:
通过该接口可以删除商品库商品信息
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账户id | 账户id |
goodsIds | 是 | 3268,3269 | 商品id,以“,”分割,最多支持批量删除200个 |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ messge | string | 必须 | 错误信息 |
直播间导入商品库商品
基本信息
Path: https://api.csslcloud.net/api/product/room/rel/add
Method: GET
接口描述:
通过该接口可以导入商品库商品
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账户id | 账户id |
productId | 是 | 3268 | 商品id |
roomId | 是 | 直播间id | 直播间id |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
直播间移除商品库商品
基本信息
Path: https://api.csslcloud.net/api/product/room/rel/delete
Method: get
接口描述:
通过该接口可以移除商品库商品
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账户id | 账户id |
productId | 是 | 3268 | 商品id |
roomId | 是 | 直播间id | 直播间id |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
全局商品列表
基本信息
Path: https://api.csslcloud.net/api/product/list
Method: get
接口描述:
通过该接口可以全局商品列表;排序规则:根据商品ID倒序排列
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账户id | 账户id |
kw | 否 | 商品名称 | 商品名称 |
pageNo | 是 | 1 | 页码 |
pageSize | 是 | 20 | 每页大小 |
返回值说明:
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ records | object [] | 非必须 | |||
├─ id | string | 非必须 | 商品id | ||
├─ cover | string | 非必须 | 封面信息 | ||
├─ title | string | 非必须 | 商品名称 | ||
├─ currentPrice | number | 非必须 | 购买价格,单位分 | ||
├─ originPrice | number | 非必须 | 划线价格,单位分 | ||
├─ gmtCreate | number | 非必须 | 产品创建时间,单位:毫秒 | ||
├─ tag | string | 非必须 | 商品标签,多个标签以“,”分割 | ||
├─ status | integer | 非必须 | 商品状态 0:失效 1:生效 | ||
├─ button | string | 非必须 | 按钮文案 | ||
├─ desc | string | 非必须 | 描述 | ||
├─ linkType | integer | 非必须 | 链接类型:0:通用链接 1:多平台链接,默认为0 | ||
├─ platformLink | object [] | 非必须 | 当为多平台链接时传入 | ||
├─ terminal | integer | 必须 | 终端类型 终端:1:PC 2:H5 3: App 4:微信小程序id 5:微信小程序路径 | ||
├─ link | string | 必须 | 链接地址 | ||
├─ pagination | object | 非必须 | 分页信息 | ||
├─ pageNo | integer | 非必须 | 页码 | ||
├─ totalCount | integer | 非必须 | 总条数 | ||
├─ pageCount | integer | 非必须 | 总页数 | ||
├─ pageSize | integer | 非必须 | 每页大小 | ||
error | object | 非必须 | |||
├─ code | integer | 必须 | 错误码 | ||
├─ message | string | 必须 | 错误信息 |
返回示例:
{
"data": {
"records": [
{
"tag": "",
"id": 3803,
"desc": "11",
"status": 1,
"link": "",
"title": "商品名称",
"gmtCreate": 1663923050000,
"cover": "https://t-marketing-image.csslcloud.net/home/ACB026848DEA495B/liveCommodity/1123614197.jpg",
"originPrice": 240000,
"currentPrice": 149900,
"button": "购买",
"linkType": 1,
"platformLink": [
{
"link": "http://console.bokecc.com",
"terminal": 1
}
]
},
{
"tag": "",
"id": 3802,
"desc": "11",
"status": 1,
"link": "",
"title": "商品名称",
"gmtCreate": 1663922699000,
"cover": "https://t-marketing-image.csslcloud.net/home/ACB026848DEA495B/liveCommodity/1123614197.jpg",
"originPrice": 250000,
"currentPrice": 149900,
"button": "购买",
"linkType": 1,
"platformLink": [
{
"link": "http://console.bokecc.com",
"terminal": 1
}
]
}
],
"pagination": {
"pageCount": 3,
"pageNo": 1,
"pageSize": 2,
"totalCount": 5
}
},
"success": true
}
全局商品库列表(包含直播间导入状态)
基本信息
Path: https://api.csslcloud.net/api/product/list/withRel
Method: get
接口描述:
通过该接口可以全局商品列表
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账户id | 账户id |
roomId | 是 | 直播间id | 直播间id |
title | 否 | 商品名称 | |
pageNo | 否 | 1 | 页码,默认为1 |
pageSize | 否 | 20 | 每页大小,默认20个 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | |||
data | object | 非必须 | |||
├─ records | object [] | 非必须 | item 类型: object |
||
├─ id | string | 非必须 | 商品id | ||
├─ cover | string | 非必须 | 封面信息 | ||
├─ title | string | 非必须 | 商品名称 | ||
├─ bind | integer | 非必须 | 导入标记:1-已导入;0-未导入 | ||
├─ currentPrice | number | 非必须 | 购买价格,单位分 | ||
├─ originPrice | number | 非必须 | 划线价格,单位分 | ||
├─ pagination | object | 非必须 | 分页信息 | ||
├─ pageNo | number | 非必须 | 页码 | ||
├─ pageSize | number | 非必须 | 每页大小 | ||
├─ totalCount | number | 非必须 | 总条数 | ||
├─ pageCount | number | 非必须 | 总页数 | ||
error | object | 非必须 | 错误时返回 | ||
├─ code | string | 必须 | |||
├─ meaasge | string | 必须 |
返回示例:
{
"data": {
"pagination": {
"pageCount": 1,
"totalCount": 1,
"pageSize": 10,
"pageNo": 1
},
"records": [
{
"cover": "https://domain/abc.png",
"gmtCreate": 1678945044000,
"id": 1757,
"currentPrice": 100,
"bind": 0,
"title": "测试11",
"originPrice": 100
}
]
},
"success": true
}
直播间-学员端商品列表
基本信息
Path: https://api.csslcloud.net/api/product/room/list
Method: GET
接口描述:
通过该接口可以全局商品列表
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
roomId | 是 | 直播间id | |
pageNo | 否 | 页码,默认为1 | |
pageSize | 否 | 每页大小,默认200个 | |
accountId | 是 | 账户id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
data | object | 非必须 | |||
├─ records | object [] | 非必须 | item 类型: object |
||
├─ id | number | 非必须 | 商品id | ||
├─ cover | string | 非必须 | 封面 | ||
├─ title | string | 非必须 | 标题 | ||
├─ desc | string | 非必须 | 描述 | ||
├─ tag | string | 非必须 | 标签,多个以逗号分隔 | ||
├─ currentPrice | number | 非必须 | 购买价格,单位分 | ||
├─ originPrice | number | 非必须 | 划线价格,单位分 | ||
├─ button | string | 非必须 | 按钮文案 | ||
├─ top | number | 非必须 | 置顶标记:0-未置顶;1-置顶 | ||
├─ push | number | 非必须 | 推送标记:0-未推送;1-推送 | ||
├─ score | number | 非必须 | 序号 | ||
├─ pagination | object | 非必须 | 分页信息 | ||
├─ pageNo | number | 非必须 | 页码 | ||
├─ pageSize | number | 非必须 | 每页大小 | ||
├─ totalCount | number | 非必须 | 总条数 | ||
├─ pageCount | number | 非必须 | 总页数 | ||
error | object | 非必须 | 错误时返回 | ||
├─ code | string | 必须 | |||
├─ meaasge | string | 必须 |
返回示例:
{
"data": {
"pagination": {
"pageCount": 1,
"totalCount": 3,
"pageSize": 200,
"pageNo": 1
},
"records": [
{
"cover": "https://xx-image.xx.net/cover.jpg",
"id": 1141,
"title": "多平台链接",
"originPrice": 29900,
"push": 0,
"top": 0,
"currentPrice": 10000,
"score": 1
},
{
"cover": "https://xx-image.xx.net/cover.jpg",
"id": 1135,
"title": "w3",
"originPrice": 111100,
"push": 0,
"top": 0,
"currentPrice": 1100,
"score": 2
}
]
},
"success": true
}
直播间-商品导入列表(导入 ID倒序)
基本信息
Path: https://api.csslcloud.net/api/product/room/rels
Method: GET
接口描述:
通过该接口可以全局商品列表
接口加密方式:THQS加密
(仅Query参数需THQS加密)
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
roomId | 是 | 直播间id | |
pageNo | 否 | 页码,默认为1 | |
pageSize | 否 | 每页大小,默认200个 | |
accountId | 是 | 账户id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
data | object | 非必须 | |||
├─ records | object [] | 非必须 | item 类型: object |
||
├─ id | number | 非必须 | 商品id | ||
├─ cover | string | 非必须 | 封面 | ||
├─ title | string | 非必须 | 标题 | ||
├─ tag | string | 非必须 | 标签,多个以逗号分隔 | ||
├─ currentPrice | number | 非必须 | 购买价格,单位分 | ||
├─ originPrice | number | 非必须 | 划线价格,单位分 | ||
├─ pagination | object | 非必须 | 分页信息 | ||
├─ pageNo | number | 非必须 | 页码 | ||
├─ pageSize | number | 非必须 | 每页大小 | ||
├─ totalCount | number | 非必须 | 总条数 | ||
├─ pageCount | number | 非必须 | 总页数 | ||
error | object | 非必须 | 错误时返回 | ||
├─ code | string | 必须 | |||
├─ meaasge | string | 必须 |
返回示例:
{
"data": {
"pagination": {
"pageCount": 1,
"totalCount": 1,
"pageSize": 200,
"pageNo": 1
},
"records": [{
"cover": "http://domain/xx.jpg",
"id": 1135,
"currentPrice": 1100,
"tag": "",
"title": "w3",
"originPrice": 111100
}]
},
"success": true
}
删除虚拟聊天
基本信息
Path: https://api.csslcloud.net/api/chatbot/chats/delete
Method: POST
接口描述:
需对query string 进行thqs加密。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
ids | 是 | 983,1822,2399,4677 | 以逗号分隔的多个虚拟聊天id。虚拟聊天id个数至多不可超过100个。 |
accountId | 是 | 998757E82C929B67 | 账号id |
roomId | 是 | 09A84F486C8D519D9C33DC5901307461 | 直播间id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true:成功,false:失败 | ||
error | object | 非必须 | success=false返回此对象 | ||
├─ code | integer | 非必须 | 错误码 | ||
├─ message | string | 非必须 |
查询虚拟聊天
基本信息
Path: https://api.csslcloud.net/api/chatbot/chats/search
Method: GET
接口描述:
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 998757E82C929B67 | 账号id |
roomId | 是 | 09A84F486C8D519D9C33DC5901307461 | 直播间id |
content | 否 | 专心做笔记 | 根据聊天内容模糊匹配 |
pageNo | 是 | 1 | 页码 |
pageSize | 是 | 100 | 每页数据条数,最大不可超过10000 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | 没有记录,返回空数组 | ||
error | object | 非必须 | |||
├─ code | string | 必须 | |||
├─ message | string | 必须 | |||
data | object | 非必须 | |||
├─ pagination | object | 必须 | |||
├─ pageNo | number | 必须 | 页码 | ||
├─ pageSize | number | 必须 | 每页数据条数 | ||
├─ totalCount | number | 必须 | 总数据条数 | ||
├─ pageCount | number | 必须 | 总页码 | ||
├─ records | object [] | 必须 | 没有记录,返回空数组 | item 类型: object | |
├─ senderName | string | 必须 | 昵称 | ||
├─ senderRole | integer | 必须 | 发送人角色。1-主讲,2-助教,3-主持人,4-学员 | ||
├─ time | integer | 必须 | 消息发送的相对时间,单位秒 | ||
├─ senderAvatar | string | 非必须 | 发送人头像 | ||
├─ content | string | 必须 | 发送内容 | ||
├─ barrageColor | string | 非必须 | 十六进格式的弹幕颜色 | ||
├─ id | integer | 必须 | 虚拟聊天id |
添加虚拟聊天
基本信息
Path: https://api.csslcloud.net/api/chatbot/chats/create
Method: POST
接口描述:
需对query string 进行thqs加密。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
roomId | 是 | 09A84F486C8D519D9C33DC5901307461 | 直播间id |
accountId | 是 | 998757E82C929B67 | 账号id |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
object [] | 非必须 | 虚拟聊天json数组。数组长度最大500 | item 类型: object | ||
├─ senderName | string | 必须 | 昵称,最长20个字符 | ||
├─ senderRole | integer | 必须 | 发送人角色,1-主讲,2-助教,3-主持人,4-学员 | ||
├─ time | integer | 必须 | 消息发送的相对时间,单位秒 | ||
├─ senderAvatar | string | 非必须 | 发送人头像。传入该参数时长度小于200 | ||
├─ content | string | 必须 | 发送内容,长度需小于300 | ||
├─ barrageColor | string | 非必须 | 弹幕颜色.合法的十六进制颜色。 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true:成功,false:失败 | ||
error | object | 非必须 | success=false返回此对象 | ||
├─ code | integer | 非必须 | 错误码 | ||
├─ message | string | 非必须 |
编辑虚拟聊天
基本信息
Path: https://api.csslcloud.net/api/chatbot/chats/update
Method: POST
接口描述:
需对query string 进行thqs加密。
更新为全量覆盖更新,故而需传入单条虚拟聊天的所有字段。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
roomId | 是 | 09A84F486C8D519D9C33DC5901307461 | 直播间id |
accountId | 是 | 998757E82C929B67 | 账号id |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
senderName | string | 必须 | 昵称,最长20个字符 | ||
senderRole | integer | 必须 | 发送人角色,1-主讲,2-助教,3-主持人,4-学员 | ||
time | integer | 必须 | 消息发送的相对时间,单位秒 | ||
senderAvatar | string | 非必须 | 发送人头像。传入该参数时长度小于200 | ||
content | string | 必须 | 发送内容,长度需小于300 | ||
barrageColor | string | 非必须 | 弹幕颜色。合法的十六进制颜色 | ||
id | integer | 必须 | 虚拟聊天id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | true:成功,false:失败 | ||
error | object | 非必须 | success=false返回此对象 | ||
├─ code | integer | 非必须 | 错误码 | ||
├─ message | string | 非必须 |
菜单设置
基本信息
Path: https://api.csslcloud.net/api/room/setting/menu
Method: POST
接口描述: 添加菜单
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账号ID |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
roomId | string | 必须 | 直播间ID | ||
name | string | 必须 | 菜单中文名称,只能包含中文、数字、下划线,最大长度为4个字符。 | ||
nameEng | string | 必须 | 菜单英文名称,只能包含英文字母、数字、下划线,最大长度8个字符 | ||
type | string | 必须 |
菜单类型, 1:文档,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 2:聊天,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 3:问答,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 4:图文直播,支持编辑,不支持添加和删除,开启图文直播权限自动添加该菜单 5:简介,支持添加、编辑、删除 ,最多支持添加一个 6:推广外链 7:图文菜单 9:云席,可以添加、编辑、删除, 最多支持添加一个 |
||
content | string | 非必须 | 图文内容,当type=6,该值为URL访问地址 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 必须 | 状态,true:成功,false:失败 |
查询菜单
基本信息
Path: https://api.csslcloud.net/api/room/menus
Method: GET
接口描述: 查询菜单信息
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | DCEBA75B3E076A11 | 账号ID |
roomId | 是 | 2820E0529626B0189C33DC5901307461 | 直播间ID |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | object | 非必须 | |||
├─ menus | object [] | 非必须 |
item 类型: object |
||
├─ index | number | 必须 | 索引排序字段 | ||
├─ nameEng | string | 必须 | 英文名称 | ||
├─ name | string | 必须 | 中文名称 | ||
├─ type | number | 必须 |
>菜单类型, 1:文档,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 2:聊天,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 3:问答,支持编辑,不支持添加和删除,观看端根据模板类型是否展示该菜单 4:图文直播,支持编辑,不支持添加和删除,开启图文直播权限自动添加该菜单 5:简介,支持添加、编辑、删除,最多支持添加一个 6:推广外链 7:图文菜单 9:云席,可以添加、编辑、删除,最多支持添加一个 |
||
success | boolean | 必须 | 状态:true 成功,false :失败 |
菜单删除
基本信息
Path: https://api.csslcloud.net/api/room/menu/delete
Method: GET
接口描述: 删除菜单,删除后观看端看不到菜单
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账号ID | |
roomId | 是 | 房间ID | |
index | 是 | 索引标识,通过接口查询菜单获取 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | 状态,true:成功,false:失败 |
菜单排序
基本信息
Path: https://api.csslcloud.net/api/room/menu/rank
Method: GET
接口描述: 设置观看端菜单顺序,菜单排序后index值越小,在观看端展示在前面
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账号ID | |
roomId | 是 | 直播间ID | |
indexs | 是 | 菜单类型索引,必须是完整的列表(不能多也不能少),表示按该顺序排列菜单【该参数获取查询菜单】 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | 状态,true:成功,false:失败 |
菜单更新
基本信息
Path: https://api.csslcloud.net/api/room/menu/update
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
accountId | 是 | 账号ID |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
index | number | 必须 | 索引排序,唯一标识,通过接口菜单查询获取,备注:根据排序顺序这个值是变化的。 | ||
name | string | 非必须 | 菜单中文名称,只能包含中文、数字、下划线,最大长度为4个字符。 | ||
roomId | string | 必须 | 直播间ID | ||
nameEng | string | 非必须 | 菜单英文名称,只能包含英文字母、数字、下划线,最大长度8个字符 | ||
content | string | 非必须 | 菜单内容, 如果Type=6 推广外链。则此值为URL地址。 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | string | 必须 | true:成功,false:失败 |