加入房间:直接进入房间(entry)

Example

POST entry

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

参数

参数名 是否必选 类型 说明 长度 缺省值
domain 必填 公司域名 String 20
serial 选填 房间编号 Int 9 (该字段和thirdroomid必须至少填写一个)传值方式备注:1、serial 和 thirdroomid 组合查询2、serial 和 thirdroomid 单独传值3、serial 和 thirdroomid 不能同时为空
thirdroomid 选填 用户自定义房间号 String (该字段和serial必须至少填写一个)如果用户创建房间时自定义了房间号,可使用此字段传值方式备注:1、serial 和 thirdroomid 组合查询2、serial 和 thirdroomid 单独传 值3、serial 和 thirdroomid 不能同时为空
username 必填 用户名 String 20 必填,用户在房间中显示的名称;使用UTF8编码,不支持特殊字符
usertype 必填 用户类型 Int 1 必填, 0:主讲(老师 ) 1:助教 2: 学员 3:直播用户 4:巡检员 6:旁听生(小班课) 27:家长 默认值为2;
pid 选填 用户id Int 第三方系统的用户id;默认值为0
ts 必填 时间戳 Int 10 当前GMT时间戳,精确到秒
auth 必填 校验码 String 32 auth 值为 MD5(key + ts + serial/thirdroomid + usertype) 其中key为双方协商的接口密钥:默认值为:5NIWjlgmvqwbt494
userpassword 必填 用户密码 String 32 密码格式为:128位AES加密串加密密钥默认为5NIWjlgmvqwbt494 注:参见附件 5.1 AES加密
extradata 选填 扩展数据 String 用户扩展数据,建议使用urlencode
h5docpar 选填 扩展数据 String H5课件扩展参数
useMicroClass 选填 是否微录课 Int 1开启 不传或者其他值默认不开启
jumpurl 选填 跳转url String 举例说明格式: http:// 或https:// http://baidu.com
参数名 类型 说明
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号