点播服务端API文档
1 调用方式
1.1 请求说明
1.1.1 服务地址
网易视频云点播服务使用的域名访问地址为:vcloud.163.com。
1.1.2 通信协议
网易视频云点播服务的所有接口均通过HTTPS进行通信,提供高安全性的通信通道。
重要提示:获取上传加速节点和断点续传查询断点接口除外,只支持HTTP通信。
1.1.3 请求方法
所有接口都只支持POST请求。
重要提示:获取上传加速节点和断点续传查询断点接口除外,为GET请求。
1.1.4 字符编码
所有接口均使用UTF-8编码。
1.2 公共参数
所有接口均需要放置以下公共参数在请求头中,用于标识用户和接口鉴权。后续的接口说明不再对这些参数进行说明,但每次发起请求均需要携带。
参数
类型
必须
说明
AppKey
String
是
开发者平台分配的AppKey
Nonce
String
是
随机数(随机数,最大长度128个字符)
CurTime
String
是
当前UTC时间戳,从1970年1月1日0点0分0秒开始到现在的秒数
CheckSum
String
是
服务器认证需要,SHA1(AppSecret+Nonce+CurTime),16进制字符小写
重要提示:获取上传加速节点、文件数据上传、断点续传查询断点三个接口,不使用上述公共参数。
1.3 接口鉴权
接口通过请求头中的公共参数进行鉴权。登录网易云控制台,点击应用名称 > 右侧[App Key管理],即可查看AppKey和AppSecret,通过该安全凭证进行SHA1(AppSecret+Nonce+CurTime)计算。
重要提示: 本文档中提供的所有接口均面向开发者服务器端调用,用于计算CheckSum的AppSecret开发者应妥善保管,可在应用的服务器端存储和使用,但不应存储或传递到客户端,也不应在网页等前端代码中嵌入。
计算CheckSum的java代码举例如下:
import java.security.MessageDigest;
public class CheckSumBuilder {
public static String getCheckSum(String appSecret, String nonce, String curTime){
return encode("sha1", appSecret + nonce + curTime);
}
private static String encode(String algorithm, String value){
if (value == null) {
return null;
}
try {
MessageDigest messageDigest = MessageDigest.getInstance(algorithm);
messageDigest.update(value.getBytes());
return getFormattedText(messageDigest.digest());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
private static String getFormattedText(byte[] bytes){
int len = bytes.length;
StringBuilder buf = new StringBuilder(len * 2);
for (int j = 0; j < len; j++) {
buf.append(HEX_DIGITS[(bytes[j] >> 4) & 0x0f]);
buf.append(HEX_DIGITS[bytes[j] & 0x0f]);
}
return buf.toString();
}
private static final char[] HEX_DIGITS = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
}
1.4 返回说明
所有接口返回类型为JSON。返回字段如下:
名称
类型
说明
code
Int
返回结果的状态码
ret
String
返回的结果集
msg
String
当返回结果的状态码不为200时,包含的错误信息
重要提示:获取上传加速节点、文件数据上传、断点续传查询断点三个接口除外。
1.5 接口频率说明
目前每个接口频率限制为80次/秒。
2 调用流程
3 文件上传
文件上传模块主要展示通过服务端API进行文件上传的API调用、回调和代码示例(含断点续传)。除服务端API调用上传外,也可通过登录控制台进行网页上传,或接入上传SDK进行上传。
3.1 文件上传初始化
3.1.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/upload/init
用于文件上传的初始化,获取xNosToken(上传凭证)、bucket(存储对象的桶名)、object(生成的唯一对象名)。
3.1.2 输入参数
参数
类型
必须
说明
originFileName
String
是
上传文件的原始名称(包含后缀名)
userFileName
String
否
用户命名的上传文件名称
typeId
Int
否
视频所属的类别Id(不填写为默认分类)
presetId
Int
否
视频所需转码模板Id(不填写为默认模板,默认模板不进行转码)
uploadCallbackUrl
String
否
上传成功后回调客户端的URL地址(需标准http格式)
callbackUrl
String
否
转码成功后回调客户端的URL地址(需标准http格式)
description
String
否
上传视频的描述信息
watermarkId
Int
否
视频水印Id(不填写为不添加水印,如果选择,
请务必在水印管理中提前完成水印图片的上传和参数的配置;
且必需设置prestId字段,且presetId字段不为默认模板)
userDefInfo
String
否
用户自定义信息,回调会返回此信息(长度不能超过256字符)
transOffset
Int
否
视频转码处理裁剪视频的起始位置(单位:秒)
transDuration
Int
否
视频转码处理裁剪视频的视频时长(单位:秒)
3.1.3 输出参数
参数
类型
说明
code
Int
状态码
xNosToken
String
上传凭证
bucket
String
存储上传文件的桶名
object
String
存储上传文件的对象名
msg
String
错误信息
3.1.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
3.1.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"originFileName":"love.mp4","userFileName":"for_love.mp4","typeId":20,"presetId":20,"description":"for love","wartermarkId":20}' https://vcloud.163.com/app/vod/upload/init
输出1
"Content-Type": "application/json; charset=utf-8"
{
"code" : 200,
"ret" : {
"xNosToken" : "UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=",
"bucket" : "vodk32ywxdf",
"object" : "d37906a7-0119-4dd9-820d-4c66a71952ad.mp4"
}
}
3.2 获取上传加速节点地址
3.2.1 接口描述
接口名:/lbs?version=1.0&bucketname={bucket}
用于获取上传加速节点地址。
3.2.2 输入参数
参数
类型
必须
说明
version
String
是
API版本号,填写固定值1.0
bucketname
String
是
存储上传文件的桶名,可在视频上传初始化接口的返回参数bucket获取
3.2.3 输出参数
参数
类型
说明
lbs
String
httpDNS的IP访问地址,用于避免后续查询的DNS解析时间、以及域名劫持
upload
List
上传节点列表(前面的优先级高)
3.2.4 响应状态码
参数
类型
说明
Code
String
错误代码
Message
String
错误描述信息
3.2.5 示例代码
输入1
curl -X GET http://wanproxy.127.net/lbs?version=1.0&bucketname=vodk32ywxdf
输出1
{"lbs":"http://223.252.196.39/lbs","upload":["http://223.252.216.48","http://223.252.216.49"]}
3.3 文件数据上传
上传一块数据,此接口通过指定offset实现断点续传功能。用户每次上传要以服务器端返回的offset为准续传余下数据。
需注意以下事项:
大文件需要自行分片上传,分片大小不超过4MB,请求相同接口,注意参数的填写。
如果需要断点续传,需保存 context 值,根据 context 值查询断点值,然后继续使用此接口。
包体数据为二进制数据。
3.3.1 接口描述
POST {UploadHost}/{bucket}/{object}
重要提示:{UploadHost}值为获取的上传加速节点地址,{bucket}值为存储对象的桶名,{object}值为生成的唯一对象名。
3.3.2 输入参数
参数
类型
必须
说明
x-nos-token
String
是
请求头参数,上传token
Content-Length
long
否
请求头参数,当前片的内容长度,
单位:字节(Byte)。Content-Length合法值是[0~4M],
否则返回400 httpcode给客户端,拒绝本次请求
Content-Type
String
否
请求头参数,标准http头。表示请求内容的类型,
比如:image/jpeg。 仅第一次上传生效,续传不生效
Content-MD5
String
否
请求头参数,文件内容md5值
bucket
String
是
存储对象的桶名
object
String
是
生成的唯一对象名
offset
long
是
当前分片在整个对象中的起始偏移量,单位:字节(Byte)
complete
String
是
是否为最后一块数据。合法值:true/false
version
String
是
http api版本号。这里是固定值1.0
context
String
是
上传上下文。本字段是只能被上传服务器解读使用的不透明字段,
上传端不应修改其内容。
注意:用户第一次上传应不带此参数或置为空字符串,
之后上传剩余部分数据都需要带上这个参数。
context对应的桶名或者对象名不匹配返回400 code
3.3.3 输出参数
3.3.3.1 响应成功输出参数
参数
类型
必须
说明
requestId
String
是
uuid字符串,服务器端生成的唯一UUID
offset
long
是
下一个上传片在上传块中的偏移。
注意:偏移从0开始,比如:用户上传0-128字节后,
服务器返回的offset为128,下一次上传offset值应置为128
context
String
是
上传上下文
callbackRetMsg
String
是
上传回调信息
3.3.3.2 响应失败输出参数
参数
类型
说明
requestId
String
uuid字符串,服务器端生成的唯一UUID
errMsg
String
错误描述信息
3.3.4 响应状态码
状态码
含义
200
上传分片成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
403
上传凭证无效。token过期服务器会返回此状态码,用户需要重新申请token
500
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
520
回调失败
3.3.5 示例代码
输入1
curl -X POST -H "Content-Length: 4194304" -H "x-nos-token: UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=" -d'[本次上传视频文件二进制内容数据]' "http://223.252.216.49/vodk32ywxdf/d37906a7-0119-4dd9-820d-4c66a71952ad.mp4?offset=0&complete=false&version=1.0"
输出1
{
"requestId":"be82c2a0dffc000000005770a189d831",
"offset":4194304,
"context":"f3e26818-83c3-5a21-6ee4-39ff47af21c7",
"callbackRetMsg":""
}
3.4 断点续传查询断点
根据上传上下文查询对应分片上传当前续传的offset,上下文要与bucketName/objectName匹配,否则返回400状态码。(bucketName和objectName要进行URL编码,字符编码格式使用utf-8)。
3.4.1 接口描述
GET {UploadHost}/{bucket}/{object}?uploadContext
重要提示:{UploadHost}值为获取的上传加速节点地址,{bucket}值为存储对象的桶名,{object}值为生成的唯一对象名。
3.4.2 输入参数
参数
类型
必须
说明
x-nos-token
String
是
上传token
bucketName
String
是
存储对象的桶名
objectName
String
是
生成的唯一对象名
context
String
是
上传上下文。本字段是只能被上传服务器解读使用的不透明字段,
上传端不应修改其内容。对应context在服务端不存在则返回404。
context对应的桶名或者对象名不匹配返回400 code。
version
String
是
http api版本号。这里是固定值1.0
3.4.3 输出参数
3.4.3.1 响应成功输出参数
参数
类型
必须
说明
requestId
String
是
uuid字符串,服务器端生成的唯一UUID,用于记录日志排查问题使用
offset
long
是
下一个上传片在上传块中的偏移
3.4.3.2 响应失败输出参数
参数
类型
说明
requestId
String
uuid字符串,服务器端生成的唯一UUID
errMsg
String
错误描述信息
3.4.4 响应状态码
状态码
含义
200
上传分片成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
403
上传凭证无效。token过期服务器会返回此错误码,用户需要重新申请token
500
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
404
对应context上传不存在
3.4.5 示例代码
输入1
curl -X GET -H "x-nos-token: UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=" "http://223.252.216.49/vodk32ywxdf/d37906a7-0119-4dd9-820d-4c66a71952ad.mp4?uploadContext&context=f3e26818-83c3-5a21-6ee4-39ff47af21c7&version=1.0"
输出1
{
"requestId":"be82c2a0dffc000000005770a189d832",
"offset":4194304
}
3.5 上传完成根据对象名查询视频或水印图片主Id
3.5.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/query
用于视频或水印上传完成后查询主Id。
3.5.2 输入参数
参数
类型
必须
说明
objectNames
List
是
上传文件的对象名列表
3.5.3 输出参数
参数
类型
说明
code
Int
状态码
list
List
对象名和视频Id对应的列表
list.vid
Long
视频主Id
list.imgId
Int
视频水印图片Id
list.objectName
String
存储上传文件的对象名
msg
String
错误信息
3.5.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
3.5.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"objectNames":["33cf71b1-86ac-4555-a071-d70db07b9685.mp4"]}' https://vcloud.163.com/app/vod/video/query
输出1
"Content-Type": "application/json; charset=utf-8"
{
"code" : 200,
"ret" : {
list : [
{
"objectName" : "33cf71b1-86ac-4555-a071-d70db07b9685.mp4",
"vid" : 1008
}
]
}
}
3.6 设置上传回调地址
3.6.1 上传回调说明
网易视频云点播的上传回调通知分为单个级别和用户级别,且处理优先级为:单个级别->用户级别->无回调。当用户设置了单个级别的回调地址,使用单个级别的回调地址;否则查询是否设置用户级别的回调地址,如果设置,使用用户级别的回调地址;否则不回调通知。单个级别的回调通知在上传初始化中指定,用户级别的回调通知可通过本接口设置。
回调通知会在请求头中增加sign字段,其值为拼接回调包体内容的字符串和签名字符串,然后对拼接后的字符串进行md5加密(32位小写)。签名字符串可通过本接口设置,默认为:vcloud。
目前网易视频云点播支持上传成功回调通知。
3.6.2 接口描述
域名:vcloud.163.com
接口名:/app/vod/upload/setcallback
用于视频上传,设置上传成功后的回调地址。
3.6.3 输入参数
参数
类型
必须
说明
callbackUrl
String
是
上传成功后回调客户端的URL地址
signKey
String
否
上传成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过32位
3.6.4 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
3.6.5 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
3.6.6 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/upload/setcallback
输出1
{
"msg" : "",
"code" : 200
}
3.6.7 回调内容示例
{"name":"snow.mp4","origAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/b3d259f4-a7bc-4119-ae24-60e0eb09216e.mp4","type":"upload","vid":1022,"user_defined":"userId=123456"}。
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,上传回调固定为“upload”
vid
Long
视频文件标识
name
String
视频文件名称(上传时指定视频名称)
origAddr
String
视频的播放地址
warnning
String
视频类型检测结果,比如视频类型和上传指定不一致,mp4和flv类型的视频不适合流媒体播放拖动等
user_defined
String
用户自定义字段值(上传时设置的值)
4 视频转码
视频转码模块主要展示转码相关的API调用和代码示例。包含转码模板的管理、水印模板的管理、视频转码及回调等功能。
4.1 创建视频转码模板
4.1.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/preset/create
用于视频文件转码,创建模板。可使用视频云的默认格式模板或自定义格式参数。
4.1.2 输入参数
参数
类型
必须
说明
presetName
String
是
视频转码模板的名称
sdMp4
Int
是
流畅Mp4格式(1表示选择,0表示不选择)
hdMp4
Int
是
标清Mp4格式(1表示选择,0表示不选择)
shdMp4
Int
是
高清Mp4格式(1表示选择,0表示不选择)
copyMp4
Int
否
使用copy模式转码成Mp4格式(1表示选择,0表示不选择)
sdFlv
Int
是
流畅Flv格式(1表示选择,0表示不选择)
hdFlv
Int
是
标清Flv格式(1表示选择,0表示不选择)
shdFlv
Int
是
高清Flv格式(1表示选择,0表示不选择)
copyFlv
Int
否
使用copy模式转码成Flv格式(1表示选择,0表示不选择)
sdHls
Int
是
流畅Hls格式(1表示选择,0表示不选择)
hdHls
Int
是
标清Hls格式(1表示选择,0表示不选择)
shdHls
Int
是
高清Hls格式(1表示选择,0表示不选择)
copyHls
Int
否
使用copy模式转码成Hls格式(1表示选择,0表示不选择)
aacAudio
Int
否
aac音频格式(1表示选择,0表示不选择)
mp3Audio
Int
否
mp3音频格式(1表示选择,0表示不选择)
transConfig
List
否
自定义模板信息,不设置为系统默认转码信息
transConfig参数详细说明
参数
类型
必须
说明
presetType
Int
是
自定义模板格式:1表示sdMp4,2表示hdMp4,3表示shdMp4,4表示sdFlv,5表示hdFlv,6表示shdFlv,7表示sdHls,8表示hdHls,9表示shdHls,16表示aac,17表示mp3
video
String
否
视频流配置,JSON对象,见参数video详情,若不设置表示转码为纯音频格式,对应presetType为16或17
audio
String
否
音频流配置,JSON对象,见参数audio详情
segmentTime
Int
否
hls格式的分片时长,取值范围:1-60,presetType为7、8、9时有效
textMarks
List
否
文字水印配置信息列表,JSON对象,见参数textMarks详情
参数video详情
参数
类型
必须
说明
codec
String
否
输出文件的视频编解码格式,包含:libx264,lib265,默认是libx264。其中lib265仅支持mp4和hls格式
bitRate
String
否
输出文件的视频码率,单位为bps。可设置值为auto或大于0的整数,默认是auto。auto表示跟随源视频码率
frameRate
String
否
输出文件的视频帧率,单位fps。可设置值为:auto、大于0,默认值为auto,auto表示跟随源视频帧率
maxWidth
String
否
输出文件的视频宽度,单位px。可设置值为:auto、0、[128,4096],默认值为auto,auto表示跟随源视频宽度,0表示保持视频宽高比的前提下,缩放视频使得视频高度等于maxHeight,注:此情况下,paddingPolicy必需是NoPad,maxHeight不能为0
maxHeight
String
否
输出文件的视频高度,可设置值为:auto、0、[128,4096],默认值为auto,auto表示跟随源视频高度,0表示保持视频宽高比的前提下,缩放视频使得视频宽度等于maxWidth,注:此情况下,paddingPolicy必需是NoPad,maxWidth不能为0
paddingPolicy
String
否
输出文件的缩放策略,输出视频若不能覆盖maxWidth*maxHeight区域,是否通过填补黑边将视频扩充到目标大小。可设置值为:NoPad、Pad,NoPad表示不填补黑边,Pad表示填补黑边
参数audio详情
参数
类型
必须
说明
codec
String
否
输出文件的音频编解码格式,包含:aac、mp3,默认是aac
bitRate
String
否
输出文件的音频码率,单位为bps。可设置值为:32000、64000、92000、128000、192000、256000、auto,默认是auto。auto表示跟随源音频码率
sampleRate
String
否
输出文件的音频采样率,单位为Hz。可设置值为:8000、11025、22050、32000、44100、48000、96000、auto,默认值是auto,auto表示跟随源音频采样率。注:若视频容器格式为flv,音频编解码格式选择为mp3时,采样率只能设置为44100或22050或11025
channel
String
否
输出文件的音频声道数,可设置值为:1、2、auto。默认值是auto,auto表示跟随源音频声道数
参数textMarks详情
参数
类型
必须
说明
content
String
是
文字内容
fontName
String
是
字体名字,目前支持:
(1) pingfang_bold (2) pingfang_light (3) pingfang_medium (4) pingfang_regular
fontSize
Int
否
字体大小,单位px,默认值是24
fontColor
String
否
文字颜色,取值#000000~#FFFFFF,默认值是#FFFFFF
fontOpacity
Float
否
文字透明度,取值范围0.0~1.0,0.0透明,1.0不透明,默认值是1.0
coordinate
String
否
相对于视频左上角的位置,支持两种格式:
(1)相对于左上角的绝对位置(单位px):如5_5
(2)相对于左上角的相对位置:如5%_5%
默认值是5%_5%
shadowX
Int
否
文字阴影x轴偏移量,单位px,默认是0
shadowY
Int
否
文字阴影y轴偏移量,单位px,默认是0
borderWidth
Int
否
文字边框宽度,单位px,默认是0
borderColor
String
否
文字边框颜色,取值#000000~#FFFFFF,默认值是#FFFFFF
borderOpacity
Double
否
文字边框透明度,取值范围0.0~1.0,0.0透明,1.0不透明,默认值是1.0
4.1.3 输出参数
参数
类型
说明
code
Int
状态码
presetId
Int
新生成的视频转码模板Id
msg
String
错误信息
4.1.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.1.5 示例代码
使用视频云默认的格式模板请求示例
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"presetName":"全高清","sdMp4":0,"hdMp4":1,"shdMp4":0,"sdFlv":0,"hdFlv":1,"shdFlv":0,"sdHls":0,"hdHls":1,"shdHls":0}' https://vcloud.163.com/app/vod/preset/create
输出1
{
"ret": {
"presetId": 184
},
"code": 200
}
使用自定义的格式参数请求示例
输入2
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"presetName":"自定义流畅转码模板","sdMp4":1,"hdMp4":0,"shdMp4":0,"sdFlv":0,"hdFlv":0,"shdFlv":0,"sdHls":0,"hdHls":0,"shdHls":0,"transConfig":[{"presetType":1,"video":{"codec":"libx264","maxWidth":"640","MaxHeight":"0","bitRate":"600000","paddingPolicy":"NoPad"},"audio":{"codec":"aac","sampleRate":"44100","channel":"auto","bitRate":"128000"},"textMarks":[{"content":"网易视频云","fontName":"pingfang_bold","fontSize":24,"fontColor":"#FFFFFF","fontOpacity":1.0,"coordinate":"5%_5%","shadowX":0,"shadowY":0,"borderWidth":1,"borderColor":"#000000","borderOpacity":1.0}]}]}' https://vcloud.163.com/app/vod/preset/create
输出2
{
"ret": {
"presetId": 185
},
"code": 200
}
4.2 获取视频转码模板信息
4.2.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/preset/get
获取单个视频转码模板信息,包括:Id、视频转码模板名称、视频转码模板对应的格式。
4.2.2 输入参数
参数
类型
必须
说明
presetId
Int
是
视频转码模板Id
4.2.3 输出参数
参数
类型
说明
code
Int
状态码
presetName
String
视频转码模板的名称
sdMp4
Int
流畅Mp4格式(1表示包含,0表示不包含)
hdMp4
Int
标清Mp4格式(1表示包含,0表示不包含)
shdMp4
Int
高清Mp4格式(1表示包含,0表示不包含)
sdFlv
Int
流畅Flv格式(1表示包含,0表示不包含)
hdFlv
Int
标清Flv格式(1表示包含,0表示不包含)
shdFlv
Int
高清Flv格式(1表示包含,0表示不包含)
sdHls
Int
流畅Hls格式(1表示包含,0表示不包含)
hdHls
Int
标清Hls格式(1表示包含,0表示不包含)
shdHls
Int
高清Hls格式(1表示包含,0表示不包含)
aacAudio
Int
aac音频格式(1表示选择,0表示不选择)
mp3Audio
Int
mp3音频格式(1表示选择,0表示不选择)
isDel
Int
是否允许被删除(默认模板不允许删除),1:允许,0:不允许
transConfig
List
自定义模板信息,JSON对象,如果模板为自定义,则包含此元素
msg
String
错误信息
4.2.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.2.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"presetId":184}' https://vcloud.163.com/app/vod/preset/get
输出1
{
"ret": {
"sdHls": 0,
"isDel": 1,
"shdHls": 0,
"hdHls": 1,
"presetId": 184,
"sdMp4": 0,
"sdFlv": 0,
"shdMp4": 0,
"shdFlv": 0,
"presetName": "全高清",
"hdFlv": 1,
"hdMp4": 1
},
"code": 200
}
4.3 获取视频转码模板列表
4.3.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/preset/list
获取视频转码模板列表,并做分页返回处理。单个视频转码模板的信息包括:Id、视频转码模板名称、视频转码模板对应的格式。
4.3.2 输入参数
参数
类型
必须
说明
currentPage
Int
是
获取视频转码模板列表分页后的索引
pageSize
Int
是
获取视频转码模板列表一页的记录数,取值范围:[1,500]
4.3.3 输出参数
参数
类型
说明
code
Int
状态码
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取视频转码模板列表的数目
list
List
获取的视频转码模板列表
list.presetId
Int
视频转码模板Id
list.presetName
String
视频转码模板的名称
list.sdMp4
Int
流畅Mp4格式(1表示包含,0表示不包含)
list.hdMp4
Int
标清Mp4格式(1表示包含,0表示不包含)
list.shdMp4
Int
高清Mp4格式(1表示包含,0表示不包含)
list.sdFlv
Int
流畅Flv格式(1表示包含,0表示不包含)
list.hdFlv
Int
标清Flv格式(1表示包含,0表示不包含)
list.shdFlv
Int
高清Flv格式(1表示包含,0表示不包含)
list.sdHls
Int
流畅Hls格式(1表示包含,0表示不包含)
list.hdHls
Int
标清Hls格式(1表示包含,0表示不包含)
list.shdHls
Int
高清Hls格式(1表示包含,0表示不包含)
list.aacAudio
Int
aac音频格式(1表示选择,0表示不选择)
list.mp3Audio
Int
mp3音频格式(1表示选择,0表示不选择)
list.isDel
Int
是否允许被删除(默认模板不允许删除),1:允许,0:不允许
list.transConfig
List
自定义模板信息,JSON对象,如果模板为自定义,则包含此元素
4.3.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.3.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":2}' https://vcloud.163.com/app/vod/preset/list
输出1
{
"ret": {
"pageSize": 2,
"totalRecords": 8,
"list": [
{
"sdHls": 0,
"isDel": 0,
"shdHls": 0,
"hdHls": 0,
"presetId": 39,
"sdMp4": 0,
"sdFlv": 0,
"shdMp4": 0,
"shdFlv": 0,
"presetName": "默认模板",
"hdFlv": 0,
"hdMp4": 0
},
{
"sdHls": 0,
"isDel": 1,
"shdHls": 0,
"hdHls": 0,
"presetId": 40,
"sdMp4": 1,
"sdFlv": 1,
"shdMp4": 0,
"shdFlv": 0,
"presetName": "dd",
"hdFlv": 0,
"hdMp4": 0
}
],
"currentPage": 1,
"pageNum": 4
},
"code": 200
}
4.4 修改视频转码模板信息
4.4.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/preset/update
用于视频文件转码,修改转码模板,可修改:视频转码模板名称、视频转码模板对应的格式。
4.4.2 输入参数
参数
类型
必须
说明
presetId
Int
是
视频转码模板的Id
presetName
String
是
视频转码模板的名称
sdMp4
Int
是
流畅Mp4格式(1表示选择,0表示不选择)
hdMp4
Int
是
标清Mp4格式(1表示选择,0表示不选择)
shdMp4
Int
是
高清Mp4格式(1表示选择,0表示不选择)
sdFlv
Int
是
流畅Flv格式(1表示选择,0表示不选择)
hdFlv
Int
是
标清Flv格式(1表示选择,0表示不选择)
shdFlv
Int
是
高清Flv格式(1表示选择,0表示不选择)
sdHls
Int
是
流畅Hls格式(1表示选择,0表示不选择)
hdHls
Int
是
标清Hls格式(1表示选择,0表示不选择)
shdHls
Int
是
高清Hls格式(1表示选择,0表示不选择)
aacAudio
Int
否
aac音频格式(1表示选择,0表示不选择)
mp3Audio
Int
否
mp3音频格式(1表示选择,0表示不选择)
transConfig
List
否
自定义模板信息,JSON对象,不设置为系统默认转码信息
4.4.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
4.4.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.4.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"presetId":184,"presetName":"全转码","sdMp4":1,"hdMp4":1,"shdMp4":1,"sdFlv":1,"hdFlv":1,"shdFlv":1,"sdHls":1,"hdHls":1,"shdHls":1}' https://vcloud.163.com/app/vod/preset/update
输出1
{
"ret": {},
"code": 200
}
4.5 删除视频转码模板
4.5.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/preset/presetDelete
删除视频转码模板。
4.5.2 输入参数
参数
类型
必须
说明
presetId
Int
是
视频转码模板Id
4.5.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
4.5.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.5.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"presetId":184}' https://vcloud.163.com/app/vod/preset/presetDelete
输出1
{
"ret": {},
"code": 200
}
4.6 创建视频水印模板
4.6.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/watermark/create
用于视频文件管理水印,增加水印模板。
4.6.2 输入参数
参数
类型
必须
说明
watermarkName
String
是
视频水印的名称
imageId
Int
是
视频水印图片的Id
description
String
否
视频水印的描述信息
coordinate
String
否
视频水印左上角的坐标,其值为相对值,比如:
8%_6%表示在视频左上角的偏右8%视频宽度、偏下6%视频高度的位置。
如果不选填,默认设置为5%_5%
scale
String
否
视频水印的长宽,其值为相对值,比如:
10%x15%表示宽为视频宽度的10%,高为视频高度的15%。
如果不选填,默认设置为不缩放或拉伸
重要提示:不建议设置水印的scale参数,缩放或拉伸水印图片会影响水印图片的效果,可能会出现模糊现象。
4.6.3 输出参数
参数
类型
说明
code
Int
状态码
watermarkId
Int
视频水印Id
msg
String
错误信息
4.6.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.6.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"watermarkName":"梅花水印","imageId":1,"description":"梅花水印","coordinate":"8%_6%"}' https://vcloud.163.com/app/vod/watermark/create
输出1
{
"ret": {
"watermarkId": 16
},
"code": 200
}
4.7 获取视频水印模板信息
4.7.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/watermark/get
获取单个视频水印模板信息,包括:Id、视频水印模板名称、视频水印模板对应的配置参数。
4.7.2 输入参数
参数
类型
必须
说明
watermarkId
Int
是
视频水印模板Id
4.7.3 输出参数
参数
类型
说明
code
Int
状态码
watermarkId
Int
视频水印模板Id
watermarkName
String
视频水印模板的名称
description
String
视频水印的描述信息
coordinate
String
视频水印左上角的坐标,其值为相对值,比如:
8%_6%表示在视频左上角的偏右8%视频宽度、偏下6%视频高度的位置。
如果不选填,默认设置为5%_5%
scale
String
视频水印的长宽,其值为相对值,比如:
10%x15%表示长为视频宽度的10%,宽为视频宽度的15%。
如果不选填,默认设置为不缩放或拉伸
imageId
Int
水印图片Id
imageUrl
String
水印图片URL
isDel
Int
是否允许被删除(默认水印不允许删除),1:允许,0:不允许
msg
String
错误信息
4.7.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.7.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"watermarkId":16}' https://vcloud.163.com/app/vod/watermark/get
输出1
{
"ret": {
"scale": null,
"watermarkName": "梅花水印",
"coordinate": "8%_6%",
"description": "梅花水印",
"watermarkId": 16,
"imageId": 21,
"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",
"isDel": 1
},
"code": 200
}
4.8 获取视频水印模板列表
4.8.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/watermark/list
获取视频水印模板列表,并做分页返回处理。单个视频水印模板的信息包括:Id、视频水印模板名称、视频水印模板对应的配置参数。
4.8.2 输入参数
参数
类型
必须
说明
currentPage
Int
是
获取视频水印模板列表分页后的索引
pageSize
Int
是
获取视频水印模板列表一页的记录数,取值范围:[1,500]
4.8.3 输出参数
参数
类型
说明
code
Int
状态码
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取视频水印转码模板列表的分类数目
list
List
获取的视频水印模板列表
list.watermarkId
Int
视频水印模板Id
list.watermarkName
String
视频水印模板的名称
list.description
String
视频水印的描述信息
list.coordinate
String
视频水印左上角的坐标,其值为相对值,比如:
8%_6%表示在视频左上角的偏右8%视频宽度、偏下6%视频高度的位置。
如果不选填,默认设置为5%_5%
list.scale
String
视频水印的长宽,其值为相对值,比如:
10%x15%表示长为视频宽度的10%,宽为视频宽度的15%。
如果不选填,默认设置为不缩放或拉伸
list.imageId
Int
水印图片Id
list.imageUrl
String
水印图片URL
list.isDel
Int
是否允许被删除(默认水印不允许删除),1:允许,0:不允许
4.8.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.8.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":2}' https://vcloud.163.com/app/vod/watermark/list
输出1
{
"ret": {
"pageSize": 2,
"totalRecords": 9,
"list": [
{
"scale": "10%x15%",
"watermarkName": "小熊水印",
"coordinate": "20%_12%",
"description": "ss",
"watermarkId": 6,
"imageId": 21,
"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",
"isDel": 1
},
{
"scale": "10%x15%",
"watermarkName": "royen_test",
"coordinate": "5%_5%",
"description": null,
"watermarkId": 7,
"imageId": 21,
"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",
"isDel": 1
}
],
"currentPage": 1,
"pageNum": 5
},
"code": 200
}
4.9 修改视频水印模板
4.9.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/watermark/update
用于修改水印模板,可修改:视频转码模板名称、视频转码模板对应的格式。
4.9.2 输入参数
参数
类型
必须
说明
watermarkId
Int
是
视频水印模板Id
watermarkName
String
是
视频水印的名称
description
String
否
视频水印的描述信息
coordinate
String
否
视频水印左上角的坐标,其值为相对值,比如:
8%_6%表示在视频左上角的偏右8%视频宽度、偏下6%视频高度的位置。
如果不选填,默认设置为5%_5%
scale
String
否
视频水印的长宽,其值为相对值,比如:
10%x15%表示长为视频宽度的10%,宽为视频宽度的15%。
如果不选填,默认设置为不缩放或拉伸
imageId
Int
否
水印图片Id
4.9.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
4.9.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.9.5 示例代码
输入1
curl -X POST-H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"watermarkId":6,"watermarkName":"haha","coordinate":"20%_20%"}' https://vcloud.163.com/app/vod/watermark/update
输出1
{
"ret": {},
"code": 200
}
4.10 删除视频水印模板
4.10.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/watermark/delete
删除水印模板。
4.10.2 输入参数
参数
类型
必须
说明
watermarkId
Int
是
视频水印模板Id
4.10.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
4.10.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.10.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"watermarkId":6}' https://vcloud.163.com/app/vod/watermark/delete
输出1
{
"ret": {},
"code": 200
}
4.11 视频文件转码
4.11.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/transcode/resetmulti
用于视频转码,批量进行视频转码(只有处于正常或转码失败状态的视频才允许执行此操作)。
4.11.2 输入参数
参数
类型
必须
说明
vids
List
是
多个视频Id组成的列表
presetId
Int
是
转码模板Id
watermarkId
Int
否
视频水印Id(不填写为不添加水印,且若填写,presetId值不能为默认模板)
userDefInfo
String
否
用户自定义信息,回调会返回此信息
transOffset
Int
否
视频转码处理裁剪视频的起始位置(单位:秒)
transDuration
Int
否
视频转码处理裁剪视频的视频时长(单位:秒)
dynamicTransConfig
List
否
视频动态转码详细参数配置列表,不设置则以presetId的配置为准,设置则会覆盖presetId对应的transConfig中相同presetType的配置。详见参数dynamicTransConfig
参数dynamicTransConfig详情
参数
类型
必须
说明
presetType
Int
是
自定义模板格式:1表示sdMp4,2表示hdMp4,3表示shdMp4,4表示sdFlv,5表示hdFlv,6表示shdFlv,7表示sdHls,8表示hdHls,9表示shdHls,16表示aac,17表示mp3
textMarks
List
否
文字水印配置信息列表,JSON对象,详见本文4.1.2小节参数textMarks
4.11.3 输出参数
参数
类型
说明
code
Int
状态码
successCount
Int
转码成功的数量
failCount
Int
转码失败的数量
passCount
Int
转码忽略的数量,即已经存在该转码格式视频
msg
String
错误信息
4.11.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.11.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vids":[29,30],"presetId":174,"watermarkId":23,"dynamicTransConfig":[{"presetType":1,"textMarks":[{"content":"网易视频云","fontName":"pingfang_bold","fontSize":24,"fontColor":"#FFFFFF","fontOpacity":1.0,"coordinate":"5%_5%","shadowX":0,"shadowY":0,"borderWidth":1,"borderColor":"#000000","borderOpacity":1.0}]}]}' https://vcloud.163.com/app/vod/transcode/resetmulti
输出1
{
"ret": {
"passCount": 0,
"failCount": 0,
"successCount": 2
},
"code": 200
}
4.12 设置转码回调地址
4.12.1 转码回调说明
网易视频云点播的转码回调通知分为单个级别和用户级别,且处理优先级为:单个级别->用户级别->无回调。当用户设置了单个级别的回调地址,使用单个级别的回调地址;否则查询是否设置用户级别的回调地址,如果设置,使用用户级别的回调地址;否则不回调通知。单个级别的回调通知在上传初始化中指定,用户级别的回调通知可通过本接口设置。
回调通知会在请求头中增加sign字段,其值为拼接回调包体内容的字符串和签名字符串,然后对拼接后的字符串进行md5加密(32位小写)。签名字符串可通过本接口设置,默认为:vcloud。
目前网易视频云点播支持转码结果回调通知。
4.12.2 接口描述
域名:vcloud.163.com
接口名:/app/vod/transcode/setcallback
用于视频转码,设置转码成功后的回调地址。
4.12.3 输入参数
参数
类型
必须
说明
callbackUrl
String
否
转码成功后回调客户端的URL地址
signKey
String
否
转码成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过32位
4.12.4 输出参数
参数
类型
说明
code
Int
状态码
successCount
Int
转码成功的数量
failCount
Int
转码失败的数量
passCount
Int
转码忽略的数量,即已经存在该转码格式视频
msg
String
错误信息
4.12.5 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
4.12.6 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/transcode/setcallback
输出1
{
"msg" : "",
"code" : 200
}
4.12.7 转码成功回调内容示例
{"sdFlvAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/flv/rDM5V7HM_1021_sd.flv","name":"snow.mp4","type":"transcode","vid":1021,"user_defined":"userId=123456"}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,上传回调固定为“transcode”
vid
Long
视频文件标识
name
String
视频文件名称
sdMp4Addr
String
流畅mp4视频的播放地址
hdMp4Addr
String
标清mp4视频的播放地址
shdMp4Addr
String
高清mp4视频的播放地址
sdFlvAddr
String
流畅flv视频的播放地址
hdFlvAddr
String
标清flv视频的播放地址
shdFlvAddr
String
高清flv视频的播放地址
sdHlsAddr
String
流畅hls视频的播放地址
hdHlsAddr
String
标清hls视频的播放地址
shdHlsAddr
String
高清hls视频的播放地址
user_defined
String
用户自定义字段值(转码时设置的值)
4.12.8 转码失败回调内容示例
{"error":{"msg":"Failed","type":"transcode","vid":1021,"user_defined":"userId=123456","name":"snow.mp4"}}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,上传回调固定为“transcode”
vid
Long
视频文件标识
name
String
视频文件名称
msg
String
转码失败原因
user_defined
String
用户自定义字段值(转码时设置的值)
5 文件管理
文件管理模块主要展示视频图片等文件管理相关的API调用和代码示例。包括视频管理、分类管理、截图及封面管理等功能。
5.1 获取视频文件信息
5.1.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/get
获取单个视频文件信息,包括:Id、视频名称、各个视频格式的播放地址、各个视频格式的下载地址、各个视频格式的视频大小、视频截图地址、视频所属分类Id和名称、视频播放时长、视频转码完成时间。
5.1.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
5.1.3 输出参数
参数
类型
说明
code
Int
状态码
videoName
String
视频的名称
vid
Long
视频Id
status
Int
视频的状态,10表示初始,20表示失败,30表示处理中,40表示成功,50表示屏蔽,70表示加密中,80表示加密失败
description
String
视频的描述信息
completeTime
Long
转码完成时间
duration
Int
视频播放时长(单位:秒)
durationMsec
Int
视频播放时长(单位:毫秒)
width
String
视频宽度,默认为"0"
height
String
视频高度,默认为"0"
typeId
Int
视频所属分类Id
typeName
String
视频所属分类名称
snapshotUrl
String
视频封面截图URL地址
origUrl
String
原始视频的播放地址
downloadOrigUrl
String
原始视频的下载地址
initialSize
Long
原始视频文件大小(单位:字节)
sdMp4Url
String
流畅Mp4视频格式文件播放地址
downloadSdMp4Url
String
流畅Mp4视频格式文件下载地址
sdMp4Size
Int
流畅Mp4视频格式文件的大小(单位:字节)
sdMp4Width
String
流畅Mp4视频宽度,默认为"0"
sdMp4Height
String
流畅Mp4视频高度,默认为"0"
hdMp4Url
String
标清Mp4视频格式文件播放地址
downloadHdMp4Url
String
标清Mp4视频格式文件下载地址
hdMp4Size
Int
标清Mp4视频格式文件的大小(单位:字节)
hdMp4Width
String
标清Mp4视频宽度,默认为"0"
hdMp4Height
String
标清Mp4视频高度度,默认为"0"
shdMp4Url
String
高清Mp4视频格式文件播放地址
downloadShdMp4Url
String
高清Mp4视频格式文件下载地址
shdMp4Size
Int
高清Mp4视频格式文件的大小(单位:字节)
shdMp4Width
String
高清Mp4视频宽度,默认为"0"
shdMp4Height
String
高清Mp4视频高度,默认为"0"
sdFlvUrl
String
流畅Flv视频格式文件播放地址
downloadSdFlvUrl
String
流畅Flv视频格式文件下载地址
sdFlvSize
Int
流畅Flv视频格式文件的大小(单位:字节)
sdFlvWidth
String
流畅Flv视频宽度,默认为"0"
sdFlvHeight
String
流畅Flv视频高度,默认为"0"
hdFlvUrl
String
标清Flv视频格式文件播放地址
downloadHdFlvUrl
String
标清Flv视频格式文件下载地址
hdFlvSize
Int
标清Flv视频格式文件的大小(单位:字节)
hdFlvWidth
String
标清Flv视频宽度,默认为"0"
hdFlvHeight
String
标清Flv视频高度,默认为"0"
shdFlvUrl
String
高清Flv视频格式文件播放地址
downloadShdFlvUrl
String
高清Flv视频格式文件下载地址
shdFlvSize
Int
高清Flv视频格式文件的大小(单位:字节)
shdFlvWidth
String
高清Flv视频宽度,默认为"0"
shdFlvHeight
String
高清Flv视频高度,默认为"0"
sdHlsUrl
String
流畅Hls视频格式文件播放地址
downloadSdHlsUrl
String
流畅Hls视频格式文件下载地址
sdHlsSize
Int
流畅Hls视频格式文件的大小(单位:字节)
sdHlsWidth
String
流畅Hls视频宽度,默认为"0"
sdHlsHeight
String
流畅Hls视频高度,默认为"0"
hdHlsUrl
String
标清Hls视频格式文件播放地址
downloadHdHlsUrl
String
标清Hls视频格式文件下载地址
hdHlsSize
Int
标清Hls视频格式文件的大小(单位:字节)
hdHlsWidth
String
标清Hls视频宽度,默认为"0"
hdHlsHeight
String
标清Hls视频高度,默认为"0"
shdHlsUrl
String
高清Hls视频格式文件播放地址
downloadShdHlsUrl
String
高清Hls视频格式文件下载地址
shdHlsSize
Int
高清Hls视频格式文件的大小(单位:字节)
shdHlsWidth
String
高清Hls视频宽度,默认为"0"
shdHlsHeight
String
高清Hls视频高度,默认为"0"
createTime
Long
视频上传时间(单位:毫秒)
updateTime
Long
视频更新时间(单位:毫秒)
msg
String
错误信息
5.1.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.1.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32}' https://vcloud.163.com/app/vod/video/get
输出1
{
"ret": {
"createTime": 1466578358729,
"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/44d30332-7402-4b2f-82c8-154dbb6b4e14.mp4",
"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/44d30332-7402-4b2f-82c8-154dbb6b4e14.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558005&download=watermark_test_1.mp4&Signature=%2BGu%2BvgiUP1rL4pbx%2B52GH4QCo%2FOHAtlhgzCzPV9f0vc%3D",
"shdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_shd.mp4",
"sdMp4Size": 17906823,
"videoName": "watermark_test_1",
"downloadSdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_sd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E6%25A0%2587%25E6%25B8%2585_watermark_test_1.mp4&Signature=64FOWYzLciWyTe8hmLMRVCYRCsQLbEOWtNqcB9rUj18%3D",
"description": null,
"hdMp4Size": 25227850,
"downloadSdFlvUrl": "http://vodk32ywxdf.nosdn.127.net/nos%2Fflv%2F2016%2F06%2F22%2Fv32_sd.flv?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E6%25A0%2587%25E6%25B8%2585_watermark_test_1.flv&Signature=pGmKYIjWq%2FZE9Gu8K1MZcuqQYG83cI2bnuiikLO8TCk%3D",
"vid": 32,
"shdMp4Size": 39874022,
"sdFlvUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/flv/2016/06/22/v32_sd.flv",
"sdFlvSize": 18013302,
"hdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_hd.mp4",
"status": 40,
"updateTime": 1466663164342,
"sdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_sd.mp4",
"downloadHdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_hd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E9%25AB%2598%25E6%25B8%2585_watermark_test_1.mp4&Signature=kMUKJGcW8aSFauL2836pXA5UrEeowq2hLdpgMpjmr44%3D",
"downloadShdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_shd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E8%25B6%2585%25E6%25B8%2585_watermark_test_1.mp4&Signature=ch30%2BtX20b54UeskhFZs37r55jkt2WIV87jlaZgKmPY%3D",
"typeName": "默认分类",
"duration": 195,
"snapshotUrl": "http://vodk32ywxdf.nosdn.127.net/6c4a9501-ee3c-4e00-9a5f-20f6616f0ad3.jpg",
"initialSize": 15601202,
"typeId": 38,
"completeTime": 1466663164342
},
"code": 200
}
5.2 获取视频文件信息列表
5.2.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/list
获取视频文件信息列表,并做分页返回处理。单个视频转码模板的信息包括:Id、视频转码模板名称、视频转码模板对应的格式。
使用时 ,建议先合理设置好时间区段(从beginTime到endTime),然后再设置currentPage与pageSize。该接口将在所设定的时段内,检索最多5000个文件。若需要获取超过5000个文件,建议分时段多次查询获取。
5.2.2 输入参数
参数
类型
必须
说明
currentPage
Int
是
获取视频列表分页后的索引
pageSize
Int
是
获取视频列表一页的记录数,取值范围:[1,500],currentPage * pageSize不能超过5000
beginTime
Long
否
需要查询的开始时间戳(单位:毫秒)
endTime
Long
否
需要查询的结束时间戳(单位:毫秒)
status
Int
是
根据视频状态过滤选择(0表示获取所有状态视频,10表示初始,20表示失败,30表示处理中,40表示成功,50表示屏蔽,70表示加密中,80表示加密失败)
type
Int
是
根据视频分类过滤选择(0表示获取所有分类视频)
sortStr
String
否
按视频上传时间排序,desc表示按上传时间降序,asc表示按上传时间升序,默认为desc
为避免分页过大,建议您合理选择sortStr。比如,如果您想删除时间久远的视频,可以设置sortStr=asc,再调用删除接口进行删除。
5.2.3 输出参数
参数
类型
说明
code
Int
状态码
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取视频列表的分类数目
list
List
获取的视频列表
list.videoName
String
视频的名称
list.status
Int
视频的状态,10表示初始,20表示失败,30表示处理中,40表示成功,50表示屏蔽
list.description
String
视频的描述信息
list.completeTime
Long
转码完成时间
list.duration
Int
视频播放时长(单位:秒)
list.durationMsec
Int
视频播放时长(单位:毫秒)
list.typeId
Int
视频所属分类Id
list.typeName
String
视频所属分类名称
list.snapshotUrl
String
视频封面截图URL地址
list.origUrl
String
原始视频的播放地址
list.downloadOrigUrl
String
原始视频的下载地址
list.initialSize
Long
原始视频文件大小(单位:字节)
list.sdMp4Url
String
流畅Mp4视频格式文件播放地址
list.downloadSdMp4Url
String
流畅Mp4视频格式文件下载地址
list.sdMp4Size
Int
流畅Mp4视频格式文件的大小(单位:字节)
list.hdMp4Url
String
标清Mp4视频格式文件播放地址
list.downloadHdMp4Url
String
标清Mp4视频格式文件下载地址
list.hdMp4Size
Int
标清Mp4视频格式文件的大小(单位:字节)
list.shdMp4Url
String
高清Mp4视频格式文件播放地址
list.downloadShdMp4Url
String
高清Mp4视频格式文件下载地址
list.shdMp4Size
Int
高清Mp4视频格式文件的大小(单位:字节)
list.sdFlvUrl
String
流畅Flv视频格式文件播放地址
list.downloadSdFlvUrl
String
流畅Flv视频格式文件下载地址
list.sdFlvSize
Int
流畅Flv视频格式文件的大小(单位:字节)
list.hdFlvUrl
String
标清Flv视频格式文件播放地址
list.downloadHdFlvUrl
String
标清Flv视频格式文件下载地址
list.hdFlvSize
Int
标清Flv视频格式文件的大小(单位:字节)
list.shdFlvUrl
String
高清Flv视频格式文件播放地址
list.downloadShdFlvUrl
String
高清Flv视频格式文件下载地址
list.shdFlvSize
Int
高清Flv视频格式文件的大小(单位:字节)
list.sdHlsUrl
String
流畅Hls视频格式文件播放地址
list.downloadSdHlsUrl
String
流畅Hls视频格式文件下载地址
list.sdHlsSize
Int
流畅Hls视频格式文件的大小(单位:字节)
list.hdHlsUrl
String
标清Hls视频格式文件播放地址
list.downloadHdHlsUrl
String
标清Hls视频格式文件下载地址
list.hdHlsSize
Int
标清Hls视频格式文件的大小(单位:字节)
list.shdHlsUrl
String
高清Hls视频格式文件播放地址
list.downloadShdHlsUrl
String
高清Hls视频格式文件下载地址
list.shdHlsSize
Int
高清Hls视频格式文件的大小(单位:字节)
list.createTime
Long
视频上传时间(单位:毫秒)
list.updateTime
Long
视频更新时间(单位:毫秒)
list.vid
Long
视频Id
5.2.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.2.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":2,"status":0,"type":0}' https://vcloud.163.com/app/vod/video/list
输出1
{
"ret": {
"pageSize": 2,
"totalRecords": 28,
"list": [
{
"typeName": "默认分类",
"createTime": 1467007983618,
"duration": 0,
"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/02a32b58-39fa-4d04-aeca-d7defa7e8972.jpg",
"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/02a32b58-39fa-4d04-aeca-d7defa7e8972.jpg?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558273&download=qwqwqw.jpg&Signature=0b5yMclktt%2FpDBQIZU8bLB6suouXLMfGZhqECFDp8%2Bw%3D",
"status": 40,
"updateTime": 1467007983618,
"description": null,
"snapshotUrl": null,
"initialSize": 6354,
"videoName": "qwqwqw",
"typeId": 38,
"completeTime": null,
"vid": 39
},
{
"typeName": "默认分类",
"createTime": 1467007653656,
"duration": 0,
"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/dcffdc0d-0735-41e1-8d30-d1d19450137f.jpg",
"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/dcffdc0d-0735-41e1-8d30-d1d19450137f.jpg?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558273&download=Chrysanthemum.jpg&Signature=oxa5%2F60xl8dmhtLoS21p97J%2BrnsRWFP12c30oA6Sh3o%3D",
"status": 40,
"updateTime": 1467007653656,
"description": null,
"snapshotUrl": null,
"initialSize": 879394,
"videoName": "Chrysanthemum",
"typeId": 38,
"completeTime": null,
"vid": 38
}
],
"currentPage": 1,
"pageNum": 14
},
"code": 200
}
5.3 视频文件信息编辑
5.3.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/edit
用于视频文件信息管理,修改视频文件信息,可修改:视频文件名称、视频分类Id和视频描述信息。
5.3.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
videoName
String
是
视频的名称
typeId
Int
是
视频分类Id
description
String
否
视频的描述信息
5.3.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.3.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.3.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":20,"videoName":"for_love.mp4","typeId":20,"description":"编辑视频"}' https://vcloud.163.com/app/vod/video/edit
输出1
{
"ret": {},
"code": 200
}
5.4 删除单个转码输出视频
5.4.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/delete_single
用于视频管理,删除单个转码输出视频(不允许删除单个源视频)。
5.4.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
style
Int
是
视频转码格式(1表示流畅mp4,2表示标清mp4,3表示高清mp4,
4表示流畅flv,5表示标清flv,6表示高清flv,
7表示流畅hls,8表示标清hls,9表示高清hls)
5.4.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.4.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.4.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32,"style":3}' https://vcloud.163.com/app/vod/video/delete_single
输出1
{
"ret": {},
"code": 200
}
5.5 删除视频源文件
5.5.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/videoDelete
用于视频管理,删除视频文件。
5.5.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
5.5.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.5.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.5.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32}' https://vcloud.163.com/app/vod/video/videoDelete
输出1
{
"ret": {},
"code": 200
}
5.6 视频屏蔽
5.6.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/videoDisable
用于视频管理,屏蔽视频文件(只有正常状态下的视频才能做屏蔽操作)。
5.6.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
5.6.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.6.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.6.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":35}' https://vcloud.163.com/app/vod/video/videoDisable
输出1
{
"ret": {},
"code": 200
}
5.7 视频恢复
5.7.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/videoRecover
用于视频管理,恢复视频文件(只有被屏蔽的视频才能做恢复操作)。
5.7.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
5.7.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.7.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.7.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":35}' https://vcloud.163.com/app/vod/video/videoRecover
输出1
{
"ret": {},
"code": 200
}
5.8 批量删除视频
5.8.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/delete
用于视频管理,批量删除视频文件。
5.8.2 输入参数
参数
类型
必须
说明
vids
List
是
多个视频ID组成的列表,最多一次删除50个视频
5.8.3 输出参数
参数
类型
说明
code
Int
错误码
msg
String
错误信息
5.8.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
724
部分删除操作成功
5.8.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vids":[20]}' https://vcloud.163.com/app/vod/video/delete
输出1
"Content-Type": "application/json; charset=utf-8"
{
"code" : 200,
"msg" : ""
}
输入2
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vids":[20,21,23,24]}' https://vcloud.163.com/app/vod/video/delete
输出2
"Content-Type": "application/json; charset=utf-8"
{
"code" : 724,
"ret" : {
"failedVids" : [23,24]
}
}
code参考code状态表
5.9 创建视频分类
5.9.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/create
用于管理视频文件,增加分类。
5.9.2 输入参数
参数
类型
必须
说明
typeName
String
是
视频分类的名称
parentTypeId
Int
否
父分类Id
description
String
否
视频分类的描述信息
5.9.3 输出参数
参数
类型
说明
code
Int
状态码
typeId
Int
新生成的视频分类Id
msg
String
错误信息
5.9.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.9.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"typeName":"movie","parentTypeId":0,"description":"电影"}' https://vcloud.163.com/app/vod/type/create
输出1
{
"ret" : {
"typeId" : 1
},
"code" : 200
}
5.10 获取视频分类信息
5.10.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/get
获取单个视频分类信息,包括:Id、分类描述信息、分类数目和分类的创建时间。
5.10.2 输入参数
参数
类型
必须
说明
typeId
Int
是
视频分类的Id
5.10.3 输出参数
参数
类型
说明
code
Int
状态码
typeId
Int
视频分类Id
typeName
String
视频分类的名称
parentTypeId
Int
父分类Id
desc
String
视频分类的描述信息
number
Int
该类别下的视频文件数量
isDel
Int
是否允许被删除(默认分类不允许删除),1:允许,0:不允许
createTime
Long
视频分类的创建时间(单位:毫秒)
childNum
Int
子分类数量
msg
String
错误信息
5.10.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.10.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"typeId":227}' https://vcloud.163.com/app/vod/type/get
输出1
{
"ret": {
"typeName": "movie",
"createTime": 1467006327149,
"isDel": 1,
"desc": "电影",
"number": 0,
"typeId": 227,
"parentTypeId": 0,
"childNum": 2
},
"code": 200
}
5.11 获取视频分类列表信息
5.11.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/list
获取视频分类列表,并做分页返回处理。单个视频的分类信息包括:Id、分类描述信息、分类数目和分类的创建时间。
5.11.2 输入参数
参数
类型
必须
说明
currentPage
Int
是
获取视频分类列表分页后的索引
pageSize
Int
是
获取视频分类列表一页的记录数,取值范围:[1,500]
5.11.3 输出参数
参数
类型
说明
code
Int
状态码
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取视频分类列表的分类数目
list
List
获取的视频分类列表
list.typeId
Int
视频分类Id
list.typeName
String
视频分类的名称
list.parentTypeId
Int
父分类Id
list.desc
String
视频分类的描述信息
list.number
Int
该类别下的视频文件数量
list.isDel
Int
是否允许被删除(默认分类不允许删除),1:允许,0:不允许
list.childNum
Int
子分类数量
list.createTime
Long
视频分类的创建时间(单位:毫秒)
5.11.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.11.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":2}' https://vcloud.163.com/app/vod/type/list
输出1
{
"ret": {
"pageSize": 2,
"totalRecords": 4,
"list": [
{
"typeName": "默认分类",
"createTime": 1464229521940,
"isDel": 0,
"desc": "默认分类",
"number": 47,
"typeId": 38,
"childNum": 0
},
{
"typeName": "直播录制",
"createTime": 1464229521940,
"isDel": 0,
"desc": "直播录制",
"number": 1,
"typeId": 39,
"childNum": 0
}
],
"currentPage": 1,
"pageNum": 2
},
"code": 200
}
5.12 修改视频分类信息
5.12.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/update
用于管理视频文件,修改分类,可修改:分类名称、分类描述信息。
5.12.2 输入参数
参数
类型
必须
说明
typeId
Int
是
视频分类的Id
typeName
String
是
视频分类的名称
description
String
否
视频分类的描述信息
5.12.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.12.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.12.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"typeId":227, "typeName":"娱乐","description":"更改分类"}' https://vcloud.163.com/app/vod/type/update
输出1
{
"ret": {},
"code": 200
}
5.13 删除视频分类
5.13.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/typeDelete
删除视频分类。
5.13.2 输入参数
参数
类型
必须
说明
typeId
Int
是
视频分类Id
5.13.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.13.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.13.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"typeId":227}' https://vcloud.163.com/app/vod/type/typeDelete
输出1
{
"ret": {},
"code": 200
}
5.14 设置视频的分类
5.14.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/type/set
设置视频的分类。
5.14.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
typeId
Int
是
视频分类的Id
5.14.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.14.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.14.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":12,"typeId":227}' https://vcloud.163.com/app/vod/type/set
输出1
{
"ret": {},
"code": 200
}
5.15 获取视频截图地址
5.15.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/snapshot/create
针对具体文件,获取其不同尺寸下的截图URL地址。支持截图的文件格式:
mpegts、mov、mp4、m4a、3gp、3g2、mj2、rm、asf、flv、avi、matroska、
webm、mpeg、mpeg、mpegtsraw、mpegvideo、mtv、mv、mvi、nuv、3gp、
avs、avsvideo、adxl、dv、dvd、flic、flac、h261、h263、h264、hls、m4v、
mjpeg、rawvideo、rpl、avcd、truehd、vc-1、vcd。
如有不支持格式视频,请进行转码,接口会根据转码后的视频截取图片。
截取图片比例如果和视频尺寸比例不相符合,会自动填充黑边,保证图片显示正常。
5.15.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
size
Int
是
截图尺寸,包含以下几种值:
0表示原始视频比例,1表示640x360,2表示400x300,3表示320x180,
4表示200x150,5表示1280x720,6表示960x720,7表示360x640,
8表示300x400,9表示180x320,10表示150x200,11表示720x1280,
12表示720x960,13表示180x180,14表示360x360,15表示720x720
offset
Int
否
截图偏移,包含以下几种值:
0表示视频第一秒,1表示时间轴10%位置,2表示时间轴20%位置,
3表示时间轴30%位置,4表示时间轴40%位置,5表示时间轴50%位置,
6表示时间轴60%位置,7表示时间轴70%位置,8表示时间轴80%位置,
9表示时间轴90%位置
customWidth
Int
否
自定义截图宽度,可设置值为(0,4000]
customHeight
Int
否
自定义截图高度,可设置值为(0,4000]
customOffset
Long
否
自定义截图时间戳,单位毫秒
style
Int
否
视频转码格式(0表示源视频,1表示流畅mp4,2表示标清mp4,3表示高清mp4, 4表示流畅flv,5表示标清flv,6表示高清flv, 7表示流畅hls,8表示标清hls,9表示高清hls) 如果设置了style,则会根据指定格式的视频进行截图
重要提示:
如需自定义截图宽高信息,customWidth和customHeight需同时不为空。
如果offset和customOffset都填写,以customOffset为准。如果offset和customOffset都不填写,默认offset=0。
5.15.3 输出参数
参数
类型
说明
code
Int
状态码
url
String
截图地址
width
String
截图宽度
height
String
截图高度
msg
String
错误信息
5.15.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.15.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":12,"size":1,"offset":0}' https://vcloud.163.com/app/vod/snapshot/create
输出1
"Content-Type": "application/json; charset=utf-8"
{
"ret" : {
"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg",
"width" : "640",
"height" : "320"
},
"code" : 200
}
5.16 设置视频封面
5.16.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/snapshot/set
为视频设置显示封面。
5.16.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频Id
type
Int
是
封面设置方法:1表示使用截图URL,2表示使用本地上传图片
path
String
是
type值为1,则代表截图URL;type值为2,则代表本地图片路径
data
String
否
type值为2时,需填写,代表本地图片数据的base64编码字符串数据
重要提示:使用截图URL设置视频封面的URL必需是存储在网易视频云点播服务的URL,暂不支持第三方URL。
5.16.3 输出参数
参数
类型
说明
code
Int
状态码
url
String
截图地址
msg
String
错误信息
5.16.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.16.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":12,"type":1,"path":"http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"}' https://vcloud.163.com/app/vod/snapshot/set
输出1
"Content-Type": "application/json; charset=utf-8"
{
"ret" : {
"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"
},
"code" : 200
}
5.17 生成视频预览
5.17.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/videoPreview
为视频生成预览,包括:动图和视频。
5.17.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频的标识
format
Int
是
生成的视频预览格式,1表示webp格式,2表示mp4格式,3表示flv格式,4表示hls格式,5表示gif格式
samplings
List
是
采样的视频时间区间列表,包含一组sampling,
区间个数最多5个,单位为秒,区间时长小于等于3s区间,可以有重合,区间顺序有意义
callbackUrl
String
否
处理完成后回调的URL地址(需标准http格式),如不设置,使用默认的转码回调地址
userDefInfo
String
否
用户自定义信息,回调会返回此信息
keepAspectRatio
Int
否
是否保持输出文件与原视频宽高比,0表示不保持,1表示保持,默认为1
outputWidth
Int
否
输出文件的宽度,取值大于等于0且小于等于4096,默认为0
outputHeight
Int
否
输出文件的高度,取值大于等于0且小于等于4096,默认为0
frameRate
Int
否
输出帧率,取值不超过30且大于0,若等于0,则保持与原视频一致,默认为8
bitRate
Int
否
比特率,取值大于0,不设置则保持和原视频相同
enableLoop
Int
否
webp格式的预览是否循环, 0表示不循环, 1表示循环,默认为0
sampling参数详细说明
参数
类型
必须
说明
start
Int
是
采样的视频时间区间开始时间
end
Int
是
采样的视频时间区间结束时间
重要提示:
若outputWidth为0且outputHeight为0,则输出宽高均取原视频宽高。
若outputWidth为0且outputHeight>0,则保持宽高比,无视keepAspectRatio参数,按照设置的高度值等比例计算宽度。
若outputWidth>0且outputHeight为0,则保持宽高比,无视keepAspectRatio参数,按照设置的宽度值等比例计算高度。
若outputWidth>0且outputHeight>0,且keepAspectRatio为0,则输出宽高按照参数设置;若keepAspectRatio为1,则宽不变,高通过计算得到。
对于format格式为2、3、4的,samplings只允许一组值,表示视频截取开始时间和结束时间,如果有多组值,只取第一组,其余忽略。
5.17.3 输出参数
参数
类型
说明
code
Int
状态码
url
String
截图地址
msg
String
错误信息
5.17.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.17.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32,"format":1,"samplings":[{"start":1,"end":3},{"start":4,"end":6},{"start":8,"end":9},{"start":12,"end":13},{"start":21,"end":23}],"userDefInfo":"userId=123456"}' https://vcloud.163.com/app/vod/video/preview
输出1
"Content-Type": "application/json; charset=utf-8"
{
"requestId" : "e49fdc9a-d59d-480d-b3ef-c91b37f8f664",
"code" : 200,
"ret": {}
}
5.17.6 结果回调
视频预览的生成为异步处理,处理完成回回调给请求参数设置的callbackUrl,如果未设置,回调给默认的转码地址。
生成预览图成功回调内容示例
{
"previewAddr" : "vodk32ywxdf.vod.126.net/vodk32ywxdf/abcsdf.mp4",
"type" : "videoPreview",
“originVid” : 32,
"previewVid" : 1243,
q"user_defined" : "userId=123456"
}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,预览图生成回调固定为“videoPreview”
originVid
Long
原始视频文件视频标识
previewVid
String
生成的预览视频标识
previewAddr
String
生成视频预览访问地址
user_defined
String
用户自定义字段值
生成预览图失败回调内容示例
{
"error" : {
"msg" : "Failed",
"type" : "videoPreview",
"originVid" : 32,
"user_defined" : "userId=123456"
}
}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,预览图生成回调固定为“preview”
originVid
Long
原始视频文件视频标识
msg
String
转码失败原因
user_defined
String
用户自定义字段值
5.18 视频裁剪
5.18.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/video/clip
对视频进行裁剪,针对每个采样区间生成独立的视频。
5.18.2 输入参数
参数
类型
必须
说明
vid
Long
是
视频的标识
format
Int
是
生成的视频预览格式,1表示mp4格式,2表示flv格式
samplings
List
是
采样的视频时间区间列表,包含一组sampling,
区间个数最多10个,单位为秒,可以有重合,区间顺序有意义
callbackUrl
String
否
处理完成后回调的URL地址(需标准http格式),如不设置,使用默认的回调地址
userDefInfo
String
否
用户自定义信息,回调会返回此信息
sampling参数详细说明
参数
类型
必须
说明
start
Int
是
采样的视频时间区间开始时间
end
Int
是
采样的视频时间区间结束时间
cropArea
object
否
采样区间内对画面进行扣取
cropArea参数说明
参数
类型
必须
说明
width
Int
是
扣取画面的宽,例如640,50,此值可表示绝对值也可表示相对值,取决于whType,当whType取值为2时,不允许大于100
height
Int
是
扣取画面的高,例如360,50,此值可表示绝对值也可表示相对值,取决于whType,当whType取值为2时,不允许大于100
whType
Int
是
取值1或者2。1-表示上面的宽高为绝对值,传入为640*360,那么扣取画面的宽高就是640*360;2-表示相对值,表示传入的宽高为相对原视频宽高的百分比。例如传入5050,那么扣取的视频画面宽为src_width\59%,同理高为src_height*50%
x
Int
是
采样画面左上角相对于原视频的左上角的横坐标
y
Int
是
采样画面左上角相对于原视频的左上角的纵坐标
xyType
Int
是
用于表示x,y是绝对值还是百分比,1-绝对值,例如120,120。2-百分比,表示才用原视频宽高的百分比
注:callbackUrl如果不设置,会采用默认的视频裁剪地址回调。 默认视频裁剪地址回调设置接口参考 9.3节 设置回调地址接口
5.18.3 输出参数
参数
类型
说明
requestId
String
请求标识
code
Int
状态码
taskId
Long
任务标识
msg
String
错误信息
注:taskId是媒体处理任务的唯一标识,用户可以通过taskId主动查询任务的执行状态。 详情见 5.20节 任务查询接口
5.18.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.18.5 示例代码
输入1
curl -X POST \
https://vcloud.163.com/app/vod/video/clip \
-H "Content-Type: application/json;charset=utf-8" \
-H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" \
-H "Nonce: 1" \
-H "CurTime: 1465723418" \
-H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" \
-d '{
"vid":32,
"format":1,
"samplings":[
{
"start":1,
"end":3
"cropArea":{
"width":120,
"height":120,
"whType":1,
"x":0,
"y":0,
"xyType":1
}
},
{
"start":4,
"end":6,
"cropArea":{
"width":20,
"height":20,
"whType":2,
"x":0,
"y":0,
"xyType":1
}
},
{
"start":8,
"end":9
},
{
"start":12,
"end":13
},
{
"start":21,
"end":23
}
],
"userDefInfo":"userId=123456"
}'
输出1
"Content-Type": "application/json; charset=utf-8"
{
"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",
"code" : 200,
"ret": {
"taskId": 5
}
}
5.18.6 结果回调
视频裁剪的生成为异步处理,处理完成会回调给请求参数设置的callbackUrl,如果未设置,回调给默认的裁剪地址。
视频裁剪回调内容示例
{
"videoClipJobResult":[
{
"sampling":{
"start":1,
"end":3,
"cropArea":{
"width":120,
"height":120,
"whType":1,
"x":0,
"y":0,
"xyType":1
}
},
"status":"SUCCESS",
"vid":111
},
{
"sampling":{
"start":4,
"end":6,
"cropArea":{
"width":20,
"height":20,
"whType":2,
"x":0,
"y":0,
"xyType":1
}
},
"status":"SUCCESS",
"vid":112
},
{
"sampling":{
"start":8,
"end":9
},
"status":"FAILED",
"msg":"Fail"
}
],
"type":"VIDEO_CLIP",
"originVid":1021,
"user_defined":"userId=123456",
"requestId":"vode49fdc9a-d59d-480d-b3ef-c91b37f8f664"
}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
type
String
回调类型,视频裁剪生成回调固定为“VIDEO_CLIP”
originVid
Long
原始视频文件视频标识
user_defined
String
用户自定义字段值
requestId
String
用户调用视频裁剪接口时返回的请求标识
videoClipJobResult
Json对象
视频裁剪任务结果
videoClipJobResult参数详细说明
参数
类型
说明
sampling
String
采样的视频时间区间
status
String
状态,FAILED 处理失败 SUCCESS 处理成功
vid
Long
采样区间生成的对应视频ID
注意:sampling为实际生成视频的区间,例如设置区间[1, 11] 但是视频实际时长只有10,则返回的区间是[1,10]
5.19 视频合并
5.19.1 接口描述
域名:vcloud.163.com
接口名:POST /app/vod/nts/merge
1.视频合并,来源视频必须是点播库中的视频,参数为vid视频id;
2.仅支持一次性合并20个视频;
3.来源视频的总时长不得超过8小时;
4.因为来源视频的分辨率、bit等都不尽相同,现在默认使用时长最长的视频的分辨率等参数;
5.分辨率等比例缩放时,如果高度为最大时,宽度使用填充黑边,反之高度使用填充黑边(具体可以使用widthCutStyle、heightCutStyle指定);
例如:最大时长的分辨率是1000(宽)800(高),比例是1000/800。 其中一个视频的分辨率是500300,则等比例缩放到1000*800后,高度不够的使用填充黑边;
6.提交后的任务,可以通过回调接口接收回调信息,也可以通过taskId主动查询任务的执行状态。 详情见5.20节 任务查询接口
5.19.2 输入参数
参数
类型
必须
说明
videos
Array
是
待合并的视频列表,参见 MergeVideo 参数说明
widthCutStyle
Int
否
参见 KeepAspectRatioStyle 参数说明, 默认填充黑边
heightCutStyle
Int
否
参见 KeepAspectRatioStyle 参数说明, 默认填充黑边
callbackUrl
String
否
处理完成后回调的URL地址(需标准http格式)
userDefInfo
String
否
用户自定义信息,回调会返回此信息
MergeVideo 参数详细说明
参数
类型
必须
说明
vid
Long
是
视频id
KeepAspectRatioStyle 参数详细说明
参数值
类型
说明
0
Int
填充黑边
1
Int
平均切割
2
Int
如果要切宽的时候只切左边保留右边
3
Int
如果要切宽的时候只切右边保留左边
4
Int
如果要切高的时候只切上边保留下边
5
Int
如果要切高的时候只切下边保留上边
注:callbackUrl如果不设置,会采用默认的视频合并地址回调。 默认视频合并地址回调设置接口参考 9.3节 设置回调地址接口
5.19.3 输出参数
参数
类型
说明
requestId
String
请求标识
code
Int
状态码
taskId
Long
任务标识
msg
String
错误信息
5.19.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.19.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"videos":[{"vid":123}],"widthCutStyle":1,"heightCutStyle":3,"userDefInfo":"job_id:123132"}' https://vcloud.163.com/app/vod/nts/merge
输出1
"Content-Type": "application/json; charset=utf-8"
{
"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",
"code" : 200,
"ret": {
"taskId": 5
}
}
5.19.6 结果回调
视频合并的生成为异步处理,处理完成会回调给请求参数设置的callbackUrl,如果未设置,回调给默认的视频合并地址。
视频裁剪回调内容示例
{
"taskId" : 214123123,
"status": "SUCCESS",
"failMsg": "asdasdasd",
"vid": 1010,
"jobRequestId": "vod213asdd12313asd123123" //任务追踪用
}
注意:请以实际收到的body字段为准,以下仅为body字段示例。
参数
类型
说明
taskId
Long
媒体处理任务标识
status
String
任务状态,SUCCESS表示成功
vid
Long
合并后的视频文件标识
failMsg
String
失败原因
jobRequestId
String
用户调用视频合并接口时返回的请求标识
5.20 任务查询
5.20.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/task/get
通过任务ID查询任务执行状况。仅支持查询最近7天的任务信息。
5.20.2 输入参数
参数
类型
必须
说明
taskId
Long
是
任务标识
5.20.3 输出参数
参数
类型
说明
requestId
String
请求标识
code
Int
状态码
msg
String
错误信息
ret
JSON对象
结果集,JSON对象
ret.task
JSON对象
任务执行状况
input
JSON对象
任务输入
input.vid
Long
任务输入视频标识
result
JSON对象
任务输出结果
result.videoClipJobResult
JSON对象
视频裁剪任务结果,参见videoClipJobResultg参数详细说明
status
String
任务状态: INIT表示提交中,FAILED表示处理失败, PROCESSING表示处理中, SUCCESS表示处理成功
taskId
Long
任务标识
type
String
任务类型: VIDEO_CLIP表示视频裁剪任务, MERGE_VIDEO表示视频合并任务
userDefinedInfo
String
用户自定义信息
failMsg
String
失败原因
createTime
String
任务创建时间 yyyy-MM-dd HH:mm:ss
endTime
String
任务结束时间 yyyy-MM-dd HH:mm:ss
videoClipJobResult参数详细说明
参数
类型
说明
sampling
String
采样的视频时间区间
status
String
状态,FAILED表示处理失败, SUCCESS表示处理成功
vid
Long
采样区间生成的对应视频ID
注意:sampling为实际生成视频的区间,例如设置区间[1, 11] 但是视频实际时长只有10,则返回的区间是[1,10]
5.20.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.20.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"taskId":1}' https://vcloud.163.com/app/vod/task/get
视频裁剪任务查询输出
"Content-Type": "application/json; charset=utf-8"
{
"ret": {
"task": {
"createTime": "2018-11-22 15:32:55",
"endTime": "2018-11-22 15:33:02",
"failMsg": "",
"input": {
"vid": 24
},
"result": {
"videoClipJobResult": [
{
"sampling": {
"start": 1,
"end": 3
},
"status": "SUCCESS",
"vid": 111
},
{
"sampling": {
"start": 4,
"end": 6
},
"status": "SUCCESS",
"vid": 112
},
{
"sampling": {
"start": 8,
"end": 9
},
"status": "FAILED",
"msg": "Fail"
}
]
},
"status": "SUCCESS",
"taskId": 1,
"type": "VIDEO_CLIP",
"userDefinedInfo": ""
}
},
"requestId": "vodc90605aa-24c4-4e17-8b07-0a041a0506d9",
"code": 200
}
视频合并任务查询输出
"Content-Type": "application/json; charset=utf-8"
{
"ret": {
"task": {
"createTime": "2018-12-06 17:51:34",
"endTime": "2018-12-06 17:52:22",
"failMsg": "",
"result": {
"vid": 1
},
"status": "SUCCESS",
"taskId": 1,
"type": "MERGE_VIDEO",
"userDefinedInfo": "auto视频合并"
}
},
"requestId": "vod8867f143-a5b3-4e11-a234-1e2025af61e3",
"code": 200
}
5.21 图片查询接口
查询上传的图片信息
5.21.1 接口描述
用于查询通过上传接口上传的图片和水印文件
域名:vcloud.163.com
接口名:/app/vod/image/list
5.21.2 输入参数
参数
类型
是否必传
说明
currentPage
int
是
当前页,大于等于1
pageSize
int
是
取值[1,1000]
5.21.3 输出参数
ret返回参数
参数
类型
说明
totalRecords
Long
所有图片的数量
pageSize
Int
一页的记录数目
currentPage
Int
当前取得页数
pageNum
Int
总页数
list
JsonObject
返回图片对象
图片对象参数
参数
类型
说明
imageId
long
id
objectKey
string
对象名称
width
int
图片宽
height
int
图片高
5.21.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
724
部分删除操作成功
5.21.5 示例代码
请求示例
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: et4b4r" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":100}' https://vcloud.163.com/app/vod/image/list
返回示例
{
"ret": {
"pageSize": 2,
"totalRecords": 8,
"list": [
{
"imageId": 1,
"objectKey": "key1",
"width":1280,
"height":720
},
{
"imageId": 2,
"objectKey": "key2",
"width":640,
"height":360
}
],
"currentPage": 1,
"pageNum": 4
},
"code": 200
}
5.22 截图查询接口
查询视频的截图信息
5.22.1 接口描述
查询某视频的截图信息
域名:vcloud.163.com
接口名:/app/vod/snapshot/get
5.22.2 输入参数
参数
类型
是否必传
说明
vid
long
是
视频vid
5.22.3 输出参数
ret返回参数
参数
类型
说明
list
JsonObject
截图对象信息
list截图参数
参数
类型
说明
snapshotId
long
id
vid
long
vid
objectKey
string
对象名称
width
int
图片宽
height
int
图片高
5.22.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
5.22.5 示例代码
请求示例
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: ert24" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":100003}' https://vcloud.163.com/app/vod/snapshot/get
返回示例
{
"ret": {
"list": [
{
"snapshotId": 1,
"vid":100003,
"objectKey": "key1",
"width":1280,
"height":720
},
{
"snapshotId": 2,
"vid":100003,
"objectKey": "key2",
"width":640,
"height":360
}
]
},
"code": 200
}
5.23 删除图片或截图
删除上传的图片或者视频截图
5.23.1 接口描述
删除上传的图片,水印或者删除某视频下的所有截图,或者删除某个指定id的截图
域名:vcloud.163.com
接口名:/app/vod/picture/delete
5.23.2 输入参数
参数
类型
是否必填
描述
deleteIdType
string
是
image:表示传入的id为imageId;
video:表示传入的id为vid,此时会删除这个vid下面的所有截图;
snapshot:表示传入的id为snapshotId
ids
long array
是
删除指定id的图片,最多传100个
5.23.3 输出参数
无特殊返回值
参数
类型
说明
code
Int
状态码
msg
String
错误信息
5.23.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
724
部分删除操作成功
5.23.5 示例代码
请求示例
// 删除视频截图
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"video","ids":[10002,10004]}' https://vcloud.163.com/app/vod/picture/delete
// 删除image
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"image","ids":[345]}' https://vcloud.163.com/app/vod/picture/delete
// 删除截图
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"snapshot","ids":[2345,567,8889]}' https://vcloud.163.com/app/vod/picture/delete
返回示例
{
"ret": {},
"code": 200
}
6 数据查询
数据查询模块主要展示流量、带宽、存储统计的查询功能。
6.1 流量统计查询
6.1.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/stats/flow
用于查询点播的流量使用统计数据(查询的开始时间不能超过当前时刻90天,且不能查询当天数据)。
6.1.2 输入参数
参数
类型
必须
说明
startDate
Long
是
需要查询的开始时间戳(单位:毫秒)
endDate
Long
是
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
是
获取流量数据列表分页后的索引
pageSize
Int
是
获取流量数据列表一页的记录数,取值范围:[1,500]
6.1.3 输出参数
参数
类型
说明
code
Int
状态码
totalFlow
Double
查询时段的总流量(单位:GB)
startDate
Long
需要查询的开始时间戳(单位:毫秒)
endDate
Long
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取流量数据的数目
list
List
流量数据列表
list.begintime
Long
起始时间(单位:毫秒)
list.endtime
Long
结束时间(单位:毫秒)
list.flow
Double
流量值(单位:GB)
msg
String
错误信息
6.1.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
6.1.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/flow
输出1
{
"ret" : {
"startDate" : 1490976000000,
"endDate" : 1491062400000,
"totalFlow" : 1234.23,
"type" : 2,
"flowList" : [
{
"begintime" : 1490976000000,
"endtime" : 1491062400000,
"flow" : 123.21
},
...
],
"currentPage" : 1,
"pageSize" : 10,
"pageNum" : 2,
"totalRecords" : 18
},
"code" : 200
}
6.2 带宽统计查询
6.2.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/stats/band
用于查询点播的带宽使用统计数据。
返回的数据粒度根据查询的结束时间戳与开始时间戳之差的大小不同而有所不同:若时间差为0~1天,则按每十分钟一个打点数据返回;若时间差为2~7天,则按每小时一个打点数据返回;若时间差为8~31天,则按每四小时一个打点数据返回;若时间差为32~366天,则按每天一个打点数据返回。另外,查询的开始时间不能超过当前时刻60天,且不能查询当天数据。
6.2.2 输入参数
参数
类型
必须
说明
startDate
Long
是
需要查询的开始时间戳(单位:毫秒)
endDate
Long
是
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
是
获取带宽数据列表分页后的索引
pageSize
Int
是
获取带宽数据列表一页的记录数,取值范围:[1,500]
6.2.3 输出参数
参数
类型
说明
code
Int
状态码
maxBand
Double
查询时段的最大带宽值(单位:Mb/s)
startDate
Long
需要查询的开始时间戳(单位:毫秒)
endDate
Long
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取带宽数据的数目
bandList
List
获取的带宽列表
bandList.begintime
Long
起始时间(单位:毫秒)
bandList.endtime
Long
结束时间(单位:毫秒)
bandList.band
Double
带宽值(单位:Mb/s)
msg
String
错误信息
6.2.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
6.2.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":2,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/band
输出1
{
"ret" : {
"startDate" : 1490976000000,
"endDate" : 1491062400000,
"maxBand" : 1234.23,
"type" : 2,
"bandList" : [
{
"begintime" : 1490976000000,
"endtime" : 1491062400000,
"band" : 123.21
},
...
],
"currentPage" : 1,
"pageSize" : 10,
"pageNum" : 2,
"totalRecords" : 18
},
"code" : 200
}
6.3 存储统计查询
6.3.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/stats/storage
用于查询点播的存储使用统计数据(查询粒度为天,查询的开始时间不能超过当前时刻90天,且不能查询当天数据)。
6.3.2 输入参数
参数
类型
必须
说明
startDate
Long
是
需要查询的开始时间戳(单位:毫秒)
endDate
Long
是
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
是
获取存储数据列表分页后的索引
pageSize
Int
是
获取存储数据列表一页的记录数,取值范围:[1,500]
6.3.3 输出参数
参数
类型
说明
code
Int
状态码
totalStorage
Double
查询时段的总存储量(单位:GB)
startDate
Long
需要查询的开始时间戳(单位:毫秒)
endDate
Long
需要查询的结束时间戳(单位:毫秒)
currentPage
Int
当前取得页数
pageSize
Int
一页的记录数目
pageNum
Int
总页数
totalRecords
Int
获取存储数据的数目
type
Int
统计粒度(2:每天)
storageList
List
获取的存储列表
storageList.begintime
Long
起始时间(单位:毫秒)
storageList.endtime
Long
结束时间(单位:毫秒)
storageList.storage
Double
存储量(单位:GB)
msg
String
错误信息
6.3.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足。
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
6.3.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/storage
输出1
{
"ret" : {
"startDate" : 1490976000000,
"endDate" : 1491062400000,
"totalStorage" : 1234.23,
"type" : 2,
"storageList" : [
{
"begintime" : 1490976000000,
"endtime" : 1491062399999,
"storage" : 123.21
},
...
],
"currentPage" : 1,
"pageSize" : 10,
"pageNum" : 2,
"totalRecords" : 18
},
"code" : 200
}
7 移动端终端用户管理
7.1 概述
网易视频云官网API适用于业务服务器调用,为满足业务服务器的终端用户上传视频以及点播加密等需求,视频云提供了移动端终端用户的管理API,方便企业管理其终端用户使用视频云的服务。
7.2 使用说明
8 视频安全
视频安全模块主要展示有关视频版权保护方面的功能开通、API调用和代码示例。网易云为开发者提供防盗链、回源鉴权、视频内容加密等多种安全机制,保障客户的视频版权不被轻易盗用。
8.1 防盗链
8.1.1 概述
点播防盗链是指在点播视频播放地址中通过添加鉴权字符串的方式,来校验地址合法性的一种防止视频被盗播的方式。开通防盗链功能后,视频播放地址中需要包含一段鉴权字符串,只有合法生成的鉴权串,才可以通过校验从而播放,且该地址有时效性,只在设定的有效期内可播放。这样即使别人获取到已失效的地址,也是无法继续使用的,防止别人盗播视频。如果已经使用有效的地址正在播放,不会因为地址超时失效而受影响。
8.1.2 使用说明
8.2 回源鉴权
8.2.1 概述
回源鉴权是一种保护用户视频内容安全的功能。通过使用回源鉴权功能,用户可实时自行生成视频文件播放链接,该链接在用户指定时间内可用,从而有效保护视频内容。如果在使用回源鉴权功能之前,用户已经发布了播放地址,则在使用回源鉴权功能后,之前的播放地址不可用。用户需要通过动态生成链接以访问视频文件。
8.2.2 两种回源鉴权方式
网易视频云提供了两种回源鉴权方式,二者的区别仅仅在于生成地址的方法不同,其各自生成的播放地址具有完全相同的保护效用,用户可根据自身需要进行选择。
8.3视频加密
8.3.1 概述
视频加密是一种保护视频内容安全的功能。通过将视频的内容进行加密,用户必须使用网易视频云播放SDK才能实现视频的观看,从而有效保护视频内容。
8.3.2 使用说明
9 回调管理
回调是网易云提供的一种异步通知方式,用户可设置回调地址,网易云完成某个特定任务后会将运行结果发送至设置的回调地址,用户可在收到回调后执行相应的业务逻辑。用户可参考3.6节设置上传回调地址,参考4.12节设置转码回调地址。回调管理模块提供了回调地址的查询和删除功能,方便用户查看或删除回调地址。
9.1 回调地址查询
9.1.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/callback/getUrl
用于查询指定类型的回调地址。
9.1.2 输入参数
参数
类型
必须
说明
type
Int
是
回调地址类型:1表示转码回调,2表示上传回调,5表示视频合并回调,6表示视频裁剪回调
9.1.3 输出参数
参数
类型
说明
code
Int
状态码
callbackUrl
String
回调地址
lastUpdateTime
String
最近更新时间(yyyy-MM-dd HH:mm:ss)
msg
String
错误信息
9.1.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
9.1.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"type":1}' https://vcloud.163.com/app/vod/callback/getUrl
输出1
{
"ret": {
"callbackUrl": "http://123456xxxx",
"lastUpdateTime": "2019-01-15 14:01:14"
},
"code": 200
}
9.2 删除回调地址
9.2.1 接口描述
域名:vcloud.163.com
接口名:/app/vod/callback/delUrl
用于删除指定类型的回调地址,调用本接口后,您不会再收到相应类型的回调信息。
9.2.2 输入参数
参数
类型
必须
说明
type
Int
是
回调地址类型:1表示转码回调,2表示上传回调,5表示视频合并回调,6表示视频裁剪回调
9.2.3 输出参数
参数
类型
说明
code
Int
状态码
msg
String
错误信息
9.2.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
711
请求参数非法,具体信息见msg
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
9.2.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"type":1}' https://vcloud.163.com/app/vod/callback/delUrl
输出1
{
"code": 200
}
9.3 设置回调地址
网易视频云点播的回调通知分为单个级别和用户级别,且处理优先级为:单个级别->用户级别->无回调。当用户设置了单个级别的回调地址,使用单个级别的回调地址;否则查询是否设置用户级别的回调地址,如果设置,使用用户级别的回调地址;否则不回调通知。单个级别的回调通知在上传初始化中指定,用户级别的回调通知可通过本接口设置。
回调通知会在请求头中增加sign字段,其值为拼接回调包体内容的字符串和签名字符串,然后对拼接后的字符串进行md5加密(32位小写)。签名字符串可通过本接口设置,默认为:vcloud。
9.3.1 接口描述
域名:vcloud.163.com
接口名:POST /app/vod/callback/setUrl
用于设置指定类型的回调地址。
9.3.2 输入参数
参数
类型
必须
说明
type
Int
是
回调地址类型,1表示转码回调,2表示上传回调,5表示视频合并回调,6表示视频裁剪回调
callbackUrl
String
是
处理完成后回调的URL地址(需标准http格式)
signKey
String
否
媒体处理成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过32位
9.3.3 输出参数
参数
类型
说明
requestId
String
请求标识
code
Int
状态码
msg
String
错误信息
9.3.4 响应状态码
状态码
含义
200
操作成功
400
请求报文格式错误,报文构造不正确或者没有完整发送
700
服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710
权限认证失败,请参考文档中的接口鉴权部分
720
访问失败,余额不足
721
服务未开通,请前往开通页面申请服务开通
722
服务开通审核中,请联系客服人员开通服务
723
请求的次数超过了配额限制
9.3.5 示例代码
输入1
curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"type":1,"callbackUrl":"http://123456xxxx"}' https://vcloud.163.com/app/vod/callback/setUrl
输出1
"Content-Type": "application/json; charset=utf-8"
{
"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",
"code" : 200
}
本篇文档内容是否对您有帮助?
有帮助
我要吐槽
如果遇到产品相关问题,您可 提交工单 或 在线客服 寻求帮助。
您的改进建议
×
问题类型
内容错误
内容没更新
描述不清
链接有误
步骤不完整
内容缺失(缺少代码/示例)
其他
更多建议
请输入您的建议或问题(至少5个字符,至多500个字符)
联系方式
标记内容
同时提交标记内容
提交
此文档对你是否有帮助
×
有帮助
我要吐槽
×
反馈成功
非常感谢您的反馈,我们会继续努力做得更好。