伪直播接口说明文档

版本：1.0.3
日期：2021年05月20日

通信约定

参考：https://doc.bokecc.com/live/developer/live_api/live_apiOverview.html

创建伪直播直播间

基本信息

接口地址： http://api.csslcloud.net/api/room/create

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
userid 是 CC账户ID
name 是 直播间名称，最大字符40
desc 否 直播间描述，最大字符5000
templatetype 是 1 直播模板类型，请求模板信息接口可获得模板类型的详细信息。
authtype 是 0 验证方式，0：接口验证，需要填写下面的checkurl；1：密码验证，需要填写下面的playpass；2：免密码验证
assistantpass 是 123456 助教端密码
playpass 否 123456 播放端密码
checkurl 否 http://www.validate.com 验证地址
foreignpublish 是 1 推流模式。0：客户端推流；1：第三方推流 ，2:回放推流 3:点播推流 ；伪直播请选择2或3
livestarttime 是 2020-01-01 00:00:00 直播开始时间；格式：yyyy-MM-dd HH:mm:ss
可选，默认为空；当选择为回放推流或点播推流时，必填，且该值需大于当前时间1小时；
若同时开启了点播推流控制权限，则该值需大于当前时间15分钟。
pseudoNeedRecord 否 1 回放/点播推流是否自动录制 0：不开启；1：开启 当推流方式为回放/点播推流时，该参数有效， 默认为 开启
pseudoSourceId 是 EB84B8907FA0EAFB 回放/点播推流的资源ID；点播推流时该值为视频ID，回放推流时该值为回放ID；资源状态必须为可用；回放推流时两者模板需匹配；点播/回放推流时该字段必传。
pseudoUserName 是 张三 回放/点播推流的讲师昵称；最大字符限制为20；点播/回放推流时该字段为必传。
vodPushingDefinition 否 20 点播推流指定清晰度。未开启点播推流控制权限时，该参数无效；开启点播推流控制权限时(技术支持配置)，可不传，系统会匹配视频可用的最高清晰度；手动指定时传入值需参考/api/pseudo/videos接口；
pseudoLiveStopTime 否 2020-01-01 12:00:00 回放推流或点播推流时直播结束时间。
1.直播结束时间-直播开始时间<=24小时且>=10分钟;
2.直播结束时间-直播开始时间的时长大于回放或点播视频的时长时，将发起多场直播，每场直播间隔5秒以内；
pseudoNeedChat 否 0 伪直播是否发送回放聊天 1.是; 0.否(默认) 当推流方式为回放推流时，该参数有效， 默认为 0
openchatmanage 否 1 开启聊天审核。0：不开启；1：开启 ，可选，默认为0
showusercount 否 0 在页面显示当前在线人数。0：不显示；1：显示 可选，默认为0
warmvideoid 否 插播暖场视频，填写同一账号下云点播视频vid
可选，默认关闭；参数值为空，表示关闭
barrage 否 0 是否开启弹幕。0：不开启；1：开启， 默认0
playerbackgroundhint 否 播放器提示语。未直播时播放器将显示该提示语
可选，最多15个字符
repeatedloginsetting 否 0 重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
maxaudiencenum 否 0 直播间并发人数上限 可选，默认为0，表示不做限制
documentdisplaymode 否 1 文档显示模式。1：适合窗口;2:适合宽度 可选，默认适合窗口
openlivecountdown 否 0 直播倒计时功能，可选，默认关闭
showassistonlinenum 否 1 助教主持人端显示在线人数。0：不显示；1：显示 可选，默认显示
openmarquee 否 1 跑马灯功能。0：关闭；1：开启 可选，默认为0
hideexitbutton 否 0 隐藏观看端退出按钮。0：不开启；1：开启
openTextPicLive 否 1 移动H5页面是否显示图文直播。0：隐藏；1：显示 可选，默认为0 （需开通权限）

返回数据

名称类型是否必须默认值备注其他信息
resultstring必须
roomobject非必须
├─ idstring非必须直播间id
├─ publishUrlsstring []非必须推流地址，第三方推流的直播间可以获取到此参数

item 类型: string

├─ 非必须

查询直播间信息

基本信息

接口地址： http://api.csslcloud.net/api/room/search

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
userid 是 ECB81750584E9A75 CC账户id
roomid 是 F26CB70F3F971A609C33DC5901307461 直播间id
名称类型是否必须默认值备注其他信息
result string 非必须 "OK"/"FAIL"
room object 非必须
├─ id string 必须 直播间ID
├─ name string 必须 直播间名称
├─ desc string 必须 直播间描述
├─ status number 必须 直播间状态
├─ publisherPass string 必须 推流端登录密码
├─ playPass string 必须 学员登录密码
├─ assistantPass string 必须 助教端密码
├─ checkUrl string 必须 接口验证地址
├─ templateType number 必须 模板
├─ authType number 必须 登录验证方式
├─ barrage number 必须
├─ publishUrls string [] 必须 推流地址

item 类型: string
├─ 非必须
├─ openLowDelayMode string 必须 是否开启低延迟模式
├─ delayTime string 必须 延时时间，单位秒。低延时模式下该值为0.
├─ showUserCount string 必须 显示在线人数
├─ openHostMode string 必须 是否开启主持人模式
├─ hostLoginMode string 必须 主持人登录模式 网页登录/客户端登录
├─ foreignPublish number 必须 推流模式
├─ warmVideoId string 必须 暖场视频ID
├─ liveStartTime string 必须 直播开始时间
├─ playerBackgroundHint string 必须 播放器提示语。未直播时播放器将显示该提示语
├─ manuallyRecordMode string 必须 手动录制模式。0：关闭；1：开启
├─ clientDocPermissions string 必须 讲师文档权限。0：关闭；1：开启 可选，默认关闭；
├─ openMarquee string 必须 跑马灯功能。0：关闭；1：开启 可选，默认为0
├─ repeatedLoginSetting string 必须 重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
├─ maxAudienceNum string 必须 直播间并发人数上限 可选，默认为0，表示不做限制
├─ openTextPicLive string 必须 移动H5页面是否显示图文直播。0：隐藏；1：显示 可选，默认为0 （需开通权限）
├─ documentDisplayMode string 必须 文档显示模式。1：适合窗口;2:适合宽度 可选，默认适合窗口
├─ openLiveCountdown string 必须 直播倒计时功能，可选，默认关闭
├─ alarms string 必须 直播提醒设置，格式如下：[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点（单位：分钟），类型为字符串，取值范围1-1000的整数；desc为提醒内容，类型为字符串，最多20个字符可选，默认为空
├─ openChatManage string 必须 开启聊天审核。0：不开启；1：开启 ，可选，默认为0
├─ showLectuerOnlineNum string 必须 讲师端显示在线人数。0：不显示；1：显示 可选，默认显示
├─ showAssistOnlineNum string 必须 助教主持人端显示在线人数。0：不显示；1：显示 可选，默认显示
├─ hideExitButtonFlag string 必须 隐藏观看端退出按钮
├─ pseudoNeedRecord string 非必须 伪直播推流是否需要录制 0否 1：是
├─ pseudoSourceId string 非必须 伪直播推流资源ID
├─ pseudoUserName string 非必须 伪直播客户端登录名
├─ pseudoLiveStopTime string 非必须 伪直播结束时间
├─ pseudoNeedChat number 非必须 伪直播是否发送回放聊天 1.是; 0.否
├─ vodPushingDefinition string 非必须 点播推流指定清晰度

编辑直播间

基本信息

接口地址： http://api.csslcloud.net/api/room/update

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
userid 是 CC账户ID
roomid 是 直播间id
name 否 直播间名称
desc 否 直播间描述，最大字符5000
templatetype 否 1 直播模板类型，请求模板信息接口可获得模板类型的详细信息。
authtype 否 0 验证方式，0：接口验证，需要填写下面的checkurl；1：密码验证，需要填写下面的playpass；2：免密码验证
publisherpass 否 123456 讲师端密码 回放推流/点播推流 非必填
assistantpass 否 123456 助教端密码
playpass 否 123456 播放端密码
checkurl 否 http 验证地址
barrage 否 0 是否开启弹幕。0：不开启；1：开启， 默认0
openlowdelaymode 否 1 是否开启低延迟模式
openchatmanage 否 1 开启聊天审核。0：不开启；1：开启 ，可选，默认为0
showusercount 否 0 在页面显示当前在线人数。0：不显示；1：显示 可选，默认为0
warmvideoid 否 暖场视频ID
livestarttime 否 2020-01-01 00 直播开始时间；格式：yyyy-MM-dd HH:mm:ss
可选，默认为空；当选择为回放推流或点播推流时，必填，且该值需大于当前时间1小时；
若同时开启了点播推流控制权限，则该值需大于当前时间15分钟。
playerbackgroundhint 否 播放器提示语。未直播时播放器将显示该提示语
可选，最多15个字符
manuallyrecordmode 否 1
clientdocpermissions 否 1 讲师文档权限。0：关闭；1：开启 可选，默认关闭；
repeatedloginsetting 否 0 重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效
maxaudiencenum 否 0 直播间并发人数上限 可选，默认为0，表示不做限制
documentdisplaymode 否 1 文档显示模式。1：适合窗口;2:适合宽度 可选，默认适合窗口
openlivecountdown 否 0 直播倒计时功能，可选，默认关闭
showlectueronlinenum 否 1 讲师端显示在线人数。0：不显示；1：显示 可选，默认显示
showassistonlinenum 否 1 助教主持人端显示在线人数。0：不显示；1：显示 可选，默认显示
openmarquee 否 1 跑马灯功能。0：关闭；1：开启 可选，默认为0
hideexitbutton 否 0 隐藏观看端退出按钮。0：不开启；1：开启
alarms 否 直播提醒设置，格式如下：[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点（单位：分钟），类型为字符串，取值范围1-1000的整数；desc为提醒内容，类型为字符串，最多20个字符可选，默认为空
openTextPicLive 否 移动H5页面是否显示图文直播。0：隐藏；1：显示 可选，默认为0 （需开通权限）
pseudoNeedRecord 否 1 回放/点播推流是否自动录制 0：不开启；1：开启 当推流方式为回放/点播推流时，该参数有效 默认为、开启
pseudoSourceId 否 EB84B8907FA0EAFB 回放/点播推流的资源ID；点播推流时该值为视频ID，回放推流时该值为回放ID；资源状态必须为可用；回放推流时两者模板需匹配；点播/回放推流时该字段必传。
pseudoUserName 否 张三 回放/点播推流的讲师昵称；最大字符限制为20；点播/回放推流时该字段为必传。
vodPushingDefinition 否 20 点播推流指定清晰度。使用点播推流且开启点播推流控制权限时，该字段必传，且值不可超过配置的最高清晰度。
pseudoLiveStopTime 否 2020-01-01 12:00:00 回放推流或点播推流时直播结束时间。
1.直播结束时间-直播开始时间<=24小时且>=10分钟;
2.直播结束时间-直播开始时间的时长大于回放或点播视频的时长时，将发起多场直播，每场直播间隔5秒以内；
pseudoNeedChat 否 0 伪直播是否发送回放聊天 1.是; 0.否 当推流方式为回放推流时，该参数有效

返回数据

名称类型是否必须默认值备注其他信息
resultstring必须OK

查询点播视频推流可用清晰列表

基本信息

接口地址： http://api.csslcloud.net/api/pseudo/videos

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
accountId 是 ECB81750584E9A75 CC账户id
sourceId 是 F26CB70F3F971A609C33DC5901307461 视频id
名称类型是否必须默认值备注其他信息
success boolean 必须 true/false
data object 非必须
├─ vodPushingRestrict number 非必须 点播推流清晰度上限值
├─ videos object[] 非必须 该视频的清晰度列表
├─ definitionlevel number 非必须 清晰度code值
├─ definitiondesc string 非必须 清晰度描述