获取教室信息

Example

请求方式 POST

https://global.talk-cloud.net/api/room/v1/getInfo

Headers

参数名	必选	类型	说明
Content-Type	是	string	application/json;
Tk-authkey	是	string	企业Key

Request

参数名	是否必选	类型	说明
serial	是	string	房间号
thirdroomid	否	string	用户自定义房间号：选填(该字段和serial必须至少填写一个)如果用户创建房间时自定义了房间号,可使用此字段
userName	否	string	用户名（用于生成进教室链接）
userType	否	string	用户类型（用于生成进教室链接 0老师1助教2学生4巡课）
pId	否	string	用户ID（用于生成进教室链接）

Response

参数名称	类型	描述
result	int	返回状态码：0：正常
data	obj	数据
data.serial	string	房间号
data.roomstate	string	房间状态：0：正常
data.roomtype	string	房间类型：0：1对1；3：1对多
data.roomname	string	房间名
data.starttime	string	房间开始时间
data.endtime	string	结束时间
data.createtime	string	房间创建时间
data.chairmanpwd	string	老师密码
data.assistantpwd	string	助教密码
data.confuserpwd	string	学生密码
data.sidelineuserpwd	string	围观学生密码
data.auditorspwd	string	旁听生密码
data.auditorsrequired	string	旁听生是否需要密码 0不需要1需要
data.passwordrequired	string	学生是否需要密码 0不需要1需要
data.thirdroomid	string	用户自定义房间号
data.patrolpwd	string	巡课密码
data.entryurl	array	进入教室链接（不需要输入用户名密码）
data.enterurl.usertype	int	用户类型 0老师1助教2学生4巡课
data.enterurl.url	string	进入教室链接（需要输入用户名密码）
data.templateInfo	obj	模版信息 (不是必有得)
data.templateInfo.id	int	模版信息
data.entryurl	string	进入房间
data.roomAttrInfo	obj	教室属性 (不是必有得)
data.roomAttrInfo.maxvideo	string	最大视频数
data.roomAttrInfo.autoopenav	string	上课后自动开启音视频：1：自动开启；0：不开启（升级至3.8.0版本后，此参数的作用将由autoopenaudio和autoopenvideo参数代替）
data.roomAttrInfo.autoopenaudio	string	上课后自动开启音频：1：自动开启；0：不开启
data.roomAttrInfo.autoopenvideo	string	上课后自动开启视频：1：自动开启；0：不开启
data.roomAttrInfo.showYourself	string	只显示老师和自己视频 0：不开启；1：自动开启
data.roomAttrInfo.appstudentsshowpage	string	移动端学生视频显示方式，是否翻页显示（每页6路学生视频），0：否，1：是。
data.roomAttrInfo.roomthemeid	string	教室主题ID
data.roomAttrInfo.videotype	int	视频分辨率：0：200x150；1：320x240；2：640x480；3：1280x720 ；4：1920x1080；5: 80X48；6: 960X540；7: 640X360；8: 320X180；9：160X120；10 80X60
data.roomAttrInfo.videoframerate	string	视频帧率：10,15,20,25,30
data.roomAttrInfo.roomlayout	string	教室布局。一对多教室布局：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)伪上台布局
data.roomAttrInfo.classlogourl	string	教室logo地址
data.roomAttrInfo.rtmp_external_source.push_url	string	直播推流地址
data.roomAttrInfo.rtmp_external_source.live_id	string	直播推流房间号及密钥
data.roomAttrInfo.user_microphone	string	用户上台后默认闭麦，0否/1是

ReturnJson

返回示例

{
    "result": 0,
    "data": {
        "serial": "1137478806",
        "roomstate": "0",
        "roomtype": "3",
        "roomname": "方法",
        "starttime": "1713171079",
        "endtime": "1713173779",
        "createtime": "1713171080",
        "chairmanpwd": "2106",
        "passwordrequired": "1",
        "assistantpwd": "5673",
        "confuserpwd": "4923",
        "thirdroomid": "",
        "patrolpwd": "1039",
        "auditorspwd": "5807",
        "auditorsrequired": "1",
        "templateInfo": {
            "id": 3506
        },
        "roomAttrInfo": {
            "maxvideo": "24",
            "autoopenav": "0",
            "autoopenaudio": "0",
            "autoopenvideo": "0",
            "showYourself": "0",
            "appstudentsshowpage": "0",
            "ismp4record": 1,
            "isrtmp4record": 0,
            "isAiClass": 0,
            "roomthemeid": "1",
            "videotype": 1,
            "videoframerate": "10",
            "roomlayout": "1",
            "classlogourl": "",
            "rtmp_external_source": {
                "push_url": "",
                "live_id": ""
            },
            "user_microphone": "0"
        },
        "enterurl": [
            {
                "url": "https:\/\/\/enterRoom\/1137478806\/10785\/1\/0",
                "usertype": 0
            },
            {
                "url": "https:\/\/\/enterRoom\/1137478806\/10785\/1\/0",
                "usertype": 1
            },
            {
                "url": "https:\/\/\/enterRoom\/1137478806\/10785\/1\/2",
                "usertype": 2
            },
            {
                "url": "https:\/\/\/enterRoom\/1137478806\/10785\/1\/0",
                "usertype": 4
            }
        ],
        "entryurl": "https:\/\/\/WebAPI\/entry?domain=xzj&serial=1137478806&username=asdas&usertype=0&ts=1713235505&auth=a8128d5430b690d22a2f6944c53cf69e&userpassword=28c1dd6cbb70b563bbc57af9bba0234f&pid=1"
    },
    "msg": ""
}

错误码说明