云课堂API相关

日期: 2022-11-14

创盛视联数码科技（北京）有限公司

[TOC]

小班课管理API

管理API均需要THQS加密请求

1.创建直播间

描述:

创建直播间
认证方式为接口认证时，具体规则详见 https://doc.bokecc.com/class/developer/api/interface.html

地址:

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

方法:

POST/GET

请求参数:

返回示例:

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

2.更新直播间

描述:

更新直播间
认证方式为接口认证时，具体规则详见 https://doc.bokecc.com/class/developer/api/interface.html

地址:

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

方法:

POST/GET

请求参数:

返回示例:

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

3.获取房间信息

描述:

获取房间信息

地址:

 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
        "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 # 互动者白名单
    }
}

4.创建登录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（含义同login_uid参数），参数login_uid为空时系统自动生成登陆者用户ID
    }
}

5.获取房间登录链接

描述:

获取房间登录链接

地址:

 https://ccapi.csslcloud.net/api/v1/room/link

方法:

POST/GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "data":{
        "presenter_url": "http://a.com"  # 老师登录链接URL
        "talker_url": "http://a.com"     # 互动者登录链接URL
        "audience_url": "http://a.com"   # 旁观者登录链接URL
        "inspector_url": "https://a.com" # 隐身者登录链接URL
        "assist_url": "https://a.com"    # 助教登录链接URL
    }
}

6.获取房间自动登录链接

描述:

获取房间自动登录链接

地址:

 https://ccapi.csslcloud.net/api/v1/room/auto_link

方法:

GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "data":{
        "presenter_url": "http://a.com",  # 老师自动登录链接URL
        "talker_url": "http://a.com" ,   # 互动者自动登录链接URL
        "audience_url": "http://a.com" ,  # 旁观者登录链接URL  当模板类型为互动模式时（templatetype=32）此字段为空
        "inspector_url": "https://a.com", # 隐身者登录链接URL  当模板类型为互动模式时（templatetype=32）此字段为空
        "assist_url": "https://a.com"    # 助教登录链接URL    当模板类型为互动模式时（templatetype=32）此字段为空
    }
}

基于返回链接还需拼接相关参数,才可实现自动登录
参考:自动登录相关

7.开始直播

描述：

开始直播接口

地址：

 https://ccapi.csslcloud.net/api/room/live/start

方法：

GET

请求参数：

返回示例：

{
    "result": "OK", # 失败： FAIL，成功：OK
    liveId: '123' # 直播场次ID  
}

8.结束直播

描述:

结束直播接口

地址:

 https://ccapi.csslcloud.net/api/room/live/stop

方法:

GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "data":{
        "start_time": "2018-04-11 10:58:59 ", # 直播开始时间
        "end_time": "2018-04-11 11:58:59"     # 直播结束时间
    }

}

9.关闭直播间

描述:

关闭直播间 关闭后的直播间，将无法使用

地址:

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

方法:

POST/GET

请求参数:

返回示例:

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

10.获取账号下房间列表

描述:

获取账号下房间列表 可以指定name status roomid为过滤参数

地址:

 https://ccapi.csslcloud.net/openapi/room/list

方法:

POST/GET

请求参数:

返回示例:

{
    "result": "OK", # 失败： FAIL，成功：OK
    "rooms":[
        {
            "live_roomid": "123", # 房间ID
            "name": "123",      # 房间名称
            "desc": "123"       # 房间描述
            "status": 10           # 房间状态 10 开启 20 关闭
            "classtype": 1      # 连麦模式 1:举手连麦；2:自由连麦 3:自动连麦
            "room_type": 1      # 房间类型 1:视频群聊 2:小班课
            "templatetype": 1   # 模版类型 1:讲课模式 2:主视角模式 4:平铺模式 32:互动模式
            "mergetype": 1      # 合流模式 1:主视角模式 2:平铺模式, 3:覆盖模式
            "recordstudent": 1  # 保留：1 不保留：0，默认：0
            "publisherpass": "123"  # 老师登录密码
            "talker_authtype": 1    # 互动者认证方式 0:url验证 1:密码验证 2:免密码
            "talker_pass": "123"    # 互动者登录密码
            "audience_authtype": 1  # 旁听认证方式   0:url验证 1:密码验证 2:免密码
            "audience_pass": "123"  # 旁听登录密码
            "max_users": 10         # 最大支持人数
            "max_streams": 10       # 最大连麦人数
            "video_mode": 1         # 连麦音视频模式 1:音／视频都开 2:仅音频
            "live_status": 1        # 直播状态 1:直播中 0:未直播
            "white_list": ""         # 互动者白名单 如果开启白名单
            "light_mark": 1         # 跑马灯 0:关闭 1:开启
            "show_exit": 0          # 页面是否 显示退出按钮  0:隐藏 1:显示
            "video_zoom": "123"     # 视频点击放大 流ID
            "presenter_url": "http://a.com"  # 老师登录链接URL
            "talker_url": "http://a.com"     # 互动者登录链接URL
            "audience_url": "http://a.com"   # 旁观者登录链接URL
        }
    ],
    total: 5,  # 总页数
    current: 1 # 当前页数
}

11.切换合流布局模式

描述:

切换合流布局模式

地址:

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

方法:

POST/GET

请求参数:

返回示例:

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

12.获取房间人员列表

描述:

获取当前房间人员列表, 人员信息/老师是否存在/在线人数

地址:

 https://ccapi.csslcloud.net/api/v1/room/user/list

方法:

POST/GET

请求参数:

返回示例:

{
    "data": {
        "presenter": 1, # 老师是否存在,
        "assistant": 1  # 助教是否存在
        "total": 1,     # 房间总人数
        "users": [      # 人员列表
            {             # 人员信息
            "avatar": "",
            "id": "c064fee00a424029b0bcf428a834a897", # 用户ID
            "ip": "111.206.170.243",  # IP地址
            "joinTime": "2018-09-06 20.03.59",# 加入房间时间
            "lock": "false",
            "name": "www", # 名称
            "platform": "5", # 登录方式  5:web 7:手机
            "publishTime": "", # 推流时间
            "requestTime": "", # 请求时间
            "role": "presenter", # 角色 老师: presenter  学生: talker
            "socketId": "4umOGIPvnHh5NTvfCr27",
            "status": "0",  # 连麦状态  0:初始状态 1:排麦中(待确认) 2:排麦中(已确认) 3:推流中 4:邀请举手 5:助教预上麦
            "streamId": ""  # 推流ID
            }
        ]
    },
    "result": "OK"
}

13.查询直播状态

描述:

查询直播间 直播状态

地址:

 https://ccapi.csslcloud.net/api/v1/room/live/stat

方法:

POST/GET

请求参数:

返回示例:

{
    "liveid": "93ACDA25756B994A", # 直播ID
    "result": "OK",
    "started": true # true: 直播中 false 未直播
    "starttime": "2018-01-01 01:00:00" # 直播开始时间
}

14.踢出人员

描述:

传入uid,踢出指定人员
传入role,踢出指定角色,
uid和role都不传,则踢出房间所有人

地址:

https://ccapi.csslcloud.net/api/room/user/kickout

方法:

GET

请求参数:

返回示例:

{
  "result": "OK"
}

15.查询账号图片列表

描述:

查询账号图片列表 默认20张系统图片(不传roomid则不判断哪张图片被房间已设置过)

地址:

https://ccapi.csslcloud.net/openapi/account/background/get

方法:

GET

请求参数:

返回示例:

{
    "result":"OK",
    "error":null,
    "data":[
        {
            "id":11111, //图片id 在创建房间/更新房间时 background_id使用
            "img_url":"https://www.bokecc.com, //图片的url
            "type":0, //图片类型 0系统图片 1用户自上传
            "is_check":0 //如果传入房间id 则会判断是否已经运用到房间上 0.未选中 1.选中
        }
    ],
    "errorMsg":""
}

16.增加账号图片

描述

增加账号图片

地址

https://ccapi.csslcloud.net/openapi/account/background/add

方法

GET

请求参数

返回示例:

{
    "result":"OK",
    "error":null,
    "data":{
        "id":22222 //图片id 在创建房间/更新房间时 background_id使用
    },
    "errorMsg":""
}

17.删除账号图片

描述：

删除账号图片

地址:

https://ccapi.csslcloud.net/openapi/account/background/delete

方法:

GET

请求参数:

返回示例:

{
    "result":"OK",
    "error":null,
    "data":null,
    "errorMsg":""
}

18.获取网络监测的人员信息

描述：

获取网络监测的人员信息 (数据保留一个月、SDK6.9.8及以上支持)

地址:

https://ccapi.csslcloud.net/openapi/statistics/monitor/users

方法:

GET

请求参数:

返回示例:

{
    "result":"OK",
    "error":null,
    "data":{
        "total":8,
        "users":[
            {
                "uid":"lx8iMxQ7gYYbeha2", //用户id
                "username":"qqq",    //用户名称
                "role":"presenter" //用户角色
            }
        ]
    },
    "errorMsg":""
}

19.获取某个人的网络数据

描述：

获取某个人的网络数据 (数据保留一个月、SDK6.9.8及以上支持)

地址:

https://ccapi.csslcloud.net/openapi/statistics/monitor/net

方法:

GET

请求参数:

返回示例:

{
    "result":"OK",
    "error":null,
    "data":[
        {
            "delay_rate":10, //网络延迟
            "lost_rate":1.0, //丢包率
            "time":"2022-03-09 19:24:08", //时间
            "userid":"8ybzUJIsgoUl5xpq" //用户id
        }
    ],
    "errorMsg":""
}

20.获取直播中房间人员信息列表

描述:

获取直播中房间人员列表

地址:

 https://ccapi.csslcloud.net/openapi/v1/room/user-list

方法:

GET

请求参数:

返回示例:

{
    "data": {
        "total": 2,     # 总人数
        "list": [      # 人员列表
            {            
                "id": "c064fee00a424", # 用户ID
                "joinTime": "2018-09-06 20.03.59", # 加入房间时间
                "name": "哈哈", # 用户名
                "platform": "5", # 终端类型 2@android 3@ios 5@web 0@未知
                "ip": "111.206.170.243", # IP地址
                "role": "presenter", # 角色 presenter：老师 talker：学员 inspector：隐身者 assistant：助教 aul：学员
            },
            {            
                "id": "c064fee00a424", # 用户ID
                "joinTime": "2018-09-06 20.03.59", # 加入房间时间
                "name": "哈哈1", # 用户名
                "platform": "5", # 终端类型 2@android 3@ios 5@web 0@未知
                "ip": "111.206.170.243", # IP地址
                "role": "presenter", # 角色 presenter：老师 talker：学员 inspector：隐身者 assistant：助教 aul：学员
            }
        ]
    },
    "result": "OK"
}

21 获取分组场次列表

描述:

根据开发者账号ID/房间id/直播Id 查询分组讨论列表

地址:

https://ccapi.csslcloud.net/openapi/recorder/replay/liveGroupTimes

方法:

GET

请求参数:

返回示例:

{
  "result": "OK",
  "error": null,
  "data": [
    {
      "id": 122,#分组场次唯一标识
      "liveId": "7AAC35A2BB9DD6BB",#分组直播Id
      "groupTime": "2022-07-05 16:32:57",#分组时间
    }
  ],
  "errorMsg": ""
}

22 获取某场分组列表详情

描述:

根据开发者账号ID /分组唯一标识/分组直播Id 查询分组详情

地址:

https://ccapi.csslcloud.net/openapi/recorder/replay/liveGroup/info

方法:

GET

请求参数:

返回示例:

{
  "result": "OK",
  "error": null,
  "data": [
    {
      "subLiveId": "6C81CFF2FE3BA0B5",#分组直播id
      "groupNo": 5,
      "groupTimesId": 125,
      "startTime": "2022-07-05 17:09:35",#开始分组时间
      "groupName": "讨论组5" # 分组名称
    }
  ],
  "errorMsg": ""
}

23 导入预设分组名单列表

描述:

导入预设分组名单列表

地址:

https://ccapi.csslcloud.net/openapi/room/group/pre-info

方法:

POST  Content-Type:application/json

请求参数:

{
    "accountId": "5938F047E5F562F0", //开发者账号ID
    "time": 1663224060,
    "infos": [      // 分组数据 
        {
            "groupNo": 1, // 分组序号 不可大于20
            "users": [ // 分组人员列表
                {
                    "isLeader": 1, // 是否为组长 1@是 0@否
                    "userName": "cc" //用户姓名
                }
            ]
        }
    ],
    "roomId": "A12826D179A580C49C33DC5901307461", //房间id
    "hash": "051635CDB75AF68C4208EB41CBCCBA4A"
}

备注:infos THQS前需要先转为JSON String

返回示例:

{
  "result": "OK",
  "error": null,
  "errorMsg": ""
}