HTTP接口

创建直播间

通过该接口可以创建直播间，接口请求地址为：

https://api.csslcloud.net/api/room/create

需要传递以下参数：

参数 说明 备注
userid CC账户ID
name 直播间名称，最大字符40 标题头尾的空格字符会自动删除
desc 直播间描述，最大字符5000
templatetype 直播模板类型，请求模板信息接口可获得模板类型的详细信息。
authtype 验证方式，0：接口验证，需要填写下面的checkurl；1：密码验证，需要填写下面的playpass；2：免密码验证
publisherpass 推流端密码，即讲师密码
assistantpass 助教端密码
playpass 播放端密码 可选
checkurl 验证地址 可选
barrage 是否开启弹幕。0：不开启；1：开启 可选，默认为0
foreignpublish 是否开启第三方推流。0：不开启；1：开启 可选，默认为0，开启时必须开启网页登录的主持人模式，支持模板类型1、2、3、6
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个字符
manuallyrecordmode 手动录制模式。0：关闭；1：开启 可选，默认关闭
clientdocpermissions 讲师文档权限。0：关闭；1：开启 可选，默认关闭；
repeatedloginsetting 重复登录设置；0：允许后进入者登录;1:禁止后进入者登录，对讲师端和观看端生效 可选，默认0
maxaudiencenum 直播间并发人数上限 可选，默认为0，表示不做限制
documentdisplaymode 文档显示模式。1：适合窗口;2:适合宽度 可选，适合窗口
openlivecountdown 倒计时功能。0：关闭；1：开启 可选，默认关闭
showlectueronlinenum 讲师端显示在线人数。0：不显示；1：显示 可选，默认显示
showassistonlinenum 助教主持人端显示在线人数。0：不显示；1：显示 可选，默认显示
openmarquee 跑马灯功能。0：关闭；1：开启 可选，默认为0
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:隐藏
rebroadcastSwitch 是否打开转播开关。0:关闭，1:打开 可选，默认0:关闭
rebroadcastType 转播类型，sender:发送转播直播间，receiver:接收转播直播间。转播开关值为1时，该参数是必选参数 可选，默认receiver:接收转播直播间
rebroadcastMode 转播直播间的转播模式。single:单师，double:双师。转播开关值为1时，该参数是必选参数 可选，默认single:单师
rebroadcastReceivers 接收转播直播间id列表；有多个时用逗号分隔 可选，默认为空
rebroadcastRecording 接收直播间是否录制 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：免密码验证 可选
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个字符
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：开启 可选
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:隐藏
rebroadcastSwitch 转播直播间的转播开关值。该项配置不可更改。0:关闭，1:打开。 可选，默认0:关闭。注：如果更新转播直播间的rebroadcastReceivers或rebroadcastRecording参数时，该参数是必须，并且值为1
rebroadcastType 当前直播间的转播类型，该项配置不可更改。sender:发送转播直播间，receiver:接收转播直播间。转播开关值为1时，该参数是必选参数 可选，默认receiver:接收转播直播间，注：如果更新转播直播间的rebroadcastReceivers或rebroadcastRecording参数时，该参数是必须，并且值为当前直播间的转播类型
rebroadcastMode 当前转播直播间的转播模式。该项配置不可更改。single:单师，double:双师。转播开关值为1时，该参数是必选参数 可选，默认single:单师，注：如果更新转播直播间的rebroadcastReceivers或rebroadcastRecording参数时，该参数是必须，并且值为当前直播间的转播模式
rebroadcastReceivers 接收转播直播间id列表；有多个时用逗号分隔 可选，默认为空
rebroadcastRecording 接收转播房间是否录制 0:关闭，1:开启 可选，默认0:关闭

JSON格式的返回信息如下：

{
  "result": "OK"
}

获取直播间信息

通过该接口可以获取直播间的信息，接口请求地址为:

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：开启
warmVideoId 插播暖场视频，为空，表示关闭
liveStartTime 直播开始时间
playerBackgroundHint 播放器提示语
manuallyRecordMode 手动录制模式。0：关闭：开启
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个字符
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.云课堂;
rebroadcast 转播信息

rebroadcast包含以下字段：

字段名 说明
switch 转播开关。0未开启转播，1开启转播。
type 转播类型。sender发送转播直播间，receiver接收转播直播间。
mode 转播模式。single单师，double双师。
recording 接收转播直播间是否录制。0不录制，1录制。
receivers 发送直播间所关联的所有的接收直播间。直播间id以逗号分隔。当转播类型为sender时，才会返回该信息

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",
    "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
    ],
    "rebroadcast": {
      "switch": 1,
      "type": "sender",
      "mode": "single",
      "receivers": "000F94FA465E033A9C33DC5901307461,B37923D9954656839C33DC5901307461"
    }
  }
}

转播接受直播间列表

查询转播接收直播间列表。创建转播房间时，查询可关联接收房间信息；编辑房间时，查询当前已关联和可关联的接收播间信息。

备注：发送房间可关联的接收房间必须是与发送房间模版相同、未被删除和未被关联的房间。

https://api.csslcloud.net/api/v1/rebroadcast/receivers

需要传递以下参数：

参数名称 是否必须 示例 备注
accountId 是 C783F0F7CB77E1F3 账户ID
template 是 1 直播间模版id
mode 是 onUpdate 查询模式，创建转播房间该参数为“onCreate”，编辑转播房间该参数为“onUpdate”
rebroadcastMode 是 single 转播模式。single单师，double双师。
pageNo 是 1 分页参数，第几页。
pageSize 是 10 分页参数，每页展示条数。
roomId 否 F951EC79E04F019B9C33DC5901307461 发送房间id。mode为onUpdate时该参数为必须。
query 否 123 模糊查询。支持根据直播间id或直播间名称模糊匹配。

返回数据：

名称类型是否必须默认值备注其他信息
successboolean
必须
dataobject
非必须
roomsobject []
非必须

item 类型: object

associatedboolean
非必须
是否已关联当前发送房间。true表示已关联，false表示未关联。
idEncryptstring
必须
直播间id
namestring
必须
直播间名称
pageobject
必须
totalCountnumber
必须
总记录数
pageCountnumber
必须
总页数
pageNonumber
必须
当前页
pageSizenumber
必须
每页条数