点播 API更新时间:2020-01-14 19:17:39
生成点播回放视频文件
API 地址
api.vhallyun.com/api/v1/record/create
描述
直播房间推流结束后,可通过该接口生成对应的回放视频,生成的点播文件会占用微吼云使用空间
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| room_id |
string |
是 |
房间ID |
| start_time |
string |
是 |
回放生成时间,格式:2017/01/01 00:00:00 |
| end_time |
string |
是 |
回放结束时间,格式:2017/01/01 00:00:00 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
回放ID |
错误码
| 错误码 |
类型 |
含义 |
| 10008 |
int |
房间ID不能为空 |
| 10013 |
int |
创建点播开始时间不能为空 |
| 10014 |
int |
创建点播结束时间不能为空 |
| 20002 |
int |
房间查询为空 |
| 30001 |
int |
不是当前房间拥有者 |
| 40004 |
int |
时间类型不正确 |
| 60001 |
int |
录制功能未开启 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"record_id": "6e5692bb"
}
}
删除点播文件
API 地址
api.vhallyun.com/api/v1/record/delete
描述
删除指定的点播文件
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
| rate |
string |
否 |
删除回放下指定的清晰度文件,多个清晰度,请使用英文逗号分隔。 eg : 360p,720p(无该参数为删除该点播下所有文件) |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| delete_record_id |
int |
是 |
删除的回放ID |
错误码
| 错误码 |
类型 |
含义 |
| 10015 |
int |
回放ID不能为空 |
| 20006 |
int |
当前回放查询为空 |
| 50002 |
int |
系统删除失败 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"delete_record_id": "ead7e8e1"
}
}
点播列表
API 地址
api.vhallyun.com/api/v1/record/lists
描述
按当前公共参数传入app_id对应的应用,获取点播列表
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为10条,最大为1000条 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| status |
int |
是 |
0 上传完成 1(正常) 2(屏蔽) 3(审核中) |
| name |
string |
是 |
点播名称 |
| created_at |
string |
是 |
创建时间 |
| storage |
string |
是 |
视频大小,单位KB |
| app_id |
string |
是 |
应用ID |
| record_status |
string |
是 |
生成回放状态,0:默认值,没有回调或者进行中;1:成功;2:失败 |
| source |
string |
int |
类型,0=回放,1=上传 |
| room_id |
string |
是 |
直播房间ID |
| duration |
int |
是 |
视频时长,单位为秒 |
| transcode_status |
int |
是 |
转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功 |
| record_id |
string |
是 |
点播ID |
| download_status |
int |
是 |
0 不存在,1打包成功,2打包中 |
| download_url |
string |
是 |
下载地址 |
错误码
| 错误码 |
类型 |
含义 |
| 20006 |
int |
当前回放查询为空 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
响应格式
{
"code": 200,
"msg": "",
"data": [
{
"status": 0,
"name": "lss_f6d5ce23 2019-06-05 11:38:37",
"created_at": "2019-06-05 11:38:37",
"storage": 4391,
"app_id": "e0871a28",
"record_status": 1,
"source": 0,
"room_id": "lss_f6d5ce23",
"duration": 32,
"transcode_status": 0,
"record_id": "f7bc91e6",
"download_status": 0,
"download_url": ""
},
{
"status": 0,
"name": "点播上传 2019-05-27 11:19:19",
"created_at": "2019-05-27 11:19:19",
"storage": 0,
"app_id": "e0871a28",
"record_status": 0,
"source": 1,
"room_id": "",
"duration": 0,
"transcode_status": 0,
"record_id": "ab0a0023",
"download_status": 0,
"download_url": ""
}
]
}
指定点播文件转码
API 地址
api.vhallyun.com/api/v1/record/trans-record
描述
配置或变更点播转码策略后不会对历史上传的视频文件进行转码,如需对历史视频转码可以调用该接口
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
出参
错误码
| 错误码 |
类型 |
含义 |
| 10015 |
int |
回放ID不能为空 |
| 20006 |
int |
当前回放查询为空 |
| 40012 |
int |
点播类型不正确 |
响应格式
{
"code": 200,
"msg": "",
"data": []
}
获取点播文件和不同清晰度属性信息
API 地址
api.vhallyun.com/api/v1/record/get-record-info
描述
获取点播和不同清晰度的时长,空间占用信息
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| duration |
int |
是 |
时长 单位 (秒) |
| storage |
int |
是 |
总占用空间 单位 (KB) |
| created_at |
string |
是 |
创建时间 |
| list |
obj |
否 |
转码信息 |
list参数
| 参数 |
类型 |
是否必选 |
含义 |
| quality |
string |
是 |
清晰度 |
| storage |
int |
是 |
总占用空间 单位 (KB) |
| transcode_status |
string |
是 |
转码状态 0新增排队中 1转码成功 2转码失败 3转码中 |
错误码
| 错误码 |
类型 |
含义 |
| 10015 |
int |
回放ID不能为空 |
| 20006 |
int |
当前回放查询为空 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"duration": 159,
"storage": 51561,
"created_at": "2018-02-26 14:39:28",
"list": [
{
"quality": "720p",
"storage": 15852,
"transcode_status": 1
},
{
"quality": "480p",
"storage": 11677,
"transcode_status": 1
},
{
"quality": "360p",
"storage": 9291,
"transcode_status": 1
},
{
"quality": "a",
"storage": 2563,
"transcode_status": 1
}
]
}
}
按点播ID生成下载文件
API 地址
api.vhallyun.com/api/v1/download/pre-to-multi-download
描述
按点播ID生成下载,每次都按传递的点播ID生成下载该点播下的所有清晰度文件,文件保存时间为7天。
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
出参
错误码
| 错误码 |
类型 |
含义 |
| 10015 |
int |
回放ID不能为空 |
| 30013 |
int |
不是点播拥有者 |
响应格式
{
"code":200,
"msg":"",
"data":[
]
}
点播列表(直播回放)
API 地址
api.vhallyun.com/api/v1/record/live-record
描述
按当前传入的直播房间ID (room_id),获取此房间下的点播列表
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| room_id |
int |
是 |
直播房间ID |
| status |
int |
否 |
回放生成状态 0 全部, 1成功, 2失败 , 默认 0 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
| 参数 |
类型 |
含义 |
| record_id |
string |
点播ID |
| app_id |
string |
app_id |
| name |
string |
点播名称 |
| duration |
int |
点播时长 (单位为 秒) |
| storage |
int |
点播占用空间 (单位为 KB) |
| created_time |
string |
创建时间 |
错误码
| 错误码 |
类型 |
含义 |
| 20002 |
int |
房间查询为空 |
| 30001 |
int |
不是当前房间拥有者 |
| 10020 |
int |
开始时间不能为空 |
| 40004 |
int |
时间类型不正确 |
响应格式
{
"code":200,
"msg":"",
"data":[
{
"record_id":"2b8ecbd0",
"app_id":"971990b7",
"name":"lss_fee7b3bd 2017-12-27 23:53:54",
"duration":4838,
"storage":"136320",
"created_time":"2017-12-27 23:53:54"
},
{
"record_id":"c2ba7393",
"app_id":"971990b7",
"name":"lss_fa225532 2018-07-17 01:18:22",
"duration":192,
"storage":"21462",
"created_time":"2018-07-17 01:18:22"
}
]
}
再裁剪生成回放
API 地址
api.vhallyun.com/api/v1/record/create-more
描述
对已有的回放视频裁剪,并生成新的最终回放视频.
入参
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
回放ID |
| room_id |
string |
是 |
房间ID |
| point |
json |
是 |
文字打点信息,内容可为空。 格式如下文描述 |
| cut |
json |
是 |
裁剪片段信息,内容可为空。表示为剪掉不要的时间段。 格式如下文描述 |
point参数
| 参数 |
类型 |
含义 |
| timePoint |
int |
打点时间, 秒/单位 |
| msg |
string |
打点文字信息 |
[
{
"timePoint": 12, #打点时间点
"msg": "abc" #打点文字信息
}, {
"timePoint": 38,
"msg": "abc"
}
]
cut参数
| 参数 |
类型 |
含义 |
| start |
int |
截取开始时间 秒/单位 |
| end |
int |
截取结束时间 秒/单位 |
[
{
"start": 1, #int类型,裁剪片段开始时间点,秒为单位
"end": 5 #int类型,裁剪片段结束时间点,秒为单位
}, {
"start": 10,
"end": 20
}
]
出参
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
回放ID |
错误码
| 错误码 |
类型 |
含义 |
| 10008 |
int |
房间ID不能为空 |
| 20002 |
int |
房间查询为空 |
| 20006 |
int |
当前回放查询为空 |
| 40004 |
int |
时间类型不正确 |
| 50003 |
int |
生成回放失败 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"record_id": "6e5692bb"
}
}
配置点播转码清晰度策略
API 地址
api.vhallyun.com/api/v1/record/set-trans-code-info
描述
用户上传视频后会对上传的视频进行转码,可通过接口配置需要转码的清晰度
- 转码配置针对应用配置,如果多个应用都需要,需要分别配置
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| rate |
string |
是 |
转换清晰度 多个清晰度以英文逗号分开,清晰度见下面列表。eg : 360P,720P |
清晰度列表
| 参数 |
类型 |
含义 |
| SAME |
string |
原始分辨率 原始码率 |
| 360P |
string |
分辨率360P 码率330kb |
| 480P |
string |
分辨率480P 码率450kb |
| 720P |
string |
分辨率720P 码率650kb |
| 1080P |
string |
分辨率1080P 码率650kb |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| rate |
string |
是 |
配置的清晰度 |
错误码
| 错误码 |
类型 |
含义 |
| 10024 |
int |
转码配置不能为空 |
| 40010 |
int |
转码类型不正确 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"rate": "360P,720P"
}
}
点播水印设置
API 地址
api.vhallyun.com/api/v1/record/set-watermark
描述
添加播放器中的水印信息
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| watermark_id |
int |
否 |
水印模板id,为0或空时不展示水印 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| watermark_id |
int |
是 |
水印模板id |
错误码
| 错误码 |
类型 |
含义 |
| 20015 |
int |
水印模板查询为空 |
| 50001 |
int |
系统更新错误 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"watermark_id": 9
}
}
自动转码设置
API 地址
api.vhallyun.com/api/v1/record/set-auto-trans
描述
设置点播文件自动转码配置
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| auto_trans |
int |
是 |
自动转码状态 1 开启 2 关闭 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| auto_trans |
int |
是 |
自动转码状态 1 开启 2 关闭 |
错误码
| 错误码 |
类型 |
含义 |
| 20017 |
int |
自动转码配置参数不能为空 |
| 40042 |
int |
自动转码配置参数错误 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"auto_trans": "1"
}
}
获取点播流量数据
API 地址
api.vhallyun.com/api/v1/record/get-stream-flow
描述
按当前公共参数传入app_id对应的应用,获取点播的流量记录
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为10条,最大为1000条 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| flow |
list |
是 |
按天获取的流量使用列表 (单位为 KB) |
错误码
| 错误码 |
类型 |
含义 |
| 10020 |
int |
开始时间不能为空 |
| 40004 |
int |
时间类型不正确 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
响应格式
{
"code": 200,
"msg": "",
"data": {
"flow": {
"2017-12-11": "0",
"2017-12-12": "20400",
"2017-12-13": "0",
}
}
}
获取点播文件观看信息
API 地址
api.vhallyun.com/api/v1/record/get-record-use-info
描述
获取点播的流量、pv、uv以及观看时长
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为 10 条,最大为1000条 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| flow |
int |
是 |
流量 单位(KB) |
| pv_num |
int |
是 |
pv |
| uv_num |
int |
是 |
uv |
| tt |
int |
是 |
总观看时长 单位 (秒) |
| created_time |
string |
是 |
统计时间 |
错误码
| 错误码 |
类型 |
含义 |
| 10020 |
int |
开始时间不能为空 |
| 20011 |
int |
房间使用信息查询为空 |
| 30010 |
int |
不是当前点播拥有者 |
| 40004 |
int |
时间类型不正确 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
| 40040 |
int |
开始时间不能大于结束时间 |
响应格式
{
"code": 200,
"msg": "",
"data": [
{
"flow": 15015,
"pv_num": 3,
"uv_num": 1,
"tt": 364,
"created_time": "2019-06-24 11:00:00"
},
{
"flow": 700,
"pv_num": 1,
"uv_num": 1,
"tt": 29,
"created_time": "2019-06-24 12:00:00"
}
]
}
获取点播访问记录
API 地址
api.vhallyun.com/api/v1/record/get-record-join-info
描述
获取点播的游客进出记录
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| record_id |
string |
是 |
点播ID |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为 10 条,最大为1000条 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| uid |
string |
是 |
第三方用户ID |
| start_time |
string |
是 |
进入时间 |
| end_time |
string |
是 |
离开时间 |
| tt |
int |
是 |
总观看时长 单位 (秒) |
| pf |
string |
是 |
观看终端,0代表iOSAPP,1代表AndroidAPP,2代表flash,3代表wap,4代表IOSSDK,5代表AndroidSDK,6代表小助手,7代表h5播放器pc端 |
| browser |
string |
是 |
请求方式 |
| viewer_province |
string |
是 |
地域 |
错误码
| 错误码 |
类型 |
含义 |
| 10020 |
int |
开始时间不能为空 |
| 20011 |
int |
房间使用信息查询为空 |
| 30001 |
int |
不是当前房间拥有者 |
| 40004 |
int |
时间类型不正确 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
响应格式
{
"code": 200,
"msg": "",
"data": [
{
"uid": "1000204982",
"start_time": "2018-03-06 11:55:00",
"end_time": "2018-03-07 11:29:00",
"tt": 1335,
"pf": "7",
"browser": "QQBrowser",
"viewer_province": "上海"
},
{
"uid": "1000204982",
"start_time": "2018-03-06 11:57:00",
"end_time": "2018-03-07 11:29:00",
"tt": 1268,
"pf": "7",
"browser": "Chrome",
"viewer_province": "加利福尼亚州"
}
]
}
获取点播增量观看信息
API 地址
api.vhallyun.com/api/v1/record/get-records-use-info
描述
获取一段时间内的点播的流量、pv、uv以及观看时长
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为 10 条,最大为1000条 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 00:00 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 00:00 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| flow |
int |
是 |
流量 单位(KB) |
| pv_num |
int |
是 |
pv |
| uv_num |
int |
是 |
uv |
| tt |
int |
是 |
总观看时长 单位 (秒) |
| record_id |
string |
是 |
点播ID |
| start_time |
date |
是 |
数据的开始时间,格式为:2018-08-15 16:00:00 |
| end_time |
date |
否 |
数据的结束时间,格式为:2018-08-15 17:00:00 |
错误码
| 错误码 |
类型 |
含义 |
| 10020 |
int |
开始时间不能为空 |
| 40004 |
int |
时间类型不正确 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
| 40040 |
int |
开始时间不能大于结束时间 |
响应格式
{
"code": 200,
"msg": "",
"data": [
{
"flow": 11175,
"pv_num": 1,
"uv_num": 1,
"tt": 447,
"record_id": "inav_42243747",
"start_time": "2018-08-15 16:00:00",
"end_time": "2018-08-15 17:00:00"
},
{
"flow": 2225,
"pv_num": 1,
"uv_num": 1,
"tt": 89,
"record_id": "inav_42243747",
"start_time": "2018-08-15 17:00:00",
"end_time": "2018-08-15 18:00:00"
}
]
}
获取点播下载流量
API 地址
api.vhallyun.com/api/v1/download/get-download-flow
描述
按当前公共参数传入app_id对应的应用,获取点播的下载流量
入参
关于公共请求参数详细内容,请参考 公共请求参数。
| 参数 |
类型 |
是否必选 |
含义 |
| pos |
int |
否 |
获取条目节点,默认为 0 |
| limit |
int |
否 |
获取条目数量,默认为 10 条,最大为1000条 |
| start_time |
date |
是 |
查询开始时间,格式为:2017/01/01 |
| end_time |
date |
否 |
查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
| 参数 |
类型 |
是否必选 |
含义 |
| flow |
int |
是 |
下载流量,单位kb |
| download_time |
string |
是 |
下载时间 |
错误码
| 错误码 |
类型 |
含义 |
| 10020 |
int |
开始时间不能为空 |
| 40004 |
int |
时间类型不正确 |
| 40008 |
int |
分页起始提条目不正确 |
| 40009 |
int |
分页条目不正确 |
响应格式
{
"code":200,
"msg":"",
"data":[
{
"flow":14415,
"download_time":"2018-03-14 16:00:00"
},
{
"flow":14415,
"download_time":"2018-03-16 10:00:00"
},
{
"flow":28830,
"download_time":"2018-03-16 11:00:00"
}
]
}