双师对接流程

排课相关接口

创建直播间

描述:创建直播间,认证方式为接口认证时，具体规则详见 接口验证

地址:

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

方法:

POST/GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "data":{
        "roomid": "123" # 新创建房间的id
    }
}

注意：templatetype = 6，连麦方式：自动连麦，classtype=3，回放布局：mergetype 建议 3

更新直播间

描述:更新直播间,认证方式为接口认证时，具体规则详见 接口验证

地址:

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

方法:

POST/GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
}

获取房间信息

描述:

获取房间信息

地址:

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

方法:

POST/GET

请求参数:

返回示例:

{
    "result": 'OK', # 失败： FAIL，成功：OK
    "data": {
        "allow_audio": true, # 是否允许使用麦克风 房间级配置
        "allow_chat": true,  # 是否允许发言 房间级配置
        "allow_speak": true, # 是否允许上麦 房间级配置
        "atlas_roomid": "5b0ebc15df4b74399dae0d26",
        "audience_authtype": 1, # 旁听认证方式 0:接口验证 1:密码 2:免密码
        "audience_pass": "123",  # 旁听密码
        "audience_url": "https://view.csslcloud.net/api/view/index?roomid=45CC92144D46FEAA9C33DC5901307461&userid=83F203DAC2468694", # 旁听登录链接url  暂不支持templatetype为32时的房间
        "audio_bitrate": 50, # 音频码率
        "calltimeout": 10,
        "classtype": 2, # 连麦模式 1:点名 2:自由 3:自动
        "clear_cache": 0,
        "closetime": null, # 房间关闭时间
        "createtime": "2018-05-30", # 房间创建时间
        "desc": "<p>1231321</p>", # 房间描述
        "id": 22692,
        "is_follow": "", # 是否跟随 主视角模式下 是:streamid 否:空字符
        "light_mark": 0, # 跑马灯 0: 关闭 1: 开启
        "live_roomid": "45CC92144D46FEAA9C33DC5901307461", # 房间ID
        "live_status": 0, # 直播状态 1:直播中 0:未直播
        "max_streams": 7, # 最大连麦人数
        "max_users": 1000, # 最大支持人数
        "mergetype": 2, # 合流模式 1:主视角模式 2:平铺模式 3:覆盖模式
        "name": "1232", # 直播间名称
        "platform": 1, # 平台 1:web 2:android 3:ios
        "ppt_support": false, # 是否支持ppt
        "presenter_out": false, # 非直播状态下踢出老师
        "presenter_url": "https://class.csslcloud.net/index/presenter/?roomid=45CC92144D46FEAA9C33DC5901307461&userid=83F203DAC2468694", # 老师登录链接URL
        "publisher_bitrate": 200, # 老师端码率
        "publisherpass": "123", #  老师端密码
        "recordstudent": 1,
        "room_type": 2, # 房间类型 1:视频群聊 2:小班课
        "roomid": "45CC92144D46FEAA9C33DC5901307461", # 房间ID
        "screen_lock": 0, # 锁屏相关  0:开通  1:未开通  2:开启 3:关闭
        "show_exit": 1, # 页面是否 显示退出按钮  0:隐藏 1:显示
        "status": 10, #  房间状态 10 开启 20 关闭
        "talker_authtype": 1, # 互动者认证方式 0:url验证 1:密码验证 2:免密码
        "talker_bitrate": 200, # 互动者码率
        "talker_pass": "123", #  互动者登录密码
        "talker_url": "https://class.csslcloud.net/index/talker/?roomid=45CC92144D46FEAA9C33DC5901307461&userid=83F203DAC2468694", # 互动者登录链接URL
        "templatetype": 1, # 模版类型 1:讲课模式 2:主视角模式 4:平铺模式 32:置顶模式
        "userid": "83F203DAC2468694", # 开发者账号ID
        "video_mode": 1, # 连麦音视频模式 1:音视频 2.仅音频
        "video_zoom": "", # 视频点击放大 流ID
        "white_list": null # 互动者白名单
    }
}

获取登录Sessionid

描述:

获取登录sessionid(客户端初始化sdk时传入的sessionid)

地址:

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

方法

POST/GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "data":{
        "sessionid": "123" # 生成的sessionid
        "userid": "123" # 生成的登录用户ID
    }
}

客户端下载&启动方式

下载或更新

方式1：离线获取，由CC售后离线提供下载包

方式2：在线地址获取，点击下载

客户端网页唤起

方式1（推荐使用）：

参见获取房间登录链接

如若需要自动登录，参见获取房间自动登录链接

方式2：

讲师唤起方式：

classclient://class.csslcloud.net/index/presenter/?roomid=${query.roomid}&userid=${query.userid}&role=${query.role}&template=6&username=${query.username}&password=${query.password}

学生唤起方式：

classclient://class.csslcloud.net/index/talker/?roomid=${query.roomid}&userid=${query.userid}&role=${query.role}&template=6&username=${query.username}&password=${query.password}

回放获取

方式1（推荐使用）：

• 通过接口获取合流回放列表

描述:

 通过该接口可以分页获取回放列表的信息

地址:

 https://api.csslcloud.net/api/v2/record/info

方法:

GET

请求参数:

返回示例：

{
   "result" : "OK",    # 请求是否成功。OK：成功；FAIL：失败
   "count" : "100",    # 回放总数
   "pageIndex" : "1",  # 页码
   "records" : [       # 回放列表信息
       {
           "id" : "753C612EB38A8D5A",            # 回放id
           "liveId" : "853C612EB38A8D5A",        # 直播id
           "startTime" : "2015-01-01 00:00:00",  # 开始时间
           "stopTime" : "2015-01-01 23:00:00",   # 结束时间
           "recordStatus": 1,                    # 录制状态，0表示录制未结束，1表示录制完成
           "recordVideoId" : "953C612EB38A8D5A", # 录制视频id，如果recordStatus为0则返回-1
           "replayUrl" : "http://xxx",           # 回放地址，当recordStatus为0时返回""
           "offlinePackageUrl" : "http://yyy",   # 离线包下载地址，注：只有开通离线播放权限才会返回该参数
           "offlinePackageMd5" : "xxxxxdddddddddddddddddddddddddddd" # 离线包md5，注：只有开通离线播放权限才会返回该参数
       },
       ...
   ]
}

方式2：

• 第一步：配置回放录制回调接口，操作路径为：云直播-回调设置，勾选直播录制并配置回调地址
• 第二步：通过回调信息，获取回放视频ID（recordVideoId） 参见文档 直播回调直播录制回调参数说明
• 第三步：通过视频id调用 获取视频播放代码接口获取播放地址取视频播放代码接口获取播放地址