创建房间

Example

POST roomcreate

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

参数

参数名 是否必选 类型 说明
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:200x150(默认);1:320x240;2:640x480;3:1280x720 ;4:1920x1080;5: 80X48;6: 960X540;7: 640X360;8: 320X180;9:160X120;10 80X60
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开启才会生效;如果企业开启了,此参数没有传,则默认开启)
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:是
参数名 类型 说明
result int 返回状态码:0:正常
serial string 房间号

返回示例

1
2
3
4
  {
    "result": 0,
    "serial": 123123132
  }

错误码 说明
1001 TalkAuth 权限校验失败
1002 必要参数不全
3003 教室被删除或过期
4001 公司不存在
4002 用户名密码错误
4003 教室名必填
4005 开始时间大于结束时间或结束时间不能小与当前时间
4006 老师密码格式错误
4007 教室ID或ThirdRoomId错误,查询不到教室
4010 助教/巡课密码格式错误
4013 thirdroomid已存在
4014 教室类型不再支持变更操作
4015 查询时间不能为空或查询时间范围不能大于31天
4101 验证企业Key错误
4105 没有符合的数据
4106 上传的文件格式不正确
4108 企业没有开通“前景图”配置项、创建企业权限校验失败或者没有开启创建子企业的配置项、设置企业属性时企业不存在
4114 企业订购套餐没有此分辨率
4115 企业没有开通“创建大班课”配置项
4116 企业没有开通“创建一对一教室”配置项
4117 企业没有开通“创建一对多教室”配置项
4118 企业不可使用此接口,有问题请联系拓课商务
4119 客户端版本(sdk)太低,不能进入双摄教室
4305 无匹配数据
5000 学生密码必须
5002 老师密码必须
5003 旁听密码和旁路直播密码其中必现有一个不能为空
5004 开始结束时间必须
5006 学生密码格式错误
5007 旁听密码格式错误
5010 最大旁听用户数格式错误
5011 最大旁听用户数超过限制
5012 最大视频数格式错误
5013 最大视频数超过限制
5016 视频分辨率参数格式错误
5017 教室布局格式错误
5018 助教密码必须
5019 巡课密码必须
5020 视频分辨率参数格式错误
5023 教室主题选择异常
5024 当前企业未开启自定义PC客户端虚拟背景配置
5025 创建的虚拟背景个数已经超过设置
5101 账号必填
5102 普通密码格式错误
5204 教室没有密码
5209 用户密码必填
5210 账号格式错误(只支持数字或字母)
5212 手机号必填或格式错误
5301 旁听生密码必须
5302 旁听生密码格式错误
5208 完善企业数据失败
5209 完善企业服务数据失败
5210 完善企业点数数据失败
5211 完善企业数据异常
5800 分组和是否只显示老师和自己视频不能同时使用
5801 分组和老师双摄不能同时使用
5802 分组和学生双摄不能同时使用
5803 分组只能在一对多教室中使用
5804 该企业未开启分组配置项 不能使用分组
5805 rtmp推流地址不合法

© 2016-2021 北京拓课网络科技有限公司 版权所有  京ICP备17018423号-1 京公网安备11010502043461号