云课回放相关

日期: 2021-03-02

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

[TOC]

一、合流回放

1.1 查询普通合流回放列表

描述:

 通过该接口可以分页获取回放列表的信息

地址:

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

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
roomid 字符串 直播间id 必须
userid 字符串 开发者账号ID 必须
pagenum 整型 每页显示的个数 可选，系统默认值为50
pageindex 整型 页码 可选，系统默认值为1
starttime 字符串 查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数，该查询是按直播的开始时间作为查询条件的 可选，如果填写该参数则endtime参数必填；精确到分钟，例："2015-01-01 12:30"
endtime 字符串 查询截止时间 可选，如果填写该参数则starttime必填；精确到分钟，例："2015-01-02 12:30"
liveid 字符串 直播id 可选，将只查询该直播下的回放信息

返回示例：

{
   "result" : "OK",    # 请求是否成功。OK：成功；FAIL：失败
   "count" : "100",    # 回放总数
   "pageIndex" : "1",  # 页码
   "records" : [       # 回放列表信息
       {
           "id" : "753C612EB38A8D5A",            # 回放id
           "liveId" : "853C612EB38A8D5A",        # 直播id
           "startTime" : "2015-01-01 00:00:00",  # 开始时间
           "stopTime" : "2015-01-01 23:00:00",   # 结束时间
           "recordStatus": 1,                    # 录制状态，0表示录制未结束，1表示录制完成
           "recordVideoId" : "953C612EB38A8D5A", # 录制视频id，如果recordStatus为0则返回-1
           "replayUrl" : "http://xxx",           # 回放地址，当recordStatus为0时返回""
           "offlinePackageUrl" : "http://yyy",   # 离线包下载地址，注：只有开通离线播放权限才会返回该参数
           "offlinePackageMd5" : "xxxxxdddddddddddddddddddddddddddd" # 离线包md5，注：只有开通离线播放权限才会返回该参数
       },
       ...
   ]
}

1.2 查询全景合流回放列表

描述：

通过该接口可以分页获取全景回放列表的信息

地址：

 https://ccapi.csslcloud.net/openapi/recorder/replay_info

方法：

GET

请求参数：

参数名称 参数类型 参数说明 备注
roomid 字符串 直播间id 必须
account_id 字符串 开发者账号ID 必须
pagenum 整型 每页显示的个数 可选，系统默认值为50
pageindex 整型 页码 可选，系统默认值为1
starttime 字符串 查询起始时间,如需按时间范围查询可添加该参数和下面的endtime参数，该查询是按直播的开始时间作为查询条件的 可选，如果填写该参数则endtime参数必填；精确到分钟，例："2015-01-01 12:30"
endtime 字符串 查询截止时间 可选，如果填写该参数则starttime必填；精确到分钟，例："2015-01-02 12:30"
liveid 字符串 直播id 可选，将只查询该直播下的回放信息

返回示例：

{
    "result": "OK",    # 请求是否成功。OK：成功；FAIL：失败
    "data": {          #全景回放列表信息
        "count": 37,
        "pageIndex": 1
        "records": [
            {
                "id": "9683F9706BD9FC479C33DC5901307461", # 回放id
                "liveId": "760BDEDCD013E96F",             # 直播id
                "startTime": "2021-01-11 17:02:04",       # 开始时间
                "stopTime": "2021-01-11 17:19:51",        # 结束时间
                "recordStatus": 0,                        # 录制状态，0表示录制未结束，1表示录制完成
                "fullViewReplayUrl": "https://xxxxx"      # 全回放地址，当recordStatus为0时返回""
            }
        ]
    }
}

1.3 查询普通合流回放信息

描述:

 通过该接口获取单个回放信息

地址:

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

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
recordid 字符串 回放id 必须

返回示例：

{
  "result" : "OK", # 请求是否成功。OK：成功；FAIL：失败
  "record" : {     # 回放信息
          "id" : "753C612EB38A8D5A",       # 回放Id
          "liveId" : "853C612EB38A8D5A",   # 直播Id
          "startTime" : "2015-01-01 00:00:00", # 开始时间, 格式为"yyyy-MM-dd HH:mm:ss"
          "stopTime" : "2015-01-01 23:00:00",  # 结束时间, 格式为"yyyy-MM-dd HH:mm:ss", 如果直播未结束，该值则为""
          "recordStatus": 1, # 录制状态，0表示录制未结束，1表示录制完成
          "recordVideoId" : "953C612EB38A8D5A", # 录制视频id，如果recordStatus为0则返回-1
          "replayUrl" : "http://xxx", # 回放地址，当recordStatus为0时返回""
          "offlinePackageUrl" : "http://yyy", # 离线包下载地址，注：只有开通离线播放权限才会返回该参数
          "offlinePackageMd5" : "xxxxxdddddddddddddddddddddddddddd", # 离线包md5，注：只有开通离线播放权限才会返回该参数
          "downloadUrl" : "http://zzz" # 回放视频下载地址,该下载地址具有时效性，有效时间为2小时
      }
 }

二、分流回放

2.1 分流录制记录查询

描述：

获得一场直播的分流录制记录

地址：

https://ccapi.csslcloud.net/api/v1/serve/record/stream/query?roomid=myroomid&accountid=myaccounid&liveid=myliveid

方法：

GET

请求参数：

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

返回示例：

{
  "data": [
    {
      "down_path": "http://12.9.9.16/mkv/902213200.mp4",  # 没用
      "duration": 613.0,     # 视频时长
      "end": "2019-06-13 16:50:47",   # 视频结束时间
      "live_end": "2019-06-13 16:50:44",   # 直播结束时间
      "live_start": "2019-06-13 16:40:34",  # 直播开始时间
      "role": null,   # 角色  老师presenter 学生talker  混流null
      "source_type": 3,   #  0 普通流 1 共享桌面流  3 master合流  master类型合流 视频只包含老师 音频包含所有互动的人 手机端播放专用视频。
      "start": "2019-06-13 16:40:34", #  流开始时间
      "streamid": "5d01c3e945df9d19578e9361-master",  #  流id
      "userid": null,    # 用户id  混流null
      "username": null,   #  用户姓名  混流null
      "video_status": 200,    #  视频状态码  等于200 可以播放  大于200小于299 视频处理中  大于等于400   视频处理失败
      "videoid": "FC7E328BEB1356039C33DC5901307461"  #  视频id
    },
    {
      "down_path": "http://172.19.99.159/mkv/523690844575200.mp4",
      "duration": 1.0,
      "end": "2019-06-13 16:40:47",
      "live_end": "2019-06-13 16:50:44",
      "live_start": "2019-06-13 16:40:34",
      "role": "presenter",
      "source_type": 0,
      "start": "2019-06-13 16:40:46",
      "streamid": "6716799451234700",
      "userid": "h56j1Zt4hx21OOI",
      "username": "1321",
      "video_status": 200,
      "videoid": "237BE7D0B91E30479C33DC1307461"
    },
  ],
  "result": "OK"
}

2.2 回放画笔信息

描述：

回放画笔信息

地址：

http://ccapi.csslcloud.net/api/v1/serve/record/draw/info

方法：

GET

请求参数：

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

返回示例：

{
    "result": "OK", # 失败：FAIL，成功：OK
    "data": {
       meta": {
                "draw": [{
                   "time": 24,
                   "data": "{"alpha":1,"color":"14890019"}",
                   "docName": "WhiteBorad",
                   "pageNum": -1
                }]
        }
    }
}}

2.3 回放聊天信息

描述：

回放聊天信息

地址：

http://ccapi.csslcloud.net/api/v1/serve/record/chatqa/info

方法：

GET

请求参数：

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

返回示例:

{
    "result": "OK", # 失败：FAIL，成功：OK
    "data": {
        "meta": {
            "answer": [],
            "question": [],
            "chatLog": [{
                "content": "1你好  ",
                "time": 43,
                "role": 10,
                "userName": "1321",
                "userId": "f727119a92bd4cbabfd65f571bf9dce5",
                "userAvatar": "",
                "userRole": "unknow",
                "userCustomMark": ""
                }, {
                "content": "2321312   ",
                "time": 336,
                "role": 10,
                "userName": "1321",
                "userId": "f727119a92bd4cbabfd65f571bf9dce5",
                "userAvatar": "",
                "userRole": "unknow",
                "userCustomMark": ""
                }]
            }
    }
}

2.4 回放文档翻页信息

描述:

回放文档翻页信息

地址

 http://ccapi.csslcloud.net/api/v1/serve/record/doc/info

方法:

GET

请求参数:

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

返回示例：

{
    "result": "OK", # 失败：FAIL，成功：OK
    "data": {
        "meta": {
            "animation": [{
                "time": 167,
                "docId": "F6C4128336B740E4",
                "docTotalPage": 0,
                "pageNum": 0,
                "encryptDocId": "F6C4128336B740E4",
                "step": 0
            }, {
            "time": 171,
            "docId": "F6C4128336B740E4",
            "docTotalPage": 0,
            "pageNum": 0,
            "encryptDocId": "F6C4128336B740E4",
            "step": 1
            }]
        }
    }
}

2.5 视频播放链接

描述：

根据视频ID（videoid） 获取播放连接。

地址：

https://ccapi.csslcloud.net/api/v1/video/playurl?account_id=myaccound_id&video_id=myvideo_id

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
account_id 字符串 开发者账号ID 必须
video_id 字符串 视频ID 必须

返回示例：

{
  "data": {
    "app_playurl": "",
    "pc_playurl": ""
  },
  "result": "OK"
}

2.6 MP4回放(离频录制)视频信息查询

描述：

查询MP4回放视频信息

地址：

https://ccapi.csslcloud.net/openapi/recorder/mp4_synthesis

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
roomId 字符串 房间Id 必须
liveId 字符串 直播ID 必须
type 字符串 回放类型 必须 枚举值 COMMON_SEPARATE@普通分流 PANORAMA_MERGE@全景合流

返回示例：

{
  "result": "OK",
  "error": null,
  "data": {
    "duration": 1987.0, //时长 单位秒 浮点类型
    "videoid": "3B5CD33BBBACE0EB7E6C9CEE8B422289", //视频id
    "status": 1 //视频状态 0@处理中 1@成功 2失败
  },
  "errorMsg": ""
}

2.7 查询直播场次

描述:

根据账户id/房间id/时间范围查询直播场次记录

地址:


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

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
userid 字符串 开发者账号ID 必须
roomid 字符串 房间ID 必须
liveid 字符串 直播ID 可选
status 整数 1(直播中)，0(非直播中) 可选
start_time 字符串 开始时间, 和直播开始时间做筛选 可选 例："2015-01-01"
end_time 字符串 结束时间，和直播结束时间做筛选 可选 例："2015-01-01"
order 字符串 排序 ASC(升序) DESC(降序) 可选, 默认是降序
page 整数 获取指定页 默认返回第一页(可选)
lines 整数 每页的数据条数 默认每页50（可选）

返回示例:

{
  "result": "OK",
  "lives": [
    {
      "room_type": 2, # 房间类型
      "live_id": "EDDCB752CBF6306C", # 直播id
      "userid": "41E8063FC799ACE5", # 账户id
      "live_roomid": "D90DCF5BF6DA3C8C9C33DC5901307461",# 房间id
      "status": 0, # 直播状态 1直播中 0非直播中
      "start_time": "2020-02-26 14:27:58", # 直播开始时间
      "end_time": "2020-02-26 14:37:00" # 直播结束时间
    },
  ],
  "total": 100, # 总数
  "current": 1  # 当前分页
}

2.8 添加删除回放任务

描述:

根据账户id/房间id/时间范围删除回放

地址:


https://ccapi.csslcloud.net/openapi/recorder/add_delete_task

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
account_id 字符串 开发者账号ID 必须
delDate 字符串 删除回放日期（格式：yyyy-MM-dd） 必须,只能删除今天之前日期的数据
room_id 字符串 房间ID 可选

返回示例:

{
  "result": "OK",
}

3.1 获取回放观看统计时长

描述:

根据开发者账号ID/直播Id/日期 查询回放观看统计时长

地址:


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

方法:

GET

请求参数:

参数名称 参数类型 参数说明 备注
accountId 字符串 开发者账号ID 必须
liveId 字符串 直播Id 必须
date 字符串 日期，格式（yyyy-MM-dd） 必须,不能大于当前时间
pageNum 整型 页码 可选,取值范围 >0，默认1
pageSize 整型 分页大小 可选,默认为50，最大5000

返回示例:

{
  "result": "OK",
  "error": null,
  "data": {
    "total": 7,
    "replayVideo": [
      {
        "customId": "8Vtkt2NBhGhGGhBW", #用户ID
        "videoId": "9BCDA48268E04BF713358DE27D943A99",#视频Id
        "customName": "MzEzOTQ5",#用户名称
        "videoDuration": 620,#播放时长（秒）
        "ip": "192.168.203.101",#客户端IP
        "province": "未知",省份
        "city": "未知",城市
        "startTime": "2022-07-11 14:39:34",#播放开始时间
        "endTime": "2022-07-11 14:49:54"#播放结束时间
      }
    ]
  },
  "errorMsg": ""
}

说明:获取分组回放时长需配合分组相关接口使用##### 分组信息API

results matching ""

    No results matching ""