创建房间

Example

POST roomcreate

https://global.talk-cloud.net/WebAPI/roomcreate

Request

参数

参数名	是否必选	类型	说明
key	是	text	企业Key：（预设：5NIWjlgmvqwbt494）
roomname	是	text	房间名：如果有中文请使用UTF8编码，特殊字符需使用urlencode 转义
roomtype	是	int	房间类型：0：1对1；3：1对多 7:超级大班课（需要系统管理员开启）5:直播带货
starttime	是	int	房间开始时间：(UTC时间戳,精确到秒), 例：1429242959
endtime	是	int	房间结束时间：(UTC时间戳,精确到秒), 例：1429242959
chairmanpwd	是	text	老师密码：4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
assistantpwd	是	text	助教密码：4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
patrolpwd	是	text	巡课密码：4=<长度<=16旁听生学生助教巡课老师各个身份密码不能相同
passwordrequired	否	int	学生进入房间是否需要：0：否；1：是
confuserpwd	否	text	学生密码：passwordrequired = 1 时必填(4 位以上)或者allowsidelineuser = 1 时必填，旁听生学生助教巡课老师各个身份密码不能相同
auditorsrequired	否	int	旁听生进入房间是否需要密码：0：否；1：是
auditorspwd	否	text	旁听生：auditorsrequired = 1 时必填(4 位以上) 直播课不允许旁听生进入，旁听生学生助教巡课老师各个身份密码不能相同
videotype	否	int	视频分辨率：0：240x180（默认）；1：320x240；2：640x480；3：1280x720 ；4：1920x1080；6: 960x540；7: 640x360；8: 320x180；9：160x120
videoframerate	否	int	视频帧率：10,15,20,25,30
autoopenav	否	int	上课后自动开启音视频：0：不开启；1：自动开启 roomtype=7时类型忽略传值默认不开启（使用此参数时autoopenaudio和autoopenvideo的参数传值不会生效，三个参数均不传则默认使用企业配置中的相关设置）
autoopenaudio	否	int	上课后自动开启音频：0：不开启；1：自动开启 roomtype=7时类型忽略传值默认不开启（使用autoopenav参数时不生效，3.8.0之下的版本单独设置不生效且当此参数传值为1时autoopenvideo参数传值自动同步为1）
autoopenvideo	否	int	上课后自动开启视频：0：不开启；1：自动开启 roomtype=7时类型忽略传值默认不开启（使用autoopenav参数时不生效，3.8.0之下的版本单独设置不生效且当此参数传值为1时autoopenaudio参数传值自动同步为1）
ismp4record	否	text	是否录制mp4：0：不录制；1：录制（当公司有渲染录制或课后录制时，此条件才会起作用,并且该参数仅限于小班课类型 （roomtype=7时不生效）
colour	否	text	教室皮肤颜色值：紫色值填写：purple；黑色值填写：black；橘色值填写：tigerlily；针对企业开启3.0超越模板设定,全部小写 大班课默认黑色忽略传值
roomlayout	否	int	教室布局。一对多教室布局：1视频置顶（默认）/2视频置底/3视频围绕/4主讲模式/6主讲视频/7自由视频/10视频居左（4.1.1.X版本以上以上适用）/11主讲居左（4.1.1.X版本以上以上适用）； 一对一教室布局：51视频居右（默认）/52双师布局/53视频布局/54视频居左（3.6.0版本以上适用）； 超级大班课教室布局：3视频居右（默认）/8课件全屏布局/9视频全屏布局/12视频居左 /13(1v1)伪上台布局
thirdroomid	否	string	用户自定义房间号：选填如果用户创建房间时自定义了房间号,可使用此字段
toplimit	否	int	设置学生人数上限 (不建议用)
support_connection	否	int	是否支持连麦（roomtype=7时支持）： 0不支持，1支持
openanalyze	否	int	是否开启学情分析（1开启2不开启;企业开启了此配置，传1开启才会生效;如果企业开启了，此参数没有传，则默认开启）
isOpenRecordSegment	否	int	是否开启精彩片段 0不开启 1开启 默认值 ：0 不开启 1开启（需要超管开了“允许企业生成精彩瞬间”，不然是不生效的）
tea_dual_cameras	否	int	老师双摄 0：不使用，1：使用。默认值：0 支持：一对一、一对多、大班课。支持布局：一对一：视频置顶、视频置底。一对多：视频置顶、视频置底。大班课：视频居右、视频居左
stu_dual_cameras	否	int	学生双摄 0：不使用，1：使用。默认值：0 支持：一对一、一对多、大班课。支持布局：一对一：视频置顶、视频置底。一对多：视频置顶、视频置底。大班课：视频居右、视频居左
appstudentsshowpage	否	int	移动端学生视频显示方式，是否翻页显示（每页6路学生视频），0：否，1：是。（不传此参数使用企业默认设置的，仅当对应配置开启时生效）
classlogourl	否	string	教室logo链接地址(字符不能超过128)
roomthemeid	否	int	教室主题ID，使用此参数则原colour参数失效
group	否	int	是否开启分组 0不开启 1开启 分组 后台开启分组配置项 该参数才能生效 只能在一对多教室中使用 该参数不能和老师双摄，学生双摄，只显示老师和自己视频参数不能同时使用
rtmp_pushurl	否	string	rtmp转推地址(字符不能超过256) 后台收费配置项，开启后才可以使用
watermark	否	int	是否开启水印（roomtype=7时支持）0：不开启 1：开启 默认值：0
watermark_position	否	int	水印位置（roomtype=7时支持） （1：左上角 2：左下角 3：右上角 4：右下角）默认值：1
watermark_path	否	file	水印图片资源（roomtype=7时支持）
introduction	否	string	直播简介（roomtype=7时支持）
watermark_opacity	否	int	水印不透明度 1-100（roomtype=7时支持） 默认值：100
is_mockroom	否	int	是否是模拟课堂，0否（默认）/1是
live_pull_type	否	int	直播延迟类型（roomtype=7时支持），默认0普通直播≈3秒，1快直播≈1秒（收费与普通直播不同）
rtmp_external_source	否	int	是否使用外部媒体源 0:否 1:是
open_uploadfile	否	int	是否开启教室内上传课件功能 0:否 1:是 默认：1
subtitle	否	int	付费功能：是否开启字幕功能 0:否 1:是 默认：0 支持版本：4.11.4以上（含4.11.4）
tea_subtitle_language	否	int	付费功能：老师讲课口语。默认：zh-CN（中文简体）支持语种见：https://document.talk-cloud.com/classroom/api/subtitleSupportLanguage/
stu_subtitle	否	int	付费功能：学生字幕语种 1:语音翻译 2:语音识别 默认：1
user_microphone	否	int	用户上台后默认闭麦，0否（默认）/1是，仅限超级大班课有效
screen	否	string	是否开启监课截图 0：不开启 1：开启 默认：1 需联系超管开启该功能
virtual_bg_id	否	int	虚拟背景ID
rewardtitle_group_id	否	int	称号组ID（通过接口/WebAPI/rewardTitleGroup获取）

Response

参数名	类型	说明
result	int	返回状态码：0：正常
serial	string	房间号

ReturnJson

返回示例

  {
    "result": 0,
    "serial": 123123132
  }

错误码说明