云课回放统计

日期: 2022-12-14

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

[TOC]

1. 最高在线人数

描述:

1. 查看用户的某段时间内的最高在线人数(参数userid, start_time, end_time)
2. 查看某场直播的最高在线人数(参数userid, liveid)

地址:

 https://ccapi.csslcloud.net/collect/max_parallel/

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
liveid 字符串 直播ID 可选
start_time 字符串 开始时间(%Y-%M-%D) 可选
end_time 字符串 开始时间(%Y-%M-%D) 可选

返回示例:

{
    "result": "OK",  # 失败 FAIL
    "data": {
        "max_parallel": 2132
        "time": "2018-09-02 12:30:22"
    },
    "error_msg": ""
}

2. 一场直播的累积在线人数

描述:

一场直播的累积在线人数

地址:

 https://ccapi.csslcloud.net/collect/live/usercount/

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
liveid 字符串 直播ID 必须

返回示例:

{
    "result": "OK",  # 失败 FAIL
    "data": {
        "livecount": 2132
    },
    "error_msg": ""
}

3. 一场直播的实际时长

描述:

一场直播的实际时长

地址:

 https://ccapi.csslcloud.net/collect/live/duration/

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
liveid 字符串 直播ID 必须

返回示例:

{

    "result": "OK",  # 失败 FAIL
    "data": {
        "duration": 2 #小时
        "start_time":  "2018-05-09 10:00:00 "
        "end_time": "2018-05-09 12:00:00"
    },
    "error_msg": ""
}

4.获取一场直播的进出记录

描述:

获取一场直播的进出记录

地址:

https://ccapi.csslcloud.net/collect/live/user/record/

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 必须
viewerid 字符串 学员ID 可选

返回示例:

{
    "roomid": "4C05DAC8965BE2029C33DC5901307461",
    "liveid": "2273B106A25921C9",
    "result": "OK",  # 失败 FAIL
    "data":[{
        "username": "guojia"，  # 名字
        "viewerid": "ea5e26c98df94e49bb399c477438d7f7"，    #  用户的id号
        "role":"talker"，      #角色
        "ip":  "116.226.32.202"，       #IP
        "platform"："web"，   #设备
        "enter_time"："2017-09-12 16:22:43 "，  #进入时间
        "exit_time"："2017-09-12 17:22:43 "，    #退出时间
        "duration"：3600，    #时长,单位(秒)
    }

    ],
    "error_msg": ""
}

5.获取一场直播的聊天记录

描述:

获取一场直播的聊天记录

地址:

https://ccapi.csslcloud.net/collect/live/chat/record/

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 必须

返回示例:

{
    "roomid": "4C05DAC8965BE2029C33DC5901307461",
    "liveid": "2273B106A25921C9",
    "result": "OK",  # 失败 FAIL
    "data":[
        {
            "id": 123，                  #直播聊天记录的id
            "timestamp’:  "2019-02-18 17:22:50",  # 聊天记录时间戳
            "username": "sss",  # 学员名称
            "content": "sdffs", # 聊天内容
            "chat_userid": "81d5a1f1bbcb4edb9e1c52e9d75417f4" # 学员ID
        }

    ],
    "error_msg": ""
}

6. 获取用户的直播记录

描述:

获取用户的直播记录

地址:

 https://ccapi.csslcloud.net/collect/live/record

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 可选
start_time 字符串 开始时间(2019-01-02 00:00) 必选
end_time 字符串 开始时间(2019-01-03 00:00) 必选
page_size 整型 第几页，默认为1 可选
page_length 整型 一页条数，默认为20 可选

返回示例:

{
    "page_size": 2,
    "result": "OK",
    "data": [
        {
            "end_time": "2019-02-27 10:51:38",
            "room_type": 3,
            "userid": "9DC1A878A164F696",
            "roomid": "3BDDBEB6C2269ABE9C33DC5901307461",
            "class_name": "wang-double-test5",
            "liveid": "C40FD4FA8D9B07C6",
            "start_time": "2019-02-26 16:44:04"
        },
        {
            "end_time": "2019-02-27 10:51:38",
            "room_type": 2,
            "userid": "9DC1A878A164F696",
            "roomid": "6944167A1D980FD89C33DC5901307461",
            "class_name": "wang-double-test-assistant",
            "liveid": "B3CA023FB07A5375",
            "start_time": "2019-02-26 20:10:18"
        }
    ],
    "page_length": 20,
    "page_count": 2,
    "error_msg": ""
}

7. 获取头脑风暴历史信息

描述:

获取头脑风暴历史信息

地址:

 https://ccapi.csslcloud.net/collect/brainstom/record

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 可选
page_size 整型 第几页，默认为1 可选
page_length 整型 一页条数，默认为20 可选

返回示例:

{
    "page_length":20,
    "page_count":1,
    "data":[
        {
            "reply_data":[
                {
                    "content":"werwerwe",
                    "uid":"d44fda4f15a14b92a733b237d957611f",
                    "uname":"ddd"
                }
            ],
            "publish_data":{
                "content":"fsdfsdf",
                "brainsstom_id":"f80894a2114c3304f5aed16ea10854d3",
                "publish_time":"2019-01-30 14:05:54",
                "roomid":"4C05DAC8965BE2029C33DC5901307461",
                "title":"wefw",
                "uid":"368d5101f74640d2a01efb9da770dceb",
                "liveid":"96AC5FB6817E01DC",
                "uname":"sss"
            }
        }
    ],
    "result":"OK",
    "page_size":1,
    "error_msg":""
}

8. 获取投票历史信息

描述:

获取投票历史信息

地址:

 https://ccapi.csslcloud.net/collect/vote/record

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 可选
page_size 整型 第几页，默认为1 可选
page_length 整型 一页条数，默认为20 可选

返回示例:

{
    "page_length": 20,
    "page_count": 1,
    "data": [

        {
            "reply_data": [
                {
                    "uid": "d44fda4f15a14b92a733b237d957611f",
                    "choices": [
                        1
                    ],
                    "uname": "ddd"
                }
            ],
            "publish_data": {
                "style": 0,
                "choices": [
                    "fdg",
                    "fsdf",
                    "wef"
                ],
                "publish_time": "2019-01-30 15:53:40",
                "roomid": "4C05DAC8965BE2029C33DC5901307461",
                "vote_id": "9d84f73d05bd4d930d97b01840796c5c",
                "title": "we",
                "uid": "24140669d42843a8b0c58e8338ab8382",
                "liveid": "96AC5FB6817E01DC",
                "uname": "aaa"
            }
        }
    ],
    "result": "OK",
    "page_size": 1,
    "error_msg": ""
}

9. 获取答题卡历史信息

描述:

获取答题卡历史信息

地址:

 https://ccapi.csslcloud.net//collect/answercard/record

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 可选
page_size 整型 第几页，默认为1 可选
page_length 整型 一页条数，默认为20 可选

返回示例:

{
    "result": "OK",  # 失败 FAIL
    "data":[ {
        "publish_data":{
            "qvote_id": "123444422"  # 投票唯一标识,
            "uid": "eddd221" # 发布者ID,
            "style":  "0/1" # 0 单选 1 多选
            "count": 4  # 选项个数
            "publish_time": "发布时间"
            "liveid": "1234" # 直播id
            "correct": [0]/[0,1]/[-1] # -1说明老师没发布答案
        }，
        "reply_data": [
            {"uid": "sdeew" # 学生ID,  "choice": [0]/[0,1] # 回答内容, "reply_time": "2018-05-03 22:10:20"},

        ]
    }],
    "page_size": 2 # 当前第几页
    "page_length": 20 # 一页多少条
    "page_count": 4 # 共几页
    "error_msg": ""
}

10.获取直播发奖记录

描述:

获取直播记录发奖记录

地址:

 https://ccapi.csslcloud.net/collect/reward/record

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 必须
page_size 整型 第几页，默认为1 可选
page_length 整型 一页条数，默认为20 可选

返回示例:

{
    "page_size": 1,
    "page_count": 1,
    "error_msg": "",
    "result": "OK",
    "page_length": 20,
    "data": [
        {
            "reward_time": "2019-02-19 11:56:03",
            "uname": "ddd",
            "liveid": "EA0A5DF952F42A0C",
            "type": "cup",
            "uid": "bf20806bfecc4955adb6050ecfdb77d0",
            "roomid": "4C05DAC8965BE2029C33DC5901307461"
        }
    ]
}

11.获取直播汇总数据

描述:

获取直播汇总数据

地址:

 https://ccapi.csslcloud.net/collect/live/gather

方法:

POST/GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 必须

返回示例:

{
    "result": "OK",
    "error_msg": "",
    "data": {
        "locations": {
            "其他": 1,
            "上海": 2
        },
        "roomid": "B89BF8C8D7F1838C9C33DC5901307461",
        "platforms": {
            "5": 1  # web
            "2": 2, # anroid
            "3": 3  # ios
        },
        "liveid": "DEB0441AFEBB36E7",
        "usercount": 1
    }
}

12.获取点名数据

描述:

获取直播点名数据

地址:

 https://ccapi.csslcloud.net/openapi/collect/rollcall/get

方法:

POST

请求参数:

参数名称 参数类型 参数说明 备注
account_id 字符串 开发者账号ID 必须
live_id 字符串 直播id 必须
page_index 整型 页码 必须
page_num 整型 每页条数(最大500) 必须

返回示例:

{
    "result": "OK",
    "error": null,
    "data": {
        "total": 2, //总条数
        "size": 100, //页数量
        "current": 1, //当前页码
        "data": [
            { 
                "live_id": "435FD0F38E66EE6A", //直播id
                "roll_call_id": "1591856163000", //点名id
                "user_id": "a10b241e28b44ab88a640539a09e681b", //课堂内用户id
                "user_name": "123", //用户姓名
                "roll_call_status": 1, //点名状态 1.点名成功 0.未点名
                "confirm_time": "2020-06-11 14:16:12" //同意点名的时间
            },
            {
                "live_id": "435FD0F38E66EE6A",
                "roll_call_id": "1591856163000",
                "user_id": "Z803hxkfgI65dwwC",
                "user_name": "学生",
                "roll_call_status": 1,
                "confirm_time": "2020-06-11 14:16:15"
            }
        ]
    },
    "errorMsg": ""
}

13.获取直播间进出记录

描述:

根据开发者账号、直播间ID、时间范围等查询直播间用户记录
说明：时间范围查询跨度不要超过31天

地址:

 https://ccapi.csslcloud.net/openapi/collect/room/user-in-out-records

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号 ID 必须
roomId 字符串 直播间 Id 必须
liveId 字符串 直播 ID 非必须
userId 字符串 用户ID 非必须
startTime 字符串 查询的开始时间， 按该直播间下直播的结束时间大于等于该时间过滤. 直播ID非空时此参数无意义，格式："yyyy-MM-dd "，示例："2022-12-01" 非必须
endTime 字符串 查询的结束时间， 按该直播间下直播的结束时间小于等于该时间过滤. 直播ID非空时此参数无意义，格式："yyyy-MM-dd "，示例："2022-12-01" 非必须
pageNum 整型 分页页码，默认1。取值范围:大于1的整数 非必须
pageSize 整型 每页条数，默认200。取值范围:1~200之前的任意整数 非必须
返回示例
{
    "result": "OK",
    "data": {
        "total": 7,
        "list": [
            {
                "username": "1", // 用户名称
                "role": "talker", // 用户角色 取值范围：presenter@老师，assistant@助教，talker@学员，inspector@隐身者
                "ip": "192.168.100.182", // 用户访问ip
                "platform": "web", // 设备类型  取值范围：ios，android，web，未知
                "userId": "hxdbRLWZhBZ7X6wr", // 用户ID
                "enterTime": "2022-12-07 11:34:27", // 进入直播时间
                "exitTime": "2022-12-07 11:57:44" // 离开直播时间
            }
        ]
    }
}

results matching ""

    No results matching ""