获取点播列表

获取点播列表

基本信息

Path: /api/v2/vod

接口描述:

获取符合指定条件的点播列表。

场景描述:

可用于点播视频管理页面,通过该接口获取全部点播文件,携带其基础信息和接口创建信息

请求参数

Query

参数名称 类型 是否必须 示例 备注
action string 是 GetVodList 固定参数,GetVodList
app_id string 是 app_id
room_id string 否 直播房间ID,默认为空。
如不为空,则仅根据该ID查询对应的直播内容回放。
page_num int 否 页号。默认值:0
page_size int 否 分页大小。默认值:10。最大不超过100。
starttime string 否 开始时间,格式如2019-01-01 10:00:00
endtime string 否 结束时间,格式如2019-01-02 10:00:00
source int 否 点播类型。取值范围:

0 回放类型
1 上传视频类型
2 录制类型
3 重置课件类型
默认为全部
status int 否 点播状态。取值范围:
0 (已发布)
1(生成回放失败)
2(转码失败)
3(转码中)
4 (审核中)
5 (审核失败)
默认为全部,如有多个,以逗号隔开
sortby string 否 排序方式。取值范围:
created_at:desc
created_at:asc
默认为 created_at:desc
search string 否 模糊搜索字段,匹配以下:

点播ID
点播名称

出参

参数 类型 是否必选 含义
total int 是 符合条件的条目总数
page_num int 是 当前请求页数,注意默认从0开始
page_all int 是 总页数
list json 是 点播详情列表

点播详情

参数 类型 是否必选 含义
status int 是 点播状态。 0:初始化; 1:已发布 ; 2:回放生成成功;3:回放生成失败; 4:审核中;5:审核成功; 6: 审核失败;7: 转码中;8:转码失败;9:转码部分成功;10:重制课件中; 11:重制课件失败
name string 是 点播名称
created_at string 是 创建时间
storage string 是 视频大小,单位KB
app_id string 是 应用ID
record_status string 是 生成回放状态,0:默认值,没有回调或者进行中;1:成功;2:失败
source int 是 类型,0=回放,1=上传 ,2=录制,3=重置课件
snapshot_path string 是 截图文件路径
(字段已废弃,请用获取点播截图信息)
room_id string 是 直播房间ID
duration int 是 视频时长,单位为秒
transcode_status int 是 转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
vod_id string 是 点播ID
audit_status int 是 #审核状态:0 上线  1待审核 2下线
(字段已废弃,请参考status字段)
cate_id int 是 视频分类ID
cate_name string 是 视频分类名称
tags json 是 点播视频标签列表
cover_url string 是 点播封面图路径
doc_title_status int 是 文档章节状态,0=没有章节,1=有章节

返回数据

{
  "msg": "success",
  "code": 200,
  "request_id": "B36A562C-BBE7-4B16-9F4A-C7A03AC9D6E2",
  "data": {
    "total": 66,    #符合条件的条目总数
    "page_num": 0,  #当前请求页数,注意默认从0开始
    "page_all": 7,   # 总页数
    "list": [
      {
        "status": 0,  #状态,预留字段暂无实现
        "vod_id": "aa6431a7",    
        "name": "2019-07-24 15:11:09",  #点播名称
        "created_at": "2019-07-24 15:11:09",   #创建时间
        "storage": 3522,  #单位KByte
        "app_id": "f4efa787",   
        "record_status": 0, # 回放是否生成成功,0:默认值,没有回调或者进行中;1:成功;2:失败
        "source": 1,   #类型,0=回放,1=上传, 2=录制
        "snapshot_path": "",  #截图文件路径
        "room_id": "",
        "duration": 20,   #视频时长,单位为秒
        "audit_status": 1,  #审核状态:0 上线  1待审核 2下线 
        "transcode_status": 1,    # 转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
        "cate_id": 12,                            # 分类id
        "cate_name": "体育",                # 分类名称
        "tags": ["A股","上证"],             # 点播视频标签列表
        "cover_url":"",
        "doc_title_status":0
      },
      {
        "status": 0,
        "vod_id": "6d3c049b",
        "name": "2019-07-22 15:54:44",
        "created_at": "2019-07-22 15:54:44",
        "storage": 1939,
        "app_id": "f4efa787",
        "record_status": 0,
        "source": 1,
        "snapshot_path": "",
        "room_id": "",
        "duration": 28,
        "audit_status": 1,
        "transcode_status": 1,
        "cate_id": 0,                            # 分类id
        "cate_name": "",                # 分类名称
        "tags": ["深证"],             # 点播视频标签列表
        "cover_url":"",
        "doc_title_status":0
      },
      {
        "status": 0,
        "vod_id": "6dc70131",
        "name": "111111111 2019-07-17 11:21:50",
        "created_at": "2019-07-17 11:21:50",
        "storage": 0,
        "app_id": "f4efa787",
        "record_status": 2,
        "source": 0,
        "snapshot_path": "",
        "room_id": "111111111",
        "duration": 0,
        "audit_status": 1,
        "transcode_status": 0,
        "cate_id": 0,                            # 分类id
        "cate_name": "",                # 分类名称
        "tags": ["港股"],             # 点播视频标签列表
        "cover_url":"",
        "doc_title_status":0
      }
    ]
  }
}