云课堂API相关

日期: 2019-03-01 创盛视联数码科技(北京)有限公司

[TOC]

小班课管理API

管理API均需要THQS加密请求

1. 开始直播

  • 描述
开始直播接口
  • 地址
 https://ccapi.csslcloud.net/api/room/live/start
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户ID 可选
roomid 字符串 直播间ID 必须
  • 返回数据格式
 {
      result: 'OK', # 失败: FAIL,成功:OK
      liveId: '123' # 直播场次ID  
  }

2.结束直播

  • 描述
结束直播接口
  • 地址
 https://ccapi.csslcloud.net/api/room/live/stop
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户ID 可选
roomid 字符串 直播间ID 必须
  • 返回数据格式
 {
      result: 'OK', # 失败: FAIL,成功:OK
      data:{
          "start_time": "2018-04-11 10:58:59 ", # 直播开始时间
          "end_time": "2018-04-11 11:58:59"     # 直播结束时间
      }

  }

3. 创建直播间

  • 描述
创建直播间
  • 地址
 https://ccapi.csslcloud.net/api/room/create
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
name 字符串 直播间名称 长度限制 <= 100 必须
room_type 整型 房间类型 1:视频群聊 2:小班课 3:双师课 必须
publisherpass 字符串 老师端密码 长度限制 <= 64 必须
assist_pass 字符串 助教端密码 长度限制 <= 64 可选,默认为用户账号ID
audience_authtype 整型 旁听认证方式 0:接口验证 1:密码 2:免密码 3:白名单 可选, 默认为1
audience_pass 字符串 旁听密码 长度限制 <= 256 可选, 默认为用户ID,认证方式为接口认证时,此处填写接口认证地址
talker_authtype 整型 互动学员认证方式 0:接口验证 1: 密码 2:免密码 3:白名单 可选 默认为为1
talker_pass 字符串 互动学员认证密码 长度限制 <= 256 可选, 默认为用户账号ID,认证方式为接口认证时,此处填写接口认证地址
inspector_authtype 整型 隐身者认证方式 0:接口验证 1: 密码 2:免密码 可选 默认为为1
inspector_pass 字符串 隐身者认证密码 长度限制 <= 256 可选, 默认为用户账号ID, 认证方式为接口认证时,此处填写接口认证地址
viewer_authtype 整型 回放登录认证方式 0:接口验证 1: 密码 2:免密码 可选 默认为为1
viewer_pass 字符串 回放登录认证密码 长度限制 <= 256 可选, 默认为用户账号ID, 认证方式为接口认证时,此处填写接口认证地址
white_list 字符串 如果互动者开启了白名单,则此处填写json化的用户名/密码,如 "{"user": "123"}" 可选
desc 字符串 直播间简介 长度限制 <= 10000 可选
templatetype 整型 模版类型 1:讲课模式 2:主视角模式 4:平铺模式 8:1v1模式 16:双师模式 可选,默认为8
mergetype 整型 合流模式 1:主视角模式 2:平铺模式 3:覆盖模式 可选, 默认为2
max_users 整型 最大支持人数(进入房间人数), 不能超过账户允许上限 可选, 默认为账户允许上限
max_streams 整型 互动人数上限(实际连麦人数), 不能超过账户允许上限 可选, 默认为房间max_users上限
video_mode 整型 连麦音视频模式 1:音视频 2.仅音频 可选, 默认为1
talker_bitrate 整型 学生端码率 不超2000 可选, 默认为200
publisher_bitrate 整型 老师端码率 不超2000 可选, 默认为200
classtype 整型 连麦模式 1:点名 2:自由 3:自动 可选, 默认为1
presenter_out 布尔型 非直播状态下踢出老师 可选,默认为false
light_mark 整型 跑马灯 0: 关闭 1: 开启 可选, 默认为0
show_exit 整型 页面是否 显示退出按钮, 0 隐藏 1 可选 默认为1
ppt_support 布尔型 是否支持ppt 可选
ppt_display 布尔型 ppt显示样式 0: 适应窗口 1: 适应宽度,默认为0 可选
screen_lock 整型 桌面锁屏 0:未开通 1:开通 2:开启 3:关闭,默认为0 可选
desktop_audio 整型 桌面分享声音 0: 关闭 1: 开启, 默认为0 可选
manual_record 整型 手动录制 0: 关闭 1: 开启, 默认为0 可选
record_bitrate 整型 回放清晰度 速度优先:500 画质优先:0,默认速度优先 可选
warm_open 字符串 暖场视频 '0': 关闭, '1': 开启,默认关闭 可选
helper_switch 整型 直播助手开关 0: 关闭 1:开启,默认关闭 可选
record_switch 整型 录屏助手开关 0: 关闭 1:开启,默认关闭 可选
assist_switch 整型 助教开关 0: 关闭 1:开启,默认关闭 可选
schedule_switch 整型 是否设置预定直播 0: 关闭 1:开启,默认关闭 可选
schedule_live_start 字符串 预定直播开始时间 可选
schedule_live_end 字符串 预定直播结束时间 可选
  • 返回数据格式
  {
      result: 'OK', # 失败: FAIL,成功:OK
      data:{
          "roomid": "123" # 新创建房间的id
      }
  }

4. 更新直播间

  • 描述
更新直播间
  • 地址
 https://ccapi.csslcloud.net/api/room/update
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
live_roomid 字符串 房间ID 必须
name 字符串 直播间名称 可选
publisherpass 字符串 老师端密码 长度限制 <= 64 可选
assist_pass 字符串 助教端密码 长度限制 <= 64 可选
audience_authtype 整型 旁听认证方式 0:接口验证 1:密码 2:免密码 3:白名单 可选
audience_pass 字符串 旁听密码 长度限制 <= 256 可选
talker_authtype 整型 互动学员认证方式 0:接口验证 1: 密码 2:免密码 3:白名单 可选
talker_pass 字符串 互动学员认证密码, 长度限制 <= 256 可选
inspector_authtype 整型 隐身者认证方式 0:接口验证 1: 密码 2:免密码 可选
inspector_pass 字符串 隐身者认证密码 长度限制 <= 256 可选
viewer_authtype 整型 回放登录认证方式 0:接口验证 1: 密码 2:免密码 可选 默认为为1
viewer_pass 字符串 回放登录认证密码 长度限制 <= 256 可选, 默认为用户账号ID, 认证方式为接口认证时,此处填写接口认证地址
white_list 字符串 如果互动者开启了白名单,则此处填写json化的用户名/密码,如 "{"user": "123"}" 可选
desc 字符串 直播间简介 长度限制 <= 10000 可选
templatetype 整型 模版类型 1:讲课模式 2:主视角模式 4:平铺模式 8:1v1模式 16:双师模式 可选
mergetype 整型 合流模式 1:主视角模式 2:平铺模式 3:覆盖模式 可选
max_users 整型 最大支持人数, 不能超过开通人数上限 可选
max_streams 整型 互动人数上限, 不能超过开通人数上限 可选
video_mode 整型 连麦音视频模式 1:音视频 2.仅音频 可选
publisher_bitrate 整型 老师端码率 不超2000 可选
talker_bitrate 整型 学生端码率 不超2000 可选
audio_bitrate 整型 音频码率 默认为50 可选
classtype 整型 连麦模式 1:点名 2:自由 3:自动 可选
is_follow 字符串 是否跟随 主视角模式下 否: 空字符,是: streamid 可选
allow_chat 布尔型 是否允许发言 房间级配置 可选
allow_audio 布尔型 是否允许使用麦克风 房间级配置 可选
allow_speak 布尔型 是否允许上麦 房间级配置 可选
presenter_out 布尔型 非直播状态下踢出老师 可选
ppt_support 布尔型 是否支持ppt 可选
ppt_display 布尔型 ppt显示样式 0: 适应窗口 1: 适应宽度,默认为0 可选
light_mark 整型 跑马灯 0: 关闭 1: 开启 可选
show_exit 整型 整型 页面是否 显示退出按钮, 0: 隐藏 1:显示 可选
desktop_audio 整型 桌面分享声音 0: 关闭 1: 开启, 默认为0 可选
manual_record 整型 手动录制 0: 关闭 1: 开启, 默认为0 可选
record_bitrate 整型 回放清晰度 速度优先:500 画质优先:0,默认速度优先 可选
warm_open 字符串 暖场视频 '0': 关闭, '1': 开启,默认关闭 可选
helper_switch 整型 直播助手开关 0: 关闭 1:开启,默认关闭 可选
record_switch 整型 录屏助手开关 0: 关闭 1:开启,默认关闭 可选
assist_switch 整型 助教开关 0: 关闭 1:开启,默认关闭 可选
schedule_switch 整型 是否设置预定直播 0: 关闭 1:开启,默认关闭 可选
schedule_live_start 字符串 预定直播开始时间 可选
schedule_live_end 字符串 预定直播结束时间 可选
  • 返回数据格式
  {
      result: 'OK', # 失败: FAIL,成功:OK
  }

5. 关闭直播间

  • 描述
关闭直播间 关闭后的直播间,将无法使用
  • 地址
 https://ccapi.csslcloud.net/api/room/close
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
  • 返回数据格式
  {
      result: 'OK', # 失败: FAIL,成功:OK
  }

6. 获取账号下房间列表

  • 描述
获取账号下房间列表 可以指定name status roomid为过滤参数
  • 地址
 https://ccapi.csslcloud.net/api/room/list
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
name 字符串 房间名称 可选
status 整型 房间房间状态 10:正常 20:关闭 可选
page 整型 获取指定页 可选 默认为1
lines 整型 分页每页数据量 可选 默认为50
roomid 字符串 房间ID 可选
  • 返回数据格式
  {
      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:平铺模式 8:1V1模式 16:双师模式
             "mergetype": 1      # 合流模式 1:主视角模式 2:平铺模式, 3:覆盖模式
             "recordstudent": 1  #
             "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
             "screen_lock": 0        # 锁屏相关  0:开通  1:未开通  2:开启 3:关闭
             "presenter_url": "http://a.com"  # 老师登录链接URL
             "talker_url": "http://a.com"     # 互动者登录链接URL
             "audience_url": "http://a.com"   # 旁观者登录链接URL
           }],  # 房间信息
      total: 5,  # 总页数
      current: 1 # 当前页数
  }

7. 获取房间信息

  • 描述
获取房间信息
  • 地址
 https://ccapi.csslcloud.net/api/room/room_detail
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
  • 返回数据格式
{
  result: 'OK', # 失败: FAIL,成功:OK
  "data": {
    "allow_audio": true, # 是否允许使用麦克风 房间级配置
    "allow_chat": true,  # 是否允许发言 房间级配置
    "allow_speak": true, # 是否允许上麦 房间级配置
    "atlas_roomid": "5b0ebc15df4b74399dae0d26",
    "audience_authtype": 1, # 旁听认证方式 0:接口验证 1:密码 2:免密码 3:白名单
    "audience_pass": "123",  # 旁听密码
    "audience_url": "https://view.csslcloud.net/api/view/index?roomid=45CC92144D46FEAA9C33DC5901307461&userid=83F203DAC2468694", # 旁听登录链接url
    "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:平铺模式 8:1v1模式 16:双师模式
    "userid": "83F203DAC2468694", # 用户账号ID
    "video_mode": 1, # 连麦音视频模式 1:音视频 2.仅音频
    "video_zoom": "", # 视频点击放大 流ID
    "white_list": null # 白名单
  }
}

8. 获取房间登录链接

  • 描述
获取房间登录链接
  • 地址
 https://ccapi.csslcloud.net/api/v1/room/link
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
  • 返回数据格式
  {
      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
      }
  }

9. 切换合流布局模式

  • 描述
获取房间登录链接
  • 地址
 https://ccapi.csslcloud.net/api/room/set_single
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
status 整型 状态 1:主视角 2:平铺 必须
  • 返回数据格式
  {
      result: 'OK', # 失败: FAIL,成功:OK
  }

10. 获取sessionid

  • 描述
获取登录sessionid
  • 地址
 https://ccapi.csslcloud.net/api/room/create/sessionid
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
name 字符串 登录名 必须
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
password 字符串 登录密码 可选
role 字符串 角色 '0':老师 '1':互动 '2':旁听 '3': 隐身者 '4': 助教 必须
client 字符串 客户端类型 0:web端 1:移动端 必须
  • 返回数据格式
  {
      result: 'OK', # 失败: FAIL,成功:OK
      data:{
          "sessionid": "123" # 生成的sessionid
         "userid": "123" # 生成的登录用户ID
      }
  }

11. 获取当前房间人员列表

  • 描述
获取当前房间人员列表, 人员信息/老师是否存在/在线人数
  • 地址
 https://ccapi.csslcloud.net/api/v1/room/user/list
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
  • 返回数据格式
    {
      "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",  # 连麦状态
            "streamId": ""  # 推流ID
          }
        ]
      },
      "result": "OK"
    }
    或者
    {
      "data": {
        "presenter": 0,
        "total": 0,
        "users": []
      },
      "result": "OK"
    }

12. 查询直播状态

  • 描述
查询直播间 直播状态
  • 地址
 https://ccapi.csslcloud.net/api/v1/room/live/stat
  • 方法
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
userid 字符串 用户账号ID 必须
roomid 字符串 房间ID 必须
  • 返回数据格式
  直播中
        {
          "liveid": "93ACDA25756B994A", # 直播ID
          "result": "OK",
          "started": true # true: 直播中 false 未直播
          "starttime": "2018-01-01 01:00:00" # 直播开始时间
        }
  未直播
        {
              "result": "OK",
              "started": false
        }

results matching ""

    No results matching ""