HTTP接口

创建直播间

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

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

需要传递以下参数：

返回数据包含如下字段：

room包含如下字段：

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

需要传递以下参数：

secondaryViewerLimitItems包含以下字段：

secondaryVerifySetting包含以下字段：

JSON格式的返回信息如下：

{
  "result": "OK"
}

关闭直播间

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

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

需要传递以下参数：

JSON格式的返回信息如下：

{
  "result": "OK"
}

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

开启直播间

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

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

需要传递以下参数：

JSON格式的返回信息如下：

{
  "result": "OK"
}

删除直播间

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

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

需要传递以下参数：

JSON格式的返回信息如下：

{
  "result": "OK"
}

获取直播间列表

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

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

需要传递以下参数：

返回数据包含以下字段：

rooms包含多个直播间信息，直播间包含以下字段：

JSON格式的返回信息如下：

{
  "result": "OK",
  "pageIndex": 1,
  "count": 1,
  "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

需要传递以下参数：

返回数据包含如下字段：

room包含以下字段：

seminarSettings包含以下字段：

secondaryViewerLimitItems包含以下字段：

secondaryVerifySetting包含以下字段：

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",
        "marFontSize":20,
        "marFontSpeed":"1.0",
        "marFontColor":"#ffffff",
        "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
        ],
        "secondaryVerifySwitch":"1",
        "secondaryViewerLimitTitle":"欢迎观看本次直播",
        "secondaryViewerLimitEntryText":"进入直播",
        "secondaryViewerLimitItems":"[{\"typeStr\":\"nickName\",\"title\":\"昵称\",\"content\":\"请输入昵称\"},{\"typeStr\":\"pass\",\"title\":\"观众密码\",\"content\":\"请输入观众密码\",\"passwordTypeStr\":\"password\"}]",
        "secondaryVerifySetting":"{\"accountId\":\"AF58B89EF2C17DA4\",\"roomId\":\"01352D302200B1A79C33DC5901307461\",\"loginType\":1,\"password\":\"123\"}",
        "unlimitedShowPage": "0",
        "commonPhrasesSwitch":"0"
    }
}

获取直播列表

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

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

需要传递以下参数：

返回数据包含以下字段：

lives包含以下字段：

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

需要传递以下参数：

JSON格式的返回信息如下：

{
  "result": "OK"
}

查询回放列表

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

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

需要传递以下参数：

返回数据包含以下字段：

records包含以下字段：

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": "回放描述"，
      "encryptOfflinePackageUrl": "http://yyy",
      "desc": "14,11,8,122,0,127,12,125,0,124,120,124,9,0,1"
    },
    ...
  ]
}

查询回放信息

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

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

需要传递以下参数：

返回数据包含以下字段：

record包含以下字段：

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",
    "duration": 3600,
    "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": "回放描述"，
    "encryptOfflinePackageUrl": "http://yyy",
    "desc": "14,11,8,122,0,127,12,125,0,124,120,124,9,0,1"

  }
}

合并回放

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

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

需要传递以下参数：

返回数据：

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

编辑回放

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

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

需要传递以下参数：

返回数据包含以下字段：

JSON格式的返回信息如下：

{
  "result": "OK"
}

删除回放

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

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

需要传递以下参数：

返回数据包含以下字段：

JSON格式的返回信息如下：

{
  "result": "OK"
}

获取回放视频直播聊天记录列表

通过该接口获取指定回放视频在直播时的聊天记录，接口请求地址为:

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

需要传递以下参数：

管理回放视频直播聊天记录

通过该接口管理回放视频在直播时的聊天的显示与隐藏. 接口请求地址为:

https://api.csslcloud.net/api/v2/record/chat/manage

需要传递以下参数：

查询回放字幕信息

基本信息

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

请求方式： GET 请求参数

返回数据

回放字幕开关设置

字幕开关打开，并且字幕已经转写完成，回放中会有字幕显示，关闭字幕，回放中不会显示字幕。 如果字幕没有转写完成或者没有在点播上传字幕，字幕开关打开，回放页不会显示字幕

  https://api.csslcloud.net/api/record/subtitles/set

请求方式： GET

请求参数

回放生成字幕

  https://api.csslcloud.net/api/record/subtitles/create

请求方式： GET

请求参数

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

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

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

需要传递以下参数：

返回数据包含以下字段：

房间列表含有以下字段：

JSON格式的返回信息如下：

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

获取直播间直播状态

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

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

需要传递以下参数：

JSON格式的返回信息如下：

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

返回信息：

获取直播间连接数

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

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

需要传递以下参数：

返回字段包含以下字段：

connections包含以下字段：

JSON格式的返回信息如下：

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

获取直播间模板信息

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

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

需要传递以下参数：

返回数据包含以下字段：

viewTemplates包含多个模板信息，模板信息包含一些字段：

JSON格式的返回信息如下：

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

获取直播间代码

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

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

需要传递以下参数：

返回数据包含以下字段：

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

需要传入以下参数：

返回数据包括以下字段：

userActions包括用户的行为信息，包括以下字段：

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日以后的直播

返回值说明：

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,
      "terminalType": "Mac",
      "operatingSystem": "Mac OS",
      "browser": "Chrome 121.0.0.0",
      "device": "Mac",
      "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": 1,
      "terminalType": "H5-微信",
      "operatingSystem": "Android",
      "browser": "微信",
      "device": "Xiaomi",
      "customInfo": "",
      "userRole": 4
    }
  ],
  "pageIndex": 1,
  "count": 2
}

获取直播互动的统计信息

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

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

返回值说明：

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,
      "punchCount": 0,
      "watchTimeStr": "0时01分37秒"
    },
    {
      "viewerId": "300227588049",
      "viewerName": "web空 ",
      "watchTime": 223,
      "enterLeaveCount": 1,
      "chatCount": 0,
      "questionCount": 0,
      "rollcallCount": 0,
      "questionnaireCount": 0,
      "classroomExaminationCount": 0,
      "punchCount": 0,
      "watchTimeStr": "0时01分37秒"
    }
  ]
}

获取观看直播的统计信息

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

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

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

需要传递以下参数：

JSON格式的返回信息如下：

{
  "result": "OK",
  "status": 1,
  "liveId": "xxxxxxxx",
  "maxConcurrent": 100,
  "maxConcurrentTime": "2021-06-18 15:58:14",
  "totalCount": 1000,
  "uaCount": {
    "pc": 100,
    "mobile": 900
  },
  "customUaCount": {
    "customua1": 100,
    "customua2": 200
    ...
  }
}

返回值说明：

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

通过该接口可以获取单个回放观看用户登录，退出行为统计（仅支持获取最近一年内的数据）。接口请求地址为:

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

需要传入以下参数：

返回数据包括以下字段：

userActions包括用户的行为信息，包括以下字段：

JSON格式的返回信息如下：

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

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

通过该接口可以获取观看直播回放的用户登录，退出行为统计（仅支持获取最近一年内的数据）。接口请求地址为：

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

需要传递以下参数：

返回数据包括以下字段：

userActions包括用户的行为信息，包括以下字段：

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",
      "UAType": 1,
      "socketId": "6TtduOdVCFjG3shJAKkv"
    },
    {
      "userId": "c0f67aec0dcd4b47a6e646653bbd7a35",
      "userName": "bbb",
      "userIp": "111.206.10.21",
      "time": "2019-01-02 14:28:17.0",
      "recordId": "D66B63F89917A1CB",
      "roomId": "82C9DDA7A237303A9C33DC5901307461",
      "UAType": 1,
      "socketId": "XImavxYecG-Q9_R2BYbA"
    },
    {
      "userId": "e194b87b469e441ab896ea87f2937cbf",
      "userName": "aaa",
      "userIp": "111.206.10.41",
      "time": "2019-01-02 17:19:47.0",
      "recordId": "B9344394BF816F90",
      "roomId": "086C4E55A8B5FEC19C33DC5901307461",
      "UAType": 1,
      "socketId": "u0-9FjWsZKpPcFivFLMr"
    }
  ],
  "action": 0,
  "pageIndex": 1,
  "count": 3
}

获取聊天信息

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

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

需要传递以下参数：

返回数据包含以下字段：

chatMsgs包含以下字段：

JSON格式的返回信息如下：

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

获取抽奖信息

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

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

需要传递以下参数：

返回数据包含以下字段：

lotteryRounds包含以下字段：

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
}

获取抽奖信息2.0

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

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

需要传递以下参数：

返回数据包含以下字段：

获取问答信息

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

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

需要传递以下参数：

返回数据包含以下字段：

questions包含以下字段：

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

需要传递以下参数：

返回数据包含以下字段：

rollcalls包含以下字段：

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

需要传递以下参数：

返回数据包含以下字段：

viewers包含以下字段：

JSON格式的返回信息如下：

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

获取问卷信息

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

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

需要传递以下参数：

返回数据：

{
    "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

需要传递以下参数：

返回数据：

{
    "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

需要传递以下参数：

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

{
  "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

需要传递以下参数：

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

{
  "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

需要传递以下参数：

返回数据说明：

获取用户打卡记录

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

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

需要传递以下参数：

返回数据说明：

查询账户回调配置

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

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

需要传递以下参数：

返回数据说明：

修改账号回调配置

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

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

Method： POST

需要传递以下参数：

Headers

Query

Body

返回数据说明：

创建回放重制任务

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

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

注意事项：

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

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

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

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

需要传递以下参数：

返回数据说明：

查询回放重制任务信息

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

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

需要传递以下参数：

返回数据说明：

查询回放重制列表信息

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

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

需要传递以下参数：

返回数据说明：

增加/编辑回放打点

基本信息

Path： /api/replay/mark/point/save

Method： GET

接口描述：

请求参数

Query

返回数据

查询回放打点列表

通过该接口可以查询回放打点信息，接口请求地址：

https://api.csslcloud.net/api/replay/mark/search

需要传递以下参数：

返回数据：

删除回放打点

基本信息

Path： /api/replay/mark/point/delete

Method： GET

接口描述：

请求参数

Query

返回数据

回放剪辑

通过该接口可以发起回放剪辑任务，接口请求地址：

https://api.csslcloud.net/api/v1/record/clip/create

需要传递以下参数：

返回数据：

回放观看记录（V2版本）

基本信息

Path： https://api.csslcloud.net/api/v2/replay/watch/record

Method： GET

接口描述：

通过该接口可以查询2021-07-01日之后的账号下回放观看记录记录；
注意：最大查询时间间隔 1天；返回数据中无leaveTime表示登录回放后未退出
接口加密方式：THQS加密

请求参数

Query

返回数据

回放观看记录(根据skipId翻页)

基本信息

Path： /api/replay/user-action/skip

Method： GET

接口描述：

通过该接口可以查询账号下回放观看记录记录；
注意：最大查询时间间隔 1天；
接口加密方式：THQS加密

请求参数

Query

返回数据

全局礼物打赏配置

基本信息

Path： https://api.csslcloud.net/api/global/gift/setting/save

Method： POST

接口描述：

通过该接口可以开启或关闭全局礼物打赏开关，直播间通过引用全局礼物开关开启礼物打赏配置；
接口加密方式：THQS加密

请求参数

Query

返回数据

创建账号礼物打赏信息和修改账号礼物打赏信息

基本信息

Path： https://api.csslcloud.net/api/gift/config/save

Method： POST

接口描述：

通过该接口可以创建账号的礼物打赏信息和修改账号礼物打赏信息；
接口加密方式：THQS加密 （仅Query参数需要THQS加密）

请求参数

Query

Headers

Body

返回数据

删除账号礼物打赏配置

基本信息

Path： https://api.csslcloud.net/api/gift/config/delete

Method： POST

接口描述：

通过该接口可以根据礼物id删除账号的礼物打赏配置 注意：默认礼物打赏信息不可以删除
接口加密方式：THQS加密

请求参数

Query

返回数据

礼物打赏配置查询

基本信息

Path： https://api.csslcloud.net/api/gift/config

Method： GET

接口描述：

通过该接口可以根据账号id查询账号的礼物打赏配置信息
接口加密方式：THQS加密

请求参数

Query

返回数据

修改礼物打赏特效

基本信息

Path： https://api.csslcloud.net/api/gift/effects/update

Method： POST

接口描述：

通过该接口可以修改礼物打赏的显示特效
接口加密方式：THQS加密

请求参数

Query

返回数据

直播间点赞配置查询

基本信息

Path： https://api.csslcloud.net/api/like/config

Method： GET

接口描述：

通过该接口可以查询直播间的点赞配置信息
接口加密方式：THQS加密

请求参数

Query

返回数据

直播间点赞配置编辑

基本信息

Path： https://api.csslcloud.net/api/like/config/update

Method： POST

接口描述：

通过该接口可以编辑直播间的点赞配置信息
接口加密方式：THQS加密 （仅Query参数需THQS加密）

请求参数

Query

Headers

Body

返回数据

客户端信息上报数据查询

基本信息

Path： https://api.csslcloud.net/api/live/report/info

Method： GET

接口描述：

通过该接口可以查询客户端直播时上报的设备信息
接口加密方式：THQS加密

请求参数

Query

返回数据

JSON格式的返回信息如下：

{
    "success":true,
    "data":{
        "systemVersion":"Windows 10 (10.0)",
        "sdkVersion":"windows-app-5.8.2.11",
        "reportInfos":[
            {
                "resolution":{
                    "h":720,
                    "w":1280
                },
                "time":1660185425161,
                "memoryTotal":8014,
                "memoryUse":226,
                "memoryFree":2225,
                "frameRate":20,
                "lostFrameRate":0,
                "bitRate":500,
                "cpu":4.1041340827941895
            },
            {
                "resolution":{
                    "h":720,
                    "w":1280
                },
                "time":1660185426162,
                "memoryTotal":8014,
                "memoryUse":226,
                "memoryFree":2225,
                "frameRate":20,
                "lostFrameRate":0,
                "bitRate":500,
                "cpu":3.708439588546753
            },
            {
                "resolution":{
                    "h":720,
                    "w":1280
                },
                "time":1660185427162,
                "memoryTotal":8014,
                "memoryUse":226,
                "memoryFree":2226,
                "frameRate":20,
                "lostFrameRate":0,
                "bitRate":500,
                "cpu":3.3223042488098145
            }
        ]
    }
}

获取直播间直播用户的访问记录

基本信息

Path： https://api.csslcloud.net/api/live/user/useraction

Method： GET

接口描述：

通过该接口可以通过直播间ID获取观看直播的访问记录
接口加密方式：THQS加密

请求参数

Query

返回数据