创建直播间

更新时间：2022-12-28

接口描述

该接口用于创建直播间   

请求地址

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

请求方式

GET 

请求参数

接口统一权限认证请参考THQS认证方式。

名称	类型	必填	描述
userid	String	是	开发者账号ID
name	String	是	直播间名称，不支持表情符，取值范围：长度为1~100个字符
publisher_authtype	Integer	否	讲师认证方式，取值说明：0为接口验证，1为密码，2为免密码，接口认证规则参考，默认1，取值范围：[0,1,2]
publisherpass	String	否	讲师端密码，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID， 当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
assist_switch	Integer	否	助教开关，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
assist_authtype	Integer	否	助教认证方式，取值说明：0为接口验证，1为密码，2为免密码，接口认证规则参考，默认1，取值范围：[0,1,2]
assist_pass	String	否	助教端密码，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID， 当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
viewer_authtype	Integer	否	旁听、回放认证方式，仅互动模式下生效，取值说明：0为接口验证，1为密码，2为免密码，接口认证规则参考，默认1，取值范围：[0,1,2]
viewer_pass	String	否	旁听、回放密码，仅互动模式下生效，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID， 当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
audience_authtype	Integer	否	旁听、回放认证方式，非互动模式下生效，取值说明：0为接口验证，1为密码，2为免密码，接口认证规则参考，默认1，取值范围：[0,1,2]
audience_pass	String	否	旁听、回放密码，非互动模式下生效，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID， 当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
talker_authtype	Integer	否	学员认证方式，取值说明：0为接口验证，1为密码，2为免密码，3为白名单验证，接口认证规则参考，默认1，取值范围：[0,1,2]
talker_pass	String	否	学员认证密码，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID，当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
inspector_authtype	Integer	否	隐身者认证方式，取值说明：0为接口验证，1为密码，2为免密码，接口认证规则参考，默认1，取值范围：[0,1,2]
inspector_pass	String	否	隐身者认证密码，当认证方式为免密码时不填，其余情况不填默认为开发者账号ID， 当认证方式为接口认证时，此处填写接口认证地址，取值范围：长度为1~256个字符
white_list	String	否	学员白名单数据，当talker_authtype为3时生效，说明：格式为JSON字符串，示例："{"username": "password","username1":"password1"}，取值范围：长度为1~2000
desc	String	否	直播间简介，不支持表情符，取值范围：长度为1~10000个字符
templatetype	Integer	否	模版类型，取值说明：1为简约模式，2为主讲布局，4为宫格布局，16为双师模式，32为互动模式（互动模式需要配合layout_mode参数使用），详见：名词说明，默认0，取值范围：[1,2,4,16,32]
layout_mode	Integer	否	布局模式，该参数模板类型为互动模式有效，取值说明：0为互动模式-1vN，1为互动模式-1v1（16:9），2为互动模式-1v1（4:3），4为互动模式-研讨会， 默认0，取值范围:[0,1,2,4]
mergetype	Integer	否	合流回放视频布局， 取值说明：1为主视频模式，2为视频平铺模式，3为覆盖模式，4为共享视频模，6为1v1视频纵向平铺模式，默认1，详见：名词说明，取值范围：[1,2,3,4,6]
max_streams	Integer	否	最大实际连麦人数， 默认为开发者账号设置最高连麦数，不能超过账户允许上限，取值范围：[2,16]
classtype	Integer	否	连麦模式，取值说明：1为点名，2为自由，3为自动，模板类型为互动模式时默认3（仅支持自动模式），其余默认1，取值范围：[1,2,3]
presenter_out	Boolean	否	讲师单一用户登录，直播中无效（直播中不会执行老师后踢前），默认为false，取值范围：[true,false]
light_mark	Integer	否	跑马灯，该参数不适配互动模式，取值说明：0为关闭，1为开启可选， 默认0，取值范围：[0,1]
show_exit	Integer	否	页面是否显示退出按钮，该参数不适配互动模式，取值说明：0为隐藏，1为显示， 默认1，取值范围：[0,1]
ppt_display	Boolean	否	ppt显示样式，该参数不适配互动模式，取值说明：0为适应窗口，1为适应宽度，默认0，取值范围：[0,1]
manual_record	Integer	否	手动录制，该参数不适配互动模式，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
warm_open	String	否	暖场视频，该参数不适配互动模式，取值说明："0"为关闭，"1"为开启，默认"0"，取值范围：["0","1"]
schedule_switch	Integer	否	预设直播开关，取值说明：0为关闭，1为开启， 默认0，取值范围：[0,1]
schedule_live_start	String	否	预设直播开始时间，此参数只做展示用，格式:yyyy-MM-dd HH:mm:ss，示例:"2022-12-11 00:00:00"
schedule_live_end	String	否	预设直播结束时间，此参数只做展示用，格式:yyyy-MM-dd HH:mm:ss，示例:"2022-12-11 00:00:00"
brush_save_display	Integer	否	控制web是否显示画笔保存按钮，该参数不适配互动模式，取值说明：1为开启，0为关闭， 默认1，取值范围：[0,1]
share_desktop_display	Integer	否	控制web是否显示桌面共享，该参数不适配互动模式，取值说明：1为开启，0为关闭，默认1，取值范围：[0,1]
toolbox_switch	String	否	工具箱功能设置，该参数不适配互动模式，例:只开启桌面共享与点名则填写:"1，3"，取值说明：1为桌面共享，2为答题卡，3为点名，4为头脑风暴，5为投票，6为计数器，7为循环连麦，8为辅助摄像头，9为批量上麦可选, 默认全部开启"1，2，3，4，5，6，7，8，9"
allow_all_presenter_role	Integer	否	允许Web端学员拥有讲师权限，该参数不适配互动模式，取值说明：0为关闭，1为开启， 默认0，取值范围：[0,1]
background_id	Integer	否	背景图片id，该参数仅互动模式有效，background_id获取：创建图片，默认1
room_resolution	Integer	否	直播间分辨率，取值范围：240为默认，480为标清，720为高清，1080为全高清，默认为账号级别的初始化分辨率，取值范围：[240,480,720,1080]
desktop_share_default_hide	Integer	否	桌面共享打开默认最小化，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
auto_up	Integer	否	是否自动上麦，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
class_timeout	Integer	否	拖堂时间(schedule_switch为1时，且schedule_live_end不为空时有意义)，满足schedule_live_end字段的设置时间，且讲师在直播间内触发关闭逻辑，该参数仅互动模式有效，默认-1，取值范围：1-100(分钟)
class_timeout_close	Integer	否	超时强制结束直播并关闭直播间开关，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
class_timeout_close_time	Integer	否	超时强制结束直播并关闭直播间时间（class_timeout_close为1时有意义，schedule_live_end过后达到设置时间且讲师没在直播间内关闭，默认10，取值范围：1-100（分钟）
playback_retain_time	Integer	否	回放时效设置，该参数仅互动模式有效，默认永久有效，取值范围：7-999（天）
classover_time_open	Integer	否	下课倒计时开关，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
classover_time	Integer	否	倒计时时间，下课倒计时设置开启起作用，默认1，取值范围：1~1000
classover_tips	String	否	下课倒计时提示语，下课倒计时设置开关开启起作用，取值范围：长度为1~100个字符
translate	Integer	否	聊天区翻译设置，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
big_room	Integer	否	直播间类型，该参数仅互动模式有效，取值说明：1为普通直播间最大支持700互动，2为大直播间支持万人互动，默认1，取值范围：[1,2]
default_allow_draw	Integer	否	互动者默认授权画笔，该参数仅互动模式有效，取值说明：0为默认不授权，1为默认授权，默认0，取值范围：[0,1]
in_out_sound	Integer	否	进出提示音，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
max_talker_limit	Integer	否	直播间最大学员限制，互动模式非大直播间类型有效 ，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
max_talker_limit_count	Integer	否	直播间最大学员限制数量，互动模式非大直播间类型有效，默认6，取值范围：不可大于账号最大人数
private_chat	Integer	否	是否开启私聊，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
switch_background	Integer	否	应用在后台运行，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
allow_upload	Integer	否	是否允许文档库/媒体库上传文件，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
playback_record	Integer	否	是否开启回放录制，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
disabled_talker_video	Integer	否	禁止学员（嘉宾）关闭自己摄像头开关，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
disabled_talker_audio	Integer	否	禁止学员（嘉宾）关闭自己麦克风开关，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
allow_hands	Integer	否	是否允许学员举手刷新，该参数仅互动模式有效，仅互动模式生效，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
assist_switch	Integer	否	助教进教室前自检功能，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
sound_quality	Integer	否	音质选择，该参数仅互动模式有效，取值说明：0为流畅，1为高音质，默认0，取值范围：[0,1]
wheat_condition	Integer	否	连麦条件控制，该参数仅互动模式有效，取值说明：0为必须开启麦克风和摄像头，1为必须开启摄像头，2为必须开启麦克风，默认0，取值范围：[0,1,2]
allow_page_switch	Integer	否	授权后允许学员翻页PPT，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认1，取值范围：[0,1]
support_camera	Integer	否	辅助摄像头开关，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
mirror_mode	Integer	否	观看端视频是否镜像，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]
assistant_stealth	Integer	否	助教在花名册中不显示，该参数仅互动模式有效，取值说明：0为关闭，1为开启，默认0，取值范围：[0,1]

请求示例

GET https://ccapi.csslcloud.net/api/room/create?userid=41E8063FC799ACE&name=xxx&time=1670412026&hash={hash}

返回数据

公共返回数据结构请参考 公共返回数据说明。

返回示例

{
    "result": "OK",
    "data": {
        "roomid": "0334B1B7EB80CA509C33DC5901307461"
    }
}