获取指定点播信息

获取指定点播信息

基本信息

Path: /api/v2/vod

接口描述:

根据vod_id,获取指定点播的详细信息

场景描述:

可用于后台管理查询指定视频的详细信息。

请求参数

Query

参数名称 类型 是否必须 示例 备注
action string 是 GetVodInfo 固定参数,GetVodInfo
app_id string 是 f4efa787 app_id
vod_id string 是 4377e1d5 点播ID
acquire_video_info int 否 是否获取所属视频的信息。0为不获取(默认),1为获取

出参

参数 类型 是否必选 含义
total int 是 符合条件的条目总数
page_num int 是 当前请求页数,注意默认从0开始
page_all int 是 总页数
vod_info json 是 点播信息
video_info json 否 视频信息列表
仅当请求参数&acquire_video_info=1时,才有此字段
video_info_safe json 否 加密视频信息列表
仅当请求参数&acquire_video_info=1时,才有此字段

点播信息

参数 类型 是否必选 含义
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 int 是 生成回放状态,0:默认值,没有回调或者进行中;1:成功;2:失败
source int 是 类型,0=回放,1=上传 ,2=录制,3=重置课件
snapshot_path string 是 截图文件路径
字段已废弃,请用获取点播截图信息
room_id string 是 直播房间ID
is_safe int 是 是否开启加密,0不加密,1开启加密
duration int 是 视频时长,单位为秒
transcode_status int 是 转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
vod_id string 是 点播ID
audit_status int 是 #审核状态:0 上线  1待审核 2下线
(注意,已废弃,请参考status字段)
msg_path string 是 文档消息文件路径
(注意,此字段已废弃)
cate_id int 是 视频分类ID
cate_name string 是 视频分类名称
tags json 是 点播视频标签列表
dynamic_images json 是 点播动图信息
dictation_path string 是 点播听写文本路径
cover_url string 是 点播封面图路径
doc_title_status int 是 文档章节状态,0=没有章节,1=有章节

点播动图信息

参数 类型 是否必选 含义
width int 是 动图宽, 单位px
height int 是 动图高, 单位px
image_uri string 是 动图文件URI地址
size int 是 动图大小,单位KB
start_time int 是 动图相对视频开始时间,单位:秒
start_time int 是 动图相对视频结束时间,单位:秒

视频信息

参数 类型 是否必选 含义
video_path string 是 视频路径
(注意,此字段已废弃)
bitrate_kbps int 是 视频平均码率
file_format string 是 封装格式 含m3u8,mp4,mp3
quality string 是 清晰度,如same,a,360p,480p,720p
created_at string 是 创建时间
safe int 是 加密类型 0(非加密),1(加密)视频
video_id int 是 视频ID
is_original int 是 来源类型 0(源视频,即用户上传),1(经过处理视频,或者回放)
video_type string 是 基本可点播类型,仅分为两类,hls和mp4
duration_s int 是 视频时长,单位(秒)
storage_kbyte int 是 视频存储大小
media_type int 是 媒体格式 0(音视频),1(纯音频)
is_exist int 是 0为成功并存在,1为失败或不存在
transcode_status int 是 转码状态:0新增排队中 1转码成功 2转码失败 3转码中

返回数据

{
  "msg": "success",
  "code": 200,
  "request_id": "B36A562C-BBE7-4B16-9F4A-C7A03AC9D6E2",
  "data": {
    "vod_info": {
      "status": 0,
      "vod_id": "4377e1d5",
      "name": "20s",
      "created_at": "2019-06-27 20:02:15",
      "msg_path": "",
      "storage": 40963,
      "app_id": "f4efa787",
      "record_status": 1,  #回放是否生成成功,0:默认值,新建进行中;1:成功;2:失败
      "source": 0,
      "snapshot_path": "",
      "room_id": "111111111",
	  "is_safe": 1,
      "duration": 196,
      "audit_status": 1,
      "transcode_status": 0,
      "cate_id": 12,                            # 分类id
      "cate_name": "体育",                # 分类名称
      "tags": ["A股","上证"],             # 点播视频标签列表
      "doc_title_status":0,
      "dynamic_images": [
        {
          	"width": 640,
         	 "start_time": 0,
         	 "height": 480,
          	"image_uri": "http://xxx.vhall.com/vhallyun/vhallimage/dynamic/3100d1/20191217xxx824/3xxx1.gif",
          	"end_time": 0,
          	"size": 11009
        }
      ],
     "dictation_path":"http://abc.e.vhall.com/vhallyun/vhallcoop/73ae253/da0eb/73a3_dictation.txt"
    },
    "video_info": [  #仅当请求参数&acquire_video_info=1时,才有此键值
      {
        "video_path": "",
        "bitrate_kbps": 0,
        "file_format": "m3u8",
        "quality": "same",
        "created_at": "2019-06-27 20:02:18",
		"safe": 0,
        "video_id": 5345,
        "is_original": 1,
        "video_type": "hls",
        "duration_s": 195,
        "storage_kbyte": 40963,
        "media_type": 0,
        "is_exist": 0,
        "transcode_status": 0
      },
      {
        "video_path": "",
        "bitrate_kbps": 316,
        "file_format": "m3u8",
        "quality": "480p",
        "created_at": "2019-07-24 18:44:36",
		"safe": 0,
        "video_id": 5389,
        "is_original": 1,
        "video_type": "hls",
        "duration_s": 132,
        "storage_kbyte": 5215,
        "media_type": 0,
        "is_exist": 0,
        "transcode_status": 1
      },
      {
        "video_path": "",
        "bitrate_kbps": 248,
        "file_format": "m3u8",
        "quality": "360p",
        "created_at": "2019-07-24 18:44:39",
		"safe": 0,
        "video_id": 5390,
        "is_original": 1,
        "video_type": "hls",
        "duration_s": 132,
        "storage_kbyte": 4102,
        "media_type": 0,
        "is_exist": 0,
        "transcode_status": 1
      },
      {
        "video_path": "",
        "bitrate_kbps": 457,
        "file_format": "m3u8",
        "quality": "720p",
        "created_at": "2019-07-24 19:27:29",
		"safe": 0,
        "video_id": 5391,
        "is_original": 1,
        "video_type": "hls",
        "duration_s": 132,
        "storage_kbyte": 7545,
        "media_type": 0,
        "is_exist": 0,
        "transcode_status": 1
      }
    ],
	"video_info_safe": [
		{
		"video_id": 215234,
		"bitrate_kbps": 2775,
		"quality": "same",
		"file_format": "m3u8",
		"video_path": "",
		"created_at": "2020-12-11 16:45:51",
		"safe": 1,
		"is_original": 1,
		"video_type": "hls",
		"duration_s": 91,
		"storage_kbyte": 31566,
		"media_type": 0,
		"is_exist": 0,
		"transcode_status": 1
		},
		{
		"video_id": 215235,
		"bitrate_kbps": 318,
		"quality": "480p",
		"file_format": "m3u8",
		"video_path": "",
		"created_at": "2020-12-11 16:45:52",
		"safe": 1,
		"is_original": 1,
		"video_type": "hls",
		"duration_s": 91,
		"storage_kbyte": 3617,
		"media_type": 0,
		"is_exist": 0,
		"transcode_status": 1
		},
		{
		"video_id": 215236,
		"bitrate_kbps": 175,
		"quality": "a",
		"file_format": "m3u8",
		"video_path": "",
		"created_at": "2020-12-11 16:45:52",
		"safe": 1,
		"is_original": 1,
		"video_type": "hls",
		"duration_s": 91,
		"storage_kbyte": 1993,
		"media_type": 1,
		"is_exist": 0,
		"transcode_status": 1
		},
		{
		"video_id": 215237,
		"bitrate_kbps": 265,
		"quality": "360p",
		"file_format": "m3u8",
		"video_path": "",
		"created_at": "2020-12-11 16:45:52",
		"safe": 1,
		"is_original": 1,
		"video_type": "hls",
		"duration_s": 91,
		"storage_kbyte": 3014,
		"media_type": 0,
		"is_exist": 0,
		"transcode_status": 1
		},
		{
		"video_id": 215238,
		"bitrate_kbps": 551,
		"quality": "720p",
		"file_format": "m3u8",
		"video_path": "",
		"created_at": "2020-12-11 16:45:52",
		"safe": 1,
		"is_original": 1,
		"video_type": "hls",
		"duration_s": 91,
		"storage_kbyte": 6270,
		"media_type": 0,
		"is_exist": 0,
		"transcode_status": 1
		}
     ]
  }
}