HTTP接口

优质
小牛编辑
136浏览
2023-12-01

HTTP接口

创建直播间

通过该接口可以创建直播间,接口请求地址为:

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

需要传递以下参数:

参数说明备注
useridCC账户ID
name直播间名称,最大字符40标题头尾的空格字符会自动删除
desc直播间描述,最大字符5000
templatetype直播模板类型,请求模板信息接口可获得模板类型的详细信息。
authtype验证方式,0:接口验证,需要填写下面的checkurl;1:密码验证,需要填写下面的playpass;2:免密码验证
publisherpass推流端密码,即讲师密码
assistantpass助教端密码
playpass播放端密码可选
checkurl验证地址可选
barrage是否开启弹幕。0:不开启;1:开启可选,默认为0
foreignpublish是否开启第三方推流。0:不开启;1:开启可选,默认为0,开启时必须开启网页登录的主持人模式,支持模板类型1、2、3、6
openlowdelaymode开启直播低延时模式。0:不开启;1:开启可选,默认为0
openchatmanage开启聊天审核。0:不开启;1:开启可选,默认为0
showusercount在页面显示当前在线人数。0:不显示;1:显示可选,默认0,不显示当前人数,模板一暂不支持此设置
openhostmode开启主持人模式,"0"表示不开启;"1"表示开启可选,默认为0,开通主持人模式权限后方可设置
hostloginmode主持人登录模式,"0"表示网页登录;"1"表示客户端登录可选,默认为0,客户端登录只支持模板类型4、5
warmvideoid插播暖场视频,填写同一账号下云点播视频vid可选,默认关闭;参数值为空,表示关闭
livestarttime直播开始时间;格式:yyyy-MM-dd HH:mm:ss可选,默认为空
playerbackgroundhint播放器提示语。未直播时播放器将显示该提示语可选,最多15个字符
manuallyrecordmode手动录制模式。0:关闭;1:开启可选,默认关闭
clientdocpermissions讲师文档权限。0:关闭;1:开启可选,默认关闭;
repeatedloginsetting重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效可选,默认0
maxaudiencenum直播间并发人数上限可选,默认为0,表示不做限制
documentdisplaymode文档显示模式。1:适合窗口;2:适合宽度可选,适合窗口
openlivecountdown倒计时功能。0:关闭;1:开启可选,默认关闭
showlectueronlinenum讲师端显示在线人数。0:不显示;1:显示可选,默认显示
showassistonlinenum助教主持人端显示在线人数。0:不显示;1:显示可选,默认显示
openmarquee跑马灯功能。0:关闭;1:开启可选,默认为0
hideexitbutton隐藏观看端退出按钮。0:不开启;1:开启可选,默认为0
alarms直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符可选,默认为空
openTextPicLive移动H5页面是否显示图文直播。0:隐藏;1:显示可选,默认为0 (需开通权限)
inRemindFlag进入直播是否提醒:1-是;0-否可选,默认为0
inRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割可选,默认为1,2,3,4
inBeContent进入直播提醒内容前段可选,inBeContent和inAfContent加起来字符限制10个
inAfContent进入直播提醒内容后段可选,inBeContent和inAfContent加起来字符限制10个
outRemindFlag退出直播是否提醒:1-是;0-否可选,默认为0
outRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割可选,默认为1,2,3,4
outBeContent退出直播提醒内容前段可选,outBeContent和outAfContent加起来字符限制10个
outAfContent退出直播提醒内容后段可选,outBeContent和outAfContent加起来字符限制10个
privateChat私聊开关,1: 开启,0: 关闭可选,默认1: 开启

返回数据包含如下字段:

字段名说明
result请求结果。OK:成功;FAIL:失败
room直播间信息

room包含如下字段:

字段名说明
id直播间id
publishUrls推流地址,第三方推流的直播间可以获取到此参数

JSON格式的返回信息如下:

 {
    "result": "OK",
    "room": {
      "id": "76620AD36E2F23719C33DC5901307461",
      "publishUrls": [
            "rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
        ]
    }
  }

编辑直播间

通过该接口可以编辑直播间的信息,接口请求地址为:

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

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
name直播间名称,最大字符40可选,标题头尾的空格字符会自动删除
desc直播间描述,最大字符5000可选
templatetype直播模板类型,请求模板信息接口可获得模板类型的详细信息。可选
authtype验证方式,0:接口验证,需要填写下面的checkurl;1:密码验证,需要填写下面的playpass;2:免密码验证可选
publisherpass推流端密码,即讲师密码可选
assistantpass助教端密码可选
playpass播放端密码可选
checkurl验证地址可选
barrage是否开启弹幕。0:不开启;1:开启可选
openlowdelaymode开启直播低延时模式。0为关闭;1为开启可选
openchatmanage开启聊天审核。0:不开启;1:开启可选,默认为0
showusercount在页面显示当前在线人数,0表示不显示;1表示显示可选,模板一暂不支持此设置
warmvideoid插播暖场视频,填写同一账号下云点播视频vid可选,参数值为空,表示关闭
livestarttime直播开始时间;格式;yyyy-MM-dd HH:mm:ss可选
playerbackgroundhint播放器提示语。未直播时播放器将显示该提示语可选,最多15个字符
manuallyrecordmode手动录制模式。0:关闭;1:开启可选
clientdocpermissions讲师文档权限。0:关闭;1:开启可选
repeatedloginsetting重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效可选
maxaudiencenum直播间并发人数上限可选
documentdisplaymode文档显示模式。1:适合窗口;2:适合宽度可选
openlivecountdown开启倒计时功能。0:不开启;1:开启可选
showlectueronlinenum讲师端显示在线人数。0:不显示;1:显示可选
showassistonlinenum助教主持人端显示在线人数。0:不显示;1:显示可选
openmarquee跑马灯功能。0:关闭;1:开启可选
hideexitbutton隐藏观看端退出按钮。0:不开启;1:开启可选,默认为0
alarms直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符可选
inRemindFlag进入直播是否提醒:1-是;0-否可选,默认为0
inRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割可选,默认为1,2,3,4
inBeContent进入直播提醒内容前段可选,inBeContent和inAfContent加起来字符限制10个
inAfContent进入直播提醒内容后段可选,inBeContent和inAfContent加起来字符限制10个
outRemindFlag退出直播是否提醒:1-是;0-否可选,默认为0
outRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割可选,默认为1,2,3,4
outBeContent退出直播提醒内容前段可选,outBeContent和outAfContent加起来字符限制10个
outAfContent退出直播提醒内容后段可选,outBeContent和outAfContent加起来字符限制10个
openTextPicLive移动H5页面是否显示图文直播。0:隐藏;1:显示可选,默认为0 (需开通权限)
privateChat私聊开关,1: 开启,0: 关闭可选,默认1: 开启

JSON格式的返回信息如下:

 {
    "result": "OK"
  }

关闭直播间

通过该接口将直播间关闭,接口请求地址为:

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

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户ID

JSON格式的返回信息如下:

{
      "result": "OK"
  }

备注:如果直播间正在进行直播,将无法关闭,返回错误信息包含:invalid operation

开启直播间

通过该接口将已关闭直播间开启,接口请求地址为:

https://api.csslcloud.net/api/room/open

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户ID

JSON格式的返回信息如下:

{
      "result": "OK"
  }

删除直播间

通过该接口可删除直播间,同时会删除该直播间下全部直播和回放,不可恢复,接口请求地址为:

https://api.csslcloud.net/api/room/delete

需要传递以下参数:

参数说明
roomids直播间id,支持多个,id之间以英文逗号","分隔,批量删除数量不能超过100个
useridCC账户ID

JSON格式的返回信息如下:

{
      "result": "OK"
  }

获取直播间列表

通过该接口可以获取用户的直播间列表信息

https://api.csslcloud.net/api/room/info

需要传递以下参数:

参数说明备注
useridCC账户ID
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
pageindex页码
count直播间总数
rooms直播间列表信息

rooms包含多个直播间信息,直播间包含以下字段:

字段名说明
id直播间id
name直播间名称
desc直播间描述
status直播间状态,10:正常; 20:关闭; 40:已封禁
publisherPass推流端密码
playPass播放端密码
assistantPass助教密码
checkUrl验证地址
templateType模板类型
authType验证类型
barrage是否开启弹幕,0:不开启;1:开启
publishUrls推流地址,第三方推流直播间可以获取到此参数
openLowDelayMode开启低延时模式,"0"表示不开启;"1"表示开启
delayTime延时时间,单位秒。低延时模式下该值为0.
showUserCount在页面显示用户在线人数,"0"表示不显示;"1"表示显示
openHostMode开启主持人模式,"0"表示不开启;"1"表示开启
hostLoginMode主持人登录模式,"0"表示网页登录;"1"表示客户端登录
foreignPublish是否开启第三方推流。0:不开启;1:开启
warmVideoId插播暖场视频,为空,表示关闭
liveStartTime直播开始时间
playerBackgroundHint播放器提示语
manuallyRecordMode手动录制模式。0:关闭;1:开启
clientDocPermissions讲师文档权限。0:关闭;1:开启
repeatedLoginSetting重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效
maxAudienceNum直播间并发人数上限
documentDisplayMode文档显示模式。1:适合窗口;2:适合宽度
openLiveCountdown开启倒计时功能。0:不开启;1:开启
showLectuerOnlineNum讲师端显示在线人数。0:不显示;1:显示
showAssistOnlineNum助教主持人端显示在线人数。0:不显示;1:显示
openMarquee跑马灯功能。0:关闭;1:开启
openChatManage聊天审核是否开启。0:不开启;1:开启
hideExitButtonFlag隐藏观看端退出按钮。0:不开启;1:开启
alarms直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符

JSON格式的返回信息如下:

{
     "result": "OK",
     "pageIndex": 1,
     "count": 100,
     "rooms": [
         {
             "id": "76620AD36E2F23719C33DC5901307461",
             "name": "直播间名称",
             "desc": "直播间描述",
             "status": 10,
             "publisherPass": "PubToken",
             "playPass": "PlayToken",
             "assistantPass": "assToken",
             "checkUrl": "http://check.xxx.com/api/viewer/check",
             "templateType": 1,
             "authType": 1,
             "barrage": 1,
             "publishUrls": [
            "rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
        ],
             "openLowDelayMode": "1",
             "delayTime": "0",
             "showUserCount": "1",
             "openHostMode": "0",
             "hostLoginMode": "0",
             "foreignPublish": 0,
             "warmVideoId": "",
             "liveStartTime":"2015-01-02 12:30:01",
             "playerBackgroundHint":"你好",
             "manuallyRecordMode":"0",
             "clientDocPermissions":"0",
             "openMarquee": "0",
             "repeatedLoginSetting":"0",
             "maxAudienceNum":"100",
             "documentDisplayMode":"1",
             "openLiveCountdown":"0",
             "alarms": "",
             "openChatManage": "0",
             "showLectuerOnlineNum":"0",
             "showAssistOnlineNum":"0",
             "hideExitButtonFlag": "0"
         },
         ...
     ]
  }

获取直播间信息

通过该接口可以获取直播间的信息,接口请求地址为:

https://api.csslcloud.net/api/room/search

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户id

返回数据包含如下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
room直播间信息

room包含以下字段:

字段名说明
id直播间id
name直播间名称
desc直播间描述
status直播间状态,10:正常; 20:关闭; 40:已封禁
publisherPass推流端密码
playPass播放端密码
assistantPass助教密码
checkUrl验证地址
templateType模板类型
authType验证类型
barrage是否开启弹幕,0:不开启;1:开启
publishUrls推流地址,第三方推流直播间可以获取到此参数
openLowDelayMode开启低延时模式,"0"表示不开启;"1"表示开启
delayTime延时时间,单位秒。低延时模式下该值为0.
showUserCount在页面显示用户在线人数,"0"表示不显示;"1"表示显示
openHostMode开启主持人模式,"0"表示不开启;"1"表示开启
hostLoginMode主持人登录模式,"0"表示网页登录;"1"表示客户端登录
foreignPublish是否开启第三方推流。0:不开启;1:开启
warmVideoId插播暖场视频,为空,表示关闭
liveStartTime直播开始时间
playerBackgroundHint播放器提示语
manuallyRecordMode手动录制模式。0:关闭:开启
clientDocPermissions讲师文档权限。0:关闭;1:开启
repeatedLoginSetting重复登录设置;0:允许后进入者登录;1:禁止后进入者登录,对讲师端和观看端生效
maxAudienceNum直播间并发人数上限
documentDisplayMode文档显示模式。1:适合窗口;2:适合宽度
openLiveCountdown开启倒计时功能。0:不开启;1:开启
showLectuerOnlineNum讲师端显示在线人数。0:不显示;1:显示
showAssistOnlineNum助教主持人端显示在线人数。0:不显示;1:显示
openMarquee跑马灯功能。0:关闭;1:开启
openChatManage聊天审核是否开启。0:不开启;1:开启
hideExitButtonFlag隐藏观看端退出按钮。0:不开启;1:开启
alarms直播提醒设置,格式如下:[{"time":"","desc":""},{"time":"","desc":""},{"time":"","desc":""}] time为提醒时间点(单位:分钟),类型为字符串,取值范围1-1000的整数;desc为提醒内容,类型为字符串,最多20个字符
openTextPicLive移动H5页面是否显示图文直播。0:隐藏;1:显示
inRemindFlag进入直播是否提醒:1-是;0-否
inRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割
inBeContent进入直播提醒内容前段
inAfContent进入直播提醒内容后段
outRemindFlag退出直播是否提醒:1-是;0-否
outRole进入直播提醒角色:1-讲师;2-助教;3-主持人;4-观看端,以逗号, 分割
outBeContent退出直播提醒内容前段
outAfContent退出直播提醒内容后段
privateChat私聊开关,1: 开启,0: 关闭

JSON格式的返回信息如下:

 {
     "result": "OK",
     "room": {
             "id": "76620AD36E2F23719C33DC5901307461",
             "name": "直播间名称",
             "desc": "直播间描述",
             "status": 10,
             "publisherPass": "PubToken",
             "playPass": "PlayToken",
             "assistantPass": "assToken",
             "checkUrl": "http://check.xxx.com/api/viewer/check",
             "templateType": 1,
             "authType": 1,
             "barrage": 1,
             "publishUrls": [
            "rtmp://xxxx.xxxx.net/live/EE98D675ABF4FEA99C33DC5901307461_0",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_1",
            "rtmp://xxxx.xxxx..net/live/EE98D675ABF4FEA99C33DC5901307461_2"
        ],
             "openLowDelayMode": "1",
             "delayTime": "0",
             "showUserCount": "1",
             "openHostMode": "0",
             "hostLoginMode": "0",
             "foreignPublish": 0,
             "warmVideoId": "",
             "liveStartTime":"2015-01-02 12:30:01",
             "playerBackgroundHint":"你好",
             "manuallyRecordMode":"0",
             "clientDocPermissions":"0",
             "openMarquee": "0",
             "repeatedLoginSetting":"0",
             "maxAudienceNum":"100",
             "openTextPicLive": "0",
             "documentDisplayMode":"1",
             "openLiveCountdown":"0",
             "alarms": "",
             "openChatManage": "0",
             "showLectuerOnlineNum":"0",
             "showAssistOnlineNum":"0",
             "hideExitButtonFlag": "0",
              "inRemindFlag": "1",
              "inBeContent": "欢迎",
              "inAfContent": "进入直播间",
              "inRole": [
                  1,
                  4,
                  2,
                  3
              ],
              "outRemindFlag": "1",
              "outBeContent": "",
              "outAfContent": "离开直播间",
              "outRole": [
                  1,
                  4,
                  2,
                  3
              ]
     }
  }

获取直播列表

通过该接口获取指定直播间下历史直播信息,接口请求地址为:

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

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1
starttime查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数,该查询是按直播的开始时间作为查询条件的。可选,如果填写该参数则endtime参数必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00"
endtime查询截止时间可选 ,如果填写该参数则starttime必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-02 12:30:00"

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count直播总数
pageIndex页码
lives直播列表信息

lives包含以下字段:

字段名说明
id直播id
startTime开始直播时间
endTime结束直播时间
templateType模板类型
sourceType直播来源类型,0:正常直播;1:合并回放生成; 2:迁移回放生成; 3:上传回放生成

JSON格式的返回信息如下:

{
      "result" : "OK",
         "count" : "100",
         "pageIndex" : "1",
         "lives" : [
             {
                 "id" : "753C612EB38A8D5A",
                 "startTime" : "2015-01-01 00:00:00",
                 "endTime" : "2015-01-01 23:00:00",
                 "recordVideoStatus" : 0,
                 "templateType": 5,
                 "sourceType": 0
             },
             ...
         ]
    }

删除直播

通过该接口可以删除直播,同时会删除该直播下的全部回放,删除后不可恢复,接口请求地址为:

https://api.csslcloud.net/api/live/delete

需要传递以下参数:

参数说明
liveids直播id,支持多个,id之间以英文逗号","分隔,批量删除数量不能超过100个
useridCC账户ID

JSON格式的返回信息如下:

{
      "result": "OK"
  }

查询回放列表

通过该接口可以分页获取回放列表的信息,接口请求地址为:

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

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1
starttime查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数,该查询是按直播的开始时间作为查询条件的。可选,如果填写该参数则endtime参数必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00"
endtime查询截止时间可选 ,如果填写该参数则starttime必填;格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-02 12:30:00"
liveid直播id可选,将只查询该直播下的回放信息

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count回放总数
pageIndex页码
records回放列表信息

records包含以下字段:

字段名说明
id回放id
liveId直播id
startTime开始录制时间
stopTime结束录制时间
recordStatus录制状态,0表示录制未结束,1表示录制完成(回放生成,不包括离线CCR)
recordVideoId录制视频id,如果recordStatus为0则返回-1
replayUrl回放地址,当recordStatus为0时返回""
offlinePackageUrl离线包http下载地址,注:只有开通离线播放权限才会返回该参数
httpsOfflinePackageUrl离线包https下载地址,注:只有开通离线播放权限才会返回该参数
offlinePackageMd5离线包md5,注:只有开通离线播放权限才会返回该参数
offlinePackageSize离线包文件大小,单位Byte,注:只有开通离线播放权限才会返回该参数
templateType模板类型
sourceType回放来源,0:录制; 1:合并; 2:迁移; 3:上传
title回放标题
desc回放描述

JSON格式的返回信息如下:

{
       "result" : "OK",
       "count" : "100",
       "pageIndex" : "1",
       "records" : [
           {
               "id" : "753C612EB38A8D5A",
               "liveId" : "853C612EB38A8D5A",
               "startTime" : "2015-01-01 00:00:00",
               "stopTime" : "2015-01-01 23:00:00",
               "recordStatus": 1,
               "recordVideoId" : "953C612EB38A8D5A",
               "replayUrl" : "https://xxx",
               "offlinePackageUrl" : "http://yyy",
               "httpsOfflinePackageUrl" : "https://yyy",
               "offlinePackageMd5" : "xxxxxdddddddddddddddddddddddddddd",
                "offlinePackageSize": 2350422,
               "templateType": 5,
               "sourceType": 1,
               "title": "回放标题",
               "desc": "回放描述"
           },
           ...
       ]
  }

查询回放信息

通过该接口获取单个回放信息,接口请求地址为:

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

需要传递以下参数:

参数说明备注
useridCC账户ID
recordid回放id

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
record回放信息

record包含以下字段:

字段名说明
id回放Id
liveId直播Id
startTime开始录制时间, 格式为"yyyy-MM-dd HH:mm:ss"
stopTime结束录制时间, 格式为"yyyy-MM-dd HH:mm:ss", 如果录制未结束,该值则为""
recordStatus录制状态,0表示录制未结束,1表示录制完成
replayUrl回放地址,当recordStatus为0时返回""
recordVideoId录制视频id,如果recordStatus为0则返回-1
offlinePackageUrl离线包http下载地址,注:只有开通离线播放权限才会返回该参数
httpsOfflinePackageUrl离线包https下载地址,注:只有开通离线播放权限才会返回该参数
offlinePackageMd5离线包md5,注:只有开通离线播放权限才会返回该参数
offlinePackageSize离线包文件大小,单位Byte,注:只有开通离线播放权限才会返回该参数
downloadUrl回放视频http下载地址,该下载地址具有时效性,有效时间为2小时
httpsDownloadUrl回放视频https下载地址,该下载地址具有时效性,有效时间为2小时
templateType模板类型
sourceType回放来源,0:录制; 1:合并; 2:迁移; 3:上传
title回放标题
desc回放描述

JSON格式的返回信息如下:

 {
    "result" : "OK",
    "record" : {
            "id" : "753C612EB38A8D5A",
            "liveId" : "853C612EB38A8D5A",
            "startTime" : "2015-01-01 00:00:00",
            "stopTime" : "2015-01-01 23:00:00",
            "recordStatus": 1,
            "recordVideoId" : "953C612EB38A8D5A",
            "replayUrl" : "https://xxx",
            "offlinePackageUrl" : "http://yyy"
            "httpsOfflinePackageUrl" : "https://yyy",
            "offlinePackageMd5" : "xxxxxdddddddddddddddddddddddddddd",
            "offlinePackageSize": 2350422,
            "downloadUrl" : "http://zzz",
            "httpsDownloadUrl" : "https://zzz",
            "templateType": 5,
            "sourceType": 1,
            "title": "回放标题",
            "desc": "回放描述"
        }
    }

合并回放

通过该接口可以对同一直播间下相同模板类型的回放进行合并,接口请求地址为:

https://api.csslcloud.net/api/live/merge

需要传递以下参数:

参数说明备注
useridCC账户ID必须
roomid直播间id必须
recordids回放ID集合必须,中间以英文逗号间隔,最多支持3个回放合并

返回数据:

{
    "result": "OK",
    "recordid": "1898E3CD7F97BEED" // 合并生成新的回放ID
}

编辑回放

通过该接口编辑回放信息,接口请求地址为:

https://api.csslcloud.net/api/record/edit

需要传递以下参数:

参数说明备注
useridCC账户ID必填
recordid回放id必填
title回放标题,最大字符40必填,标题头尾的空格字符会自动删除
desc回放描述,最大字符5000可选

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败

JSON格式的返回信息如下:

 {
    "result" : "OK"
 }

删除回放

通过该接口删除一个或多个回放信息,删除后不可恢复,接口请求地址为:

https://api.csslcloud.net/api/record/delete

需要传递以下参数:

参数说明备注
useridCC账户ID
recordids回放id支持多个回放id,id之间以英文逗号","分隔,批量删除数量不能超过100个

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败

JSON格式的返回信息如下:

 {
    "result" : "OK"
 }

获取正在直播的直播间列表

该接口可获取用户账号下所有正在进行直播的直播间列表,接口请求地址为:

https://api.csslcloud.net/api/rooms/broadcasting

需要传递以下参数:

参数说明
useridCC账户ID

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
rooms房间列表

房间列表含有以下字段:

字段名说明
roomId房间ID
liveId正在直播的直播ID
startTime直播开始时间,格式为"yyyy-MM-dd HH:mm:ss"

JSON格式的返回信息如下:

{
       "result": "OK",
       "rooms": [
           {  
               "roomId": "76620AD36E2F23719C33DC5901307461",
               "liveId": "63835A29B2A11961",
               "startTime": "2016-11-28 20:00:00"
           },
           ...
       ]
  }

获取直播间直播状态

通过该接口获取直播间的直播状态,接口请求地址为:

https://api.csslcloud.net/api/rooms/publishing

需要传递以下参数:

参数说明
roomids直播间id(以英文逗号,区分),批量查询直播间数量不能超过100个
useridCC账户ID

JSON格式的返回信息如下:

{
      "result": "OK",
        "rooms": [{
            "liveStatus": 0,
            "roomId": "E568A3195950ED7C9C33DC5901307461"
        },
        ...
        {
            "startTime": "2016-11-28 20:00:00",
            "liveStatus": 1,
            "liveId": "3F35109F9F77F2A8",
            "roomId": "76620AD36E2F23719C33DC5901307461"
        }]
  }

返回信息:

参数说明
result"OK":请求成功,否则请求失败
rooms返回查询直播间信息
liveStatus0:直播未开始,1:正在直播
startTime直播开始时间,若直播未开始,不返回该参数
liveId直播ID,若直播未开始,不返回该参数
roomId直播间ID

获取直播间连接数

通过该接口可以获取直播间的连接数统计信息,请求次数上限为2次/分钟,接口请求地址为:

https://api.csslcloud.net/api/statis/connections

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户ID
starttime开始时间,精确到秒,例:"2015-01-02 12:30:00"
endtime结束时间,精确到秒,例:"2015-01-02 13:30:00",endtime和starttime相差不能超过7天

返回字段包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
roomId直播间id
connections连接统计信息

connections包含以下字段:

字段名说明
time统计时间点
count连接总数
replayCount回放连接总数

JSON格式的返回信息如下:

{
     "result": "OK",
     "roomId": "76620AD36E2F23719C33DC5901307461",
     "connections": [
         {
             "time": "2016-11-28 20:00:30",
             "count": 9527,
             "replayCount": 7259
         },
         ...
     ]
  }

获取直播间模板信息

通过该接口可以获取直播间各模板信息,接口请求地址为:

https://api.csslcloud.net/api/viewtemplate/info

需要传递以下参数:

参数说明
useridCC账户ID

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
templates模板信息

viewTemplates包含多个模板信息,模板信息包含一些字段:

字段名说明
type模板类型
name模板名称
desc模板描述
iconPath模板图标路径
pdfView是否开启pdf视图,0:不开启;1:开启
chatView是否开启聊天视图,0:不开启;1:开启
qaView是否开启问答视图,0:不开启;1:开启

JSON格式的返回信息如下:

 {
     "result": "OK",
     "templates": [
         {
          "type": 2,
          "name": "模板二",
          "desc": "视频,聊天,问答",
          "iconPath": "ltab4",
          "chatView": 1,
          "pdfView": 0,
          "qaView": 1
      },
         ...
     ]
  }

获取直播间代码

通过该接口可以获取直播间的代码信息,包括观看地址信息、客户端登陆地址、助教端登录地址、推流地址(只有第三方推流直播间才可以获取到)、图文直播发布页地址(只有开启图文直播权限才可以获取到)。接口请求地址为:

https://api.csslcloud.net/api/room/code

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户ID

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
roomId直播间id
clientLoginUrl客户端登录地址
assistantLoginUrl助教端登录地址
viewUrl观看地址
publishUrls推流地址,第三方推流直播间可以获取到此参数
hostLoginUrl如果直播间为主持人模式,则返回主持人登录地址
promulgatorUrl如果账号开通了图文直播权限,则返回图文直播发布地址

JSON格式的返回信息如下:

{
     "result": "OK",
       "roomId": "76620AD36E2F23719C33DC5901307461",
       "clientLoginUrl": "https://view.csslcloud.net/api/view/lecturer?roomid=76620AD36E2F23719C33DC5901307461&userid=753C612EB38A8D5A",
       "assistantLoginUrl": "https://view.csslcloud.net/api/view/assistant?roomid=xxxx&userid=xxxx",
       "viewUrl": "https://view.csslcloud.net/api/view/index?roomid=xxxx&userid=xxxx"
     "publishUrls": [
            "rtmp://xxxx.xxxx.net/live/xxxx",
            "rtmp://xxxx.xxxx..net/live/xxxx",
            "rtmp://xxxx.xxxx..net/live/xxxx"
        ],
       "hostLoginUrl": "https://view.csslcloud.net/api/view/manage?roomid=xxxx&userid=xxxx",
       "promulgatorUrl": "https://xxx.xxx.net/api/view/promulgator?roomId=xxxx&accountId=xxxx"
  }

获取直播间内用户进出信息

通过该接口可以获取直播间内用户进入,离开行为的统计,接口请求地址为:

https://api.csslcloud.net/api/statis/room/useraction

需要传入以下参数:

参数说明
roomid直播间id
useridCC账户ID
starttime查询起始时间,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00"
endtime查询截止时间,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过1天
action按进入或离开查询,0表示进入直播间,1表示离开直播间
pageindex可选,查询页码,默认为1
pagenum可选,单页所查询的数据条数,默认为50,最大阈值为1000

返回数据包括以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
action0表示进入直播间,1表示离开直播间
userActions用户进入、离开行为记录

userActions包括用户的行为信息,包括以下字段:

字段名说明
userId用户Id,此Id为进入、离开行为的用户Id
userName用户登录名称
userIp用户IP地址
time用户进入或离开时间

JSON格式的返回信息如下:

 {
    "result": "OK",
    "userActions": [
        {
            "userId": "780",
            "userName": "张三",
            "userIp": "111.206.170.241",
            "time": "2019-01-17 17:18:21.0"
        },
        ...
    ],
    "action": 0,
    "pageIndex": 1,
    "count": 5
 }

获取观看直播的访问记录

通过该接口可以获取观看直播的访问记录,接口请求地址为:

https://api.csslcloud.net/api/statis/live/useraction

注意:该接口仅支持查询2018年12月1日以后的直播

参数说明备注
useridCC账户ID
liveid直播id
pagenum每页显示的个数可选,默认值为50,最大阈值为1000
pageindex页码可选,默认值为1

返回值说明:

参数名称参数类型参数说明
result字符串请求是否成功。OK:成功;FAIL:失败
count数字总访问次数
pageIndex数字当前页码
viewerId字符串用户ID
viewerName字符串用户昵称
viewerIp字符串用户IP
city字符串用户地域
enterTime字符串进入时间
leaveTime字符串离开时间
watchTime数字直播观看时长,单位:秒
terminal数字终端类型,0表示PC端,1表示移动端
customInfo字符串json格式字符串,自定义用户信息
userRole字符串用户角色,1:主讲、推流端角色, 2:助教端角色,3:主持人角色,4:学生、观看端角色

JSON格式的返回信息如下:

{
    "result": "OK",
    "userEnterLeaveActions": [
        {
            "viewerId": "d7ba862174754b1cb88138b8c3d94018",
            "viewerName": "21",
            "viewerIp": "111.26.170.241",
            "city": "中国\t北京\t北京\t",
            "enterTime": "2019-02-12 14:01:07",
            "leaveTime": "2019-02-12 14:01:51",
            "watchTime": 26,
            "terminal": 0,
            "customInfo": "",
            "userRole": 1
        },
        {
            "viewerId": "a9a589134a2e4037938d85a63cfb28bb",
            "viewerName": "二叉",
            "viewerIp": "111.26.170.241",
            "city": "中国\t北京\t北京\t",
            "enterTime": "2019-02-12 14:01:15",
            "leaveTime": "2019-02-12 14:01:51",
            "watchTime": 26,
            "terminal": 0,
            "customInfo": "",
            "userRole": 4
        }
    ],
    "pageIndex": 1,
    "count": 2
}

获取直播互动的统计信息

通过该接口可以获取直播互动的统计信息,接口请求地址为:

https://api.csslcloud.net/api/statis/interactive
参数说明备注
useridCC账户ID
liveid直播id
pagenum每页显示的个数可选,默认值为50,最大阈值为1000
pageindex页码可选,默认值为1

返回值说明:

参数名称参数类型参数说明
result字符串请求是否成功。OK:成功;FAIL:失败
count数字总人数
pageIndex数字当前页码
viewerId字符串用户ID
viewerName字符串用户昵称
watchTime数字直播观看时长(秒)
enterLeaveCount数字进出次数
chatCount数字聊天次数
questionCount数字提问次数
rollcallCount数字签到次数
questionnaireCount数字答卷次数
classroomExaminationCount数字随堂测次数,2020-09-23以后的直播可以获取此参数

JSON格式的返回信息如下:

{
    "result": "OK",
    "count": 2,
    "pageIndex": 1,
    "liveViewerStatisConclusions": [
        {
            "viewerId": "27e7ce350aed4011873b384bbc1296d3",
            "viewerName": "12",
            "watchTime": 223,
            "enterLeaveCount": 1,
            "chatCount": 0,
            "questionCount": 0,
            "rollcallCount": 0,
            "questionnaireCount": 0,
            "classroomExaminationCount": 0
        },
        {
            "viewerId": "300227588049",
            "viewerName": "web空 ",
            "watchTime": 223,
            "enterLeaveCount": 1,
            "chatCount": 0,
            "questionCount": 0,
            "rollcallCount": 0,
            "questionnaireCount": 0,
            "classroomExaminationCount": 0
        }
    ]
}

获取观看直播的统计信息

通过该接口可获取观看直播的统计信息,请求次数上限为200次/分钟,统计延迟30分钟,请在直播结束30分钟以后查询。 接口请求地址为:

https://api.csslcloud.net/api/statis/userview

注意:该接口仅支持查询2019年1月1日以后的直播

需要传递以下参数:

参数说明
liveid直播id
useridCC账户ID

JSON格式的返回信息如下:

{
    "result": "OK",
    "status": 1,
    "liveId": "xxxxxxxx",
    "maxConcurrent": 100,
    "totalCount": 1000,
    "uaCount": {
        "pc": 100,
        "mobile": 900
    },
    "customUaCount": {
        "customua1": 100,
        "customua2": 200
        ...
    }
}

返回值说明:

参数名称参数类型参数说明
result字符串请求是否成功。OK:成功;FAIL:失败
liveId字符串查询直播ID
status数字0:统计未完成,1:统计完成
maxConcurrent数字直播最大并发人数
totalCount数字总观看数
uaCount对象默认ua统计信息
pc数字默认ua统计PC观看总数
mobile数字默认ua统计Mobile观看总数
customUaCount对象用户自定义uatype统计观看数

获取单个直播回放的观看统计信息

通过该接口可以获取单个回放观看用户登录,退出行为统计。接口请求地址为:

https://api.csslcloud.net/api/statis/record/useraction

需要传入以下参数:

参数说明
recordid录制id
useridCC账户ID
starttime查询起始时间,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00"
endtime查询截止时间,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过7天
action按登录或退出行为类型查询,0表示登录,1表示退出
pageindex可选,查询页码,默认为1
pagenum可选,单页所查询的数据条数,默认为50,最大阈值为1000

返回数据包括以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count数据总条数
pageIndex当前页码
action0表示登录,1表示退出
userActions用户登录、退出行为记录

userActions包括用户的行为信息,包括以下字段:

字段名说明
userId用户Id,此Id为登录、退出行为的用户Id
userName用户登录名称
userIp用户IP地址
time用户进入或离开时间

JSON格式的返回信息如下:

 {
    "result": "OK",
    "userActions": [
        {
            "userId": "8662c8b4de7c4d758146186402e9b00b",
            "userName": "cccc",
            "userIp": "111.206.170.241",
            "time": "2019-01-03 14:11:23.0"
        },
        {
            "userId": "8662c8b4de7c4d758146186402e9b00b",
            "userName": "aaaa",
            "userIp": "111.206.170.241",
            "time": "2019-01-03 14:12:42.0"
        },
        {
            "userId": "2ab26606d60241afb1d0c09652840686",
            "userName": "abc",
            "userIp": "111.206.170.241",
            "time": "2019-01-04 09:36:13.0"
        }
    ],
    "action": 0,
    "pageIndex": 1,
    "count": 3
 }

获取所有直播回放的观看统计信息

通过该接口可以获取观看直播回放的用户登录,退出行为统计。接口请求地址为:

https://api.csslcloud.net/api/statis/user/record/useraction

需要传递以下参数:

参数说明备注
useridCC账户ID必须
starttime查询起始时间必须,格式:yyyy-MM-dd HH:mm:ss ,例:"2015-01-01 12:30:00"
endtime查询截止时间必须,格式:yyyy-MM-dd HH:mm:ss ,endtime和starttime相差不能超过1天
action按登录或退出行为类型查询,0表示登录,1表示退出
pageindex查询页码可选,默认为1
pagenum单页所查询的数据条数可选,默认为50,最大阈值为1000

返回数据包括以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count数据总条数
pageIndex当前页码
action0表示登录,1表示退出
userActions用户登录、退出行为记录

userActions包括用户的行为信息,包括以下字段:

字段名说明
recordId回放Id
roomId直播间Id
userId用户Id,此Id为登录、退出行为的用户Id
userName用户登录名称
userIp用户IP地址
time用户进入或离开的时间

JSON格式的返回信息如下:

 {
    "result": "OK",
    "userActions": [
        {
            "userId": "c0f67aec0dcd4b47a6e646653bbd7a35",
            "userName": "ccc",
            "userIp": "111.206.10.21",
            "time": "2019-01-02 14:27:46.0",
            "recordId": "D66B63F89917A1CB",
            "roomId": "82C9DDA7A237303A9C33DC5901307461"
        },
        {
            "userId": "c0f67aec0dcd4b47a6e646653bbd7a35",
            "userName": "bbb",
            "userIp": "111.206.10.21",
            "time": "2019-01-02 14:28:17.0",
            "recordId": "D66B63F89917A1CB",
            "roomId": "82C9DDA7A237303A9C33DC5901307461"
        },
        {
            "userId": "e194b87b469e441ab896ea87f2937cbf",
            "userName": "aaa",
            "userIp": "111.206.10.41",
            "time": "2019-01-02 17:19:47.0",
            "recordId": "B9344394BF816F90",
            "roomId": "086C4E55A8B5FEC19C33DC5901307461"
        }
    ],
    "action": 0,
    "pageIndex": 1,
    "count": 3
 }

获取聊天信息

通过该接口可以分页获取直播的聊天信息,接口请求地址为:

https://api.csslcloud.net/api/live/chatmsg

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
liveid直播id
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count聊天总数
chatMsgs聊天列表信息

chatMsgs包含以下字段:

字段名说明
viewerId观众id
viewerName观众名称
viewerRole观众角色(0:未统计,1:主讲,2:助教,3:主持人,4:学员)
time聊天时间
content聊天内容

JSON格式的返回信息如下:

{
      "result": "OK",
      "count": 100,
      "chatMsgs": [
          {
              "content": "粮仓到底还是满了",
              "time": "2016-11-28 20:30:33",
              "viewerName": "苍井满",
              "viewerId": "0cda7ng03j9502ian",
                "viewerRole": 0
          }
    ...
      ]
  }

获取抽奖信息

通过该接口可以分页获取直播的抽奖信息,接口请求地址为:

https://api.csslcloud.net/api/live/lotterys

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
liveid直播id
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
lotteryRoundCount抽奖轮数
lotteryRounds抽奖轮数信息

lotteryRounds包含以下字段:

字段名说明
lotteryId抽奖ID
lotteryCount中奖人数
lotteries中奖用户信息
time中奖时间
lotteryIndex中奖顺序
viewerName中奖人名称
viewerId中奖人Id
lotteryCode中奖码

JSON格式的返回信息如下:

 {
      "result": "OK",
      "lotteryRounds": [
          {
              "lotteries": [
                  {
                      "time": "2016-11-28 20:30:33",
                      "lotteryIndex": 1,
                      "viewerName": "苍井满",
                      "lotteryCode": 9876,
                      "viewerId": "0cda7ng03j9502ian"
                  }
      ...
              ],
              "lotteryCount": 10,
                "lotteryId": "20160928020202222"
          }
      ],
      "lotteryRoundCount": 8
  }

获取问答信息

通过该接口可以分页获取直播的问答信息,接口请求地址为:

https://api.csslcloud.net/api/live/qas

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
liveid直播id
pagenum每页显示的个数可选,系统默认值为50,最大值为100
pageindex页码可选,系统默认值为1

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
questionCount提问总数
questions提问列表信息

questions包含以下字段:

字段名说明
viewerId学员id
viewerName学员名称
viewerRole回答者角色(0:未统计,1:主讲,2:助教,3:主持人,4:学员)
time操作时间
content内容
answers回答列表
isPrivate是否私密回答(0:公开回答 1:私密回答)

JSON格式的返回信息如下:

{
      "result": "OK",
      "questionCount": 1,
      "questions": [
          {
        "viewerName": "铁柱",
              "viewerId": "w1c0a9n87lxcm77234mn",
              "content": "怎么质检3xing手机?",
              "time": "2016-11-28 20:30:50",
              "answers": [
                  {
                      "content": "手机充上电,OK,换下一个手机,Not OK,换下一个质检员",
                      "time": "2016-10-10 17:00:50",
                      "isPrivate": 1,
                      "viewerName": "全蛋",
                      "viewerId": "7a9n4m8w1c07lx2cm73n",
                        "viewerRole": 0
                  }
          ...
              ]
          }
    ...
      ]
  }

获取签到信息

通过该接口可以获取直播的签到信息,接口请求地址为:

https://api.csslcloud.net/api/live/rollcall

需要传递以下参数:

参数说明备注
roomid直播间id
useridCC账户ID
liveid直播id

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
count签到次数
rollcalls签到列表信息

rollcalls包含以下字段:

字段名说明
totalNum总人数
duration签到时长
time操作时间
rollcallId签到ID
checkedNum签到人数

JSON格式的返回信息如下:

{
      "result": "OK",
      "count": 4,
      "rollcalls": [
          {
              "totalNum": 3,
              "duration": 10,
              "time": "2016-11-28 20:20:20",
              "rollcallId": "13358DE27D943A99",
              "checkedNum": 0
          }
    ...
      ]
  }

获取签到用户信息

通过该接口获取签到用户信息,接口请求地址为:

https://api.csslcloud.net/api/v2/live/rollcall/viewers

需要传递以下参数:

参数说明
roomid直播间id
useridCC账户ID
liveid直播id
rollcallid签到ID
pageindex可选,查询页码,默认为1
pagenum可选,单页所查询的数据条数,默认为50,最大阈值为100

返回数据包含以下字段:

字段名说明
result请求是否成功。OK:成功;FAIL:失败
viewers签到用户列表信息

viewers包含以下字段:

字段名说明
viewerId观看者ID
viewerName观看者名称
checked是否签到,1:签到,0:未签到

JSON格式的返回信息如下:

  {
    "result": "OK",
    "viewers": [
        {
            "viewerName": "铁柱",
            "viewerId": "a9a589134a2e4037938d85a63cfb28bb",
            "checked": 0
        },
        ...
    ],
    "pageIndex": 1,
    "count": 10
  }

获取问卷信息

通过该接口获取问卷信息,接口请求地址为:

https://api.csslcloud.net/api/live/questionnaires

需要传递以下参数:

参数说明备注
useridCC账户ID必须
liveid直播id必须

返回数据:

{
    "result": "OK",
    "questionnaires": [{ // 问卷信息
        "id": "8CF77A91E659162F", // 问卷ID
        "title": "用户问卷调查", // 问卷题目
        "submitAnswerViewerCount": 100, // 交卷总人数
        "subjects": [{ // 问卷题目信息
            "id": "C91F302B7655688E", // 题目ID
            "index": 0, // 题目索引
            "content": "性别?", // 题目内容
            "type": 0, // 题目类型:0单选,1多选,2问答
            "options": [{ // 选项
                "id": "64367D8CDD368AE3", // 选项ID
                "index": 0, // 选项索引
                "content": "男", // 选项内容
                "correct": 0, // 是否正确
                "selectedCount": 100 // 选择该项的人数
            },{
                "id": "906B22CC9DEA925D",
                "index": 1,
                "content": "女",
                "correct": 0,
                "selectedCount": 200
            },{
                "id": "C1CC3275BBCE7F35",
                "index": 2,
                "content": "保密",
                "correct": 1,
                "selectedCount": 300
            }]
        },{
            "id": "C91F302B7655688E",
            "index": 1,
            "content": "掌握的编程语言?",
            "type": 1,
            "options": [{
                "id": "0BB798B9190A7C25",
                "index": 0,
                "content": "Java",
                "correct": 0,
                "selectedCount": 1000
            },{
                "id": "7EFD4A88DEF569AC",
                "index": 1,
                "content": "Python",
                "correct": 0,
                "selectedCount": 2000
            },{
                "id": "CB5F16DD59540FBC",
                "index": 2,
                "content": "Go",
                "correct": 1,
                "selectedCount": 2000
            },{
                "id": "0AC802A9B58C5E83",
                "index": 3,
                "content": "JavaScript",
                "correct": 1,
                "selectedCount": 2020
            }]
        },{
            "id": "10EB3D79A0CAD63E",
            "index": 2,
            "content": "其他技能?",
            "type": 1
        }]
    }

获取用户答卷信息

通过该接口获取用户答卷信息,接口请求地址为:

https://api.csslcloud.net/api/live/questionnaire/viewers

需要传递以下参数:

参数说明备注
useridCC账户ID必须
liveid直播id必须
questionnaireid问卷ID必须
pageindex页码可选,默认1
pagenum每页显示的个数可选,单页所查询的数据条数,默认为50,最大阈值为500

返回数据:

{
    "result": "OK",
    "submitAnswerViewerCount": 1, // 提交的总人数
    "pageNum": 100,
    "pageIndex": 1,
    "viewers": [{ // 学员提交问卷的详细信息
        "id": "9c2ea7b260824f1d8e", // 学员ID
        "name": "小明", // 学员名称
        "submitTime": "2017-03-31 10:57:31", // 学员提交时间
        "answers": [{ // 学员提交答案信息
            "subjectId": "C91F302B7655688E", // 题目ID
            "selectedOptionId": "64367D8CDD368AE3" // 选择选项ID
        },{
            "subjectId": "C91F302B7655688E",
            "selectedOptionIds": "0BB798B9190A7C25,7EFD4A88DEF569AC,CB5F16DD59540FBC,0AC802A9B58C5E83"
        },{
            "subjectId": "10EB3D79A0CAD63E",
            "answerContent": "云和分布式计算, 统计分析和数据挖掘, Web架构和开发框架, 中间件和集成软, 用户界面设计, 网络和信息安全, 移动开发, SEO/SEM营销, 存储系统和管理"
        }]
        }
    ]
}

获取随堂测信息

通过该接口获取随堂测信息,请求接口地址:

https://api.csslcloud.net/api/practice/info

需要传递以下参数:

参数说明备注
useridCC账户ID必须
liveid直播id必须
pageindex页码可选,默认1
pagenum每页显示的个数可选,单页所查询的数据条数,默认100 区间[1~1000]

返回参数示例及说明: 成功:

{
    "result": "OK",
    "count": 1231, // 总共发布了多少次随堂测
    "pageIndex": 1, // 第几页
    "practices": [ // 随堂测信息
      {
          "id": "2482038403", // 随堂测ID
          "publishTime": "2019-01-12 14:35:12", // 发布时间
          "type": 2, // 随堂测类型 判断:0,单选:1,多选:2  
          "options": [ // 随堂测选项信息
              {
                  "index": 0, // 选项索引
                  "isCorrect": 1 // 选项是否为正确答案 0 错误 1 正确
              },
              {
                  "index": 1, // 选项索引
                  "isCorrect": 1 // 选项是否为正确答案 0 错误 1 正确
              },
              {
                  "index": 2, // 选项索引
                  "isCorrect": 0 // 选项是否为正确答案 0 错误 1 正确
              }
          ]
      }
    ]
}

失败:

{
    "result": "FAIL",
    "reason": "错误原因"
}

获取用户提交随堂测信息

通过该接口可以获取用户提交随堂测信息,接口请求地址:

https://api.csslcloud.net/api/practice/submit/info

需要传递以下参数:

参数说明备注
useridCC账户ID必须
liveid直播id必须
practiceid随堂测ID必须
pageindex页码可选,默认1
pagenum每页显示的个数可选,单页所查询的数据条数,默认100 区间[1~1000]

返回参数示例及说明: 成功:

{
    "result": "OK",
    "count": 1231, // 总共有多少个用户提交答案
    "pageIndex": 1, // 第几页
    "submitDatas": [
         {
             "viewerId": "432842804", // 观看者ID
             "viewerName": "zhangfei", // 观看者昵称
             "submitTime": "2019-01-12 15:12:34", // 提交时间
             "submitOptions": [0,1,2,3] // 提交的选项索引
         }
    ]
}

失败:

{
    "result": "FAIL",
    "reason": "具体错误原因" 
}

获取直播打卡信息

通过该接口获取直播打卡信息,请求接口地址:

https://api.csslcloud.net/api/punch/list

需要传递以下参数:

参数名称是否必须备注
accountId账户id
liveId加密直播ID
pageIndex分页页码,最小值为1,默认值为1。
pageSize分页大小,最小值为1,最大值为100,默认值为100。

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须
errorobject非必须
├─ codestring必须错误代码。
├─ messagestring必须错误描述。
dataobject非必须
├─ countnumber必须
├─ punchesobject []必须

item 类型: object

├─ idstring必须打卡ID。
├─ publisherIdstring必须发起者 ID。
├─ publisherNamestring必须发起者名称。
├─ createTimestring必须打卡开始时间,格式yyyy-MM-dd HH:mm:ss。
├─ expireTimestring非必须打卡到期时间,格式 yyyy-MM-dd HH:mm:ss。打卡无到期时间时,此项不存在。
├─ allowLaterboolean必须是否允许后进入者参与打卡。
├─ isFinishboolean必须打卡互动是否结束。
├─ finishTimestring非必须打卡结束时间,格式yyyy-MM-dd HH:mm:ss。isFinish=true 时必须。
├─ totalnumber必须应打卡人数。
├─ punchednumber必须实际打卡人数。isFinish=false 时,此值为0,无意义。

获取用户打卡记录

通过该接口可以获取用户打卡记录信息,接口请求地址:

https://api.csslcloud.net/api/punch/detail

需要传递以下参数:

参数名称是否必须备注
accountId账户id
punchId打卡 ID。
pageIndex分页页码,最小值为1,默认值为1。
pageSize分页大小,最小值为1,最大值为100,默认值为100。

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须接口处理结果。
errorobject非必须失败时的错误信息,success=false时必须。
├─ codenumber必须错误代码。
├─ messagestring必须错误描述。
dataobject非必须成功时返回的数据,success=true时必须。
├─ punchobject必须打卡信息。
├─ idstring必须打卡ID。
├─ publisherIdstring必须发起者 ID。
├─ publisherNamestring必须发起者名称。
├─ createTimestring必须打卡开始时间,格式yyyy-MM-dd HH:mm:ss。
├─ totalnumber必须应打卡人数。
├─ punchednumber必须实际打卡人数。
├─ durationnumber必须打卡持续时间,单位:秒。 无过期时间时,返回完成时间和开始时间的差。 若有过期时间,返回完成时间和开始时间的差和过期时间和开始时间的差之间较小的值
├─ punchViewersobject []必须参与打卡学员列表,按分页返回。

item 类型: object

├─ idstring必须学员 ID。
├─ namestring必须学员名称。
├─ createTimestring必须参与打卡时间,格式yyyy-MM-dd HH:mm:ss。
├─ isPunchedboolean必须是否打卡。
├─ punchTimestring非必须打卡时间,格式yyyy-MM-dd HH:mm:ss。isPunched=true 时必须。

查询账户回调配置

通过该接口可以查询账户回调配置信息,接口请求地址:

https://api.csslcloud.net/api/v1/callbacks

需要传递以下参数:

参数名称是否必须示例备注
accountIdC783F0F7CB77E1F3用户账户id

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须true/false
errorobject非必须
├─ codestring非必须10000004
├─ messagestring非必须invalid thqs
dataobject非必须
├─ callbacksobject []非必须

item 类型: object

├─ notifyUrlstring非必须回调通知地址
├─ typenumber非必须回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用 6回放重制回调 其他值未知
├─ statusnumber非必须状态标识,0禁用,1启用

修改账号回调配置

通过该接口可以修改账号回调配置信息,接口请求地址:

https://api.csslcloud.net/api/v1/callbacks/save

Method: POST

需要传递以下参数:

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json;charset=UTF-8application/json;charset=UTF-8请求类型,必须是:application/json;charset=UTF-8

Query

参数名称是否必须示例备注
accountIdC783F0F7CB77E1F3用户账户id

Body

名称类型是否必须默认值备注其他信息
object []必须数组

item 类型: object

├─ statusnumber必须状态标识,0禁用,1启用
├─ notifyUrlstring必须回调地址
├─ typenumber必须回调类型 1:直播结束回调, 2:录制完成回调, 3:直播开始回调, 4:离线回放打包完成回调, 5:废弃不再使用,请不要使用 6回放重制回调

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须true/false
errorobject非必须
├─ codenumber非必须10000004
├─ messagestring非必须invalid thqs

创建回放重制任务

通过该接口可以创建回放重制任务,接口请求地址:

https://api.csslcloud.net/api/v1/replay/composition/batchAdd

注意事项:

使用该接口需开通回放重制权限,且回放重制可用时长大于0;

回放重制仅支持文档模板的回放,大屏模版的回放不支持重制;

批量创建任务时,若回放id中有一个无法通过以下校验则全部添加失败

  • 不合法回放id
  • 非文档模板的回放
  • 正在重制中的回放id
  • 回放状态不可用

需要传递以下参数:

参数名称是否必须示例备注
accountIdC783F0F7CB77E1F3用户账户id
replayIdsA1976C7867397461,A1976C76733D07461回放id,用都逗号分割字符串,回放id数量在1到10之间

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须true/false
dataobject非必须
├─ successReplaysobject []非必须

item 类型: object

├─ replayIdstring非必须成功的回放id
├─ replayCompositionIdstring非必须回放重制id
errorobject非必须
├─ codestring非必须10000000
├─ messagestring非必须Invalid Params

查询回放重制任务信息

通过该接口可以查询回放重制任务信息,接口请求地址:

https://api.csslcloud.net/api/v1/replay/composition/get

需要传递以下参数:

参数名称是否必须示例备注
accountIdC783F0F7CB77E1F3用户账户id
replayCompositionId47aef2d7-c03d-4894-adb2-bb399ab20960回放重制id,添加接口返回id

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须true/false
dataobject非必须
├─ compositionobject非必须
├─ replayCompositionIdstring非必须回放重制id,添加任务接口返回
├─ accountIdstring非必须用户账户id
├─ replayIdstring非必须回放id
├─ roomIdstring非必须房间id
├─ videoIdstring非必须视频id,status值为5时存在值
├─ titlestring非必须标题
├─ durationnumber非必须时长,status值不为5时,duration值为0
├─ beginTimestring非必须重制开始时间
├─ statusnumber非必须重制状态,1重制中,5重制成功,-1重制失败,其他值未知
├─ videoDownLoadUrlstring非必须回放重制成功后视频下载地址
errorobject非必须
├─ codestring非必须10000014
├─ messagestring非必须exist invalid param

查询回放重制列表信息

通过该接口可以查询回放重制任务列表信息,接口请求地址:

 https://api.csslcloud.net/api/v1/replay/composition/find

需要传递以下参数:

参数名称是否必须示例备注
accountIdC783F0F7CB77E1F3用户账户加密id
startTime2020-11-25 12:12:12开始时间,格式:yyyy-MM-dd HH:mm:ss,需要与结束时间成对存在,开始结束时间范围不能大于7天
endTime2020-11-27 12:12:12结束时间,格式:yyyy-MM-dd HH:mm:ss需要与开始时间成对存在,开始结束时间范围不能大于7天
pageNo1页码,默认1
pageSize50每页数量,默认值50,最大值50
searchType1查询类型 1:回放ID 2:视频ID 3:直播间ID,只有searchId存在值并且格式合法时才会检查类型
searchId3688DC7A99D6FAEF根据查询类型传入对应查询id
searchStatus5查询状态 重制中 1 成功 5 失败 -1 其它值 未知

返回数据说明:

名称类型是否必须默认值备注其他信息
successboolean必须true/false
errorobject非必须
├─ codeinteger非必须10000014
├─ messagestring非必须exist invalid param
dataobject非必须
├─ compositionsobject []非必须

item 类型: object

├─ replayCompositionIdstring非必须回放重制id,添加回放重制任务后返回的id
├─ accountIdstring非必须用户账户id
├─ replayIdstring非必须回放id
├─ roomIdstring非必须直播间id
├─ videoIdstring非必须视频id,status值为5时存在值
├─ titlestring非必须标题
├─ durationnumber非必须时长,单位:秒,status值不为5时,其值为0
├─ beginTimestring非必须开始时间
├─ statusnumber非必须状态,1 重制中,5重制成功,-1失败,其它值 未知
├─ paginationobject非必须
├─ pageNonumber非必须页码
├─ pageSizenumber非必须每页数量
├─ totalCountnumber非必须总数
├─ pageCountnumber非必须总页数