点播服务端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 接口鉴权

接口通过请求头中的公共参数进行鉴权。用户通过在用户中心->安全中心获取到的一对安全凭证进行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时,包含的错误信息

重要提示:获取上传加速节点、文件数据上传、断点续传查询断点三个接口除外。

2 视频分类管理

2.1 创建视频分类

2.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/create

用于管理视频文件,增加分类。

2.1.2 输入参数

参数 类型 必须 说明
typeName String 视频分类的名称
description String 视频分类的描述信息

2.1.3 输出参数

参数 类型 说明
code Int 状态码
typeId Int 新生成的视频分类Id
msg String 错误信息

2.1.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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'{"typeName":"movie","description":"电影"}' https://vcloud.163.com/app/vod/type/create

输出1

{
    "ret" : {
        "typeId" : 1
    },
    "code" : 200
}

2.2 获取视频分类

2.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/get

获取单个视频分类信息,包括:Id、分类描述信息、分类数目和分类的创建时间。

2.2.2 输入参数

参数 类型 必须 说明
typeId Int 视频分类的Id

2.2.3 输出参数

参数 类型 说明
code Int 状态码
typeId Int 视频分类Id
typeName String 视频分类的名称
desc String 视频分类的描述信息
number Int 该类别下的视频文件数量
isDel Int 是否允许被删除(默认分类不允许删除),1:允许,0:不允许
createTime Int 视频分类的创建时间(单位:毫秒)
msg String 错误信息

2.2.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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 '{"typeId":227}' https://vcloud.163.com/app/vod/type/get

输出1

{
  "ret": {
    "typeName": "movie",
    "createTime": 1467006327149,
    "isDel": 1,
    "desc": "电影",
    "number": 0,
    "typeId": 227
  },
  "code": 200
}

2.3 获取视频分类列表

2.3.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/list

获取视频分类列表,并做分页返回处理。单个视频的分类信息包括:Id、分类描述信息、分类数目和分类的创建时间。

2.3.2 输入参数

参数 类型 必须 说明
currentPage Int 获取视频分类列表分页后的索引
pageSize Int 获取视频分类列表一页的记录数,取值范围:[1,500]

2.3.3 输出参数

参数 类型 说明
code Int 状态码
currentPage Int 当前取得页数
pageSize Int 一页的记录数目
pageNum Int 总页数
totalRecords Int 获取视频分类列表的分类数目
list List 获取的视频分类列表
list.typeId Int 视频分类Id
list.typeName String 视频分类的名称
list.desc String 视频分类的描述信息
list.number Int 该类别下的视频文件数量
list.isDel Int 是否允许被删除(默认分类不允许删除),1:允许,0:不允许
list.createTime Int 视频分类的创建时间(单位:毫秒)

2.3.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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/type/list

输出1

{
  "ret": {
    "pageSize": 2,
    "totalRecords": 4,
    "list": [
      {
        "typeName": "默认分类",
        "createTime": 1464229521940,
        "isDel": 0,
        "desc": "默认分类",
        "number": 47,
        "typeId": 38
      },
      {
        "typeName": "直播录制",
        "createTime": 1464229521940,
        "isDel": 0,
        "desc": "直播录制",
        "number": 1,
        "typeId": 39
      }
    ],
    "currentPage": 1,
    "pageNum": 2
  },
  "code": 200
}

2.4 修改视频分类

2.4.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/update

用于管理视频文件,修改分类,可修改:分类名称、分类描述信息。

2.4.2 输入参数

参数 类型 必须 说明
typeId Int 视频分类的Id
typeName String 视频分类的名称
description String 视频分类的描述信息

2.4.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

2.4.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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 '{"typeId":227, "typeName":"娱乐","description":"更改分类"}' https://vcloud.163.com/app/vod/type/update

输出1

{
  "ret": {},
  "code": 200
}

2.5 删除视频分类

2.5.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/typeDelete

删除视频分类。

2.5.2 输入参数

参数 类型 必须 说明
typeId Int 视频分类Id

2.5.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

2.5.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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 '{"typeId":227}' https://vcloud.163.com/app/vod/type/typeDelete

输出1

{
  "ret": {},
  "code": 200
}

2.6 设置视频的分类

2.6.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/type/set

设置视频的分类。

2.6.2 输入参数

参数 类型 必须 说明
vid Int 视频Id
typeId Int 视频分类的Id

2.6.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

2.6.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

2.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":12,"typeId":227}' https://vcloud.163.com/app/vod/type/set

输出1

{
  "ret": {},
  "code": 200
}

3 视频转码模板管理

3.1 创建视频转码模板

3.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/preset/create

用于视频文件转码,增加模板。

3.1.2 输入参数

参数 类型 必须 说明
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表示不选择)

3.1.3 输出参数

参数 类型 说明
code Int 状态码
presetId Int 新生成的视频转码模板Id
msg String 错误信息

3.1.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
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'{"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
}

3.2 获取视频转码模板

3.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/preset/get

获取单个视频转码模板信息,包括:Id、视频转码模板名称、视频转码模板对应的格式。

3.2.2 输入参数

参数 类型 必须 说明
presetId Int 视频转码模板Id

3.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表示不包含)
isDel Int 是否允许被删除(默认模板不允许删除),1:允许,0:不允许
msg String 错误信息

3.2.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

3.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
}

3.3 获取视频转码模板列表

3.3.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/preset/list

获取视频转码模板列表,并做分页返回处理。单个视频转码模板的信息包括:Id、视频转码模板名称、视频转码模板对应的格式。

3.3.2 输入参数

参数 类型 必须 说明
currentPage Int 获取视频转码模板列表分页后的索引
pageSize Int 获取视频转码模板列表一页的记录数,取值范围:[1,500]

3.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.isDel Int 是否允许被删除(默认模板不允许删除),1:允许,0:不允许

3.3.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

3.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
}

3.4 修改视频转码模板

3.4.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/preset/update

用于视频文件转码,修改转码模板,可修改:视频转码模板名称、视频转码模板对应的格式。

3.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表示不选择)

3.4.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

3.4.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

3.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
}

3.5 删除视频转码模板

3.5.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/preset/presetDelete

删除视频转码模板。

3.5.2 输入参数

参数 类型 必须 说明
presetId Int 视频转码模板Id

3.5.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

3.5.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
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 '{"presetId":184}' https://vcloud.163.com/app/vod/preset/presetDelete

输出1

{
  "ret": {},
  "code": 200
}

4 视频水印管理

4.1 创建视频水印模板

4.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/watermark/create

用于视频文件管理水印,增加水印模板。

4.1.2 输入参数

参数 类型 必须 说明
watermarkName String 视频水印的名称
imageId Int 视频水印图片的Id
description String 视频水印的描述信息
coordinate String 视频水印左上角的坐标,其值为相对值,比如:
8%_6%表示在视频左上角的偏右8%视频宽度、偏下6%视频高度的位置。
如果不选填,默认设置为5%_5%
scale String 视频水印的长宽,其值为相对值,比如:
10%x15%表示长为视频宽度的10%,宽为视频宽度的15%。
如果不选填,默认设置为不缩放或拉伸

重要提示:不建议设置水印的scale参数,缩放或拉伸水印图片会影响水印图片的效果,可能会出现模糊现象。

4.1.3 输出参数

参数 类型 说明
code Int 状态码
watermarkId Int 视频水印Id
msg String 错误信息

4.1.4 响应状态码

HTTP状态码 含义
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'{"watermarkName":"梅花水印","imageId":1,"description":"梅花水印","coordinate":"8%_6%"}' https://vcloud.163.com/app/vod/watermark/create

输出1

{
  "ret": {
    "watermarkId": 16
  },
  "code": 200
}

4.2 获取视频水印模板

4.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/watermark/get

获取单个视频水印模板信息,包括:Id、视频水印模板名称、视频水印模板对应的配置参数。

4.2.2 输入参数

参数 类型 必须 说明
watermarkId Int 视频水印模板Id

4.2.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.2.4 响应状态码

HTTP状态码 含义
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 '{"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.3 获取视频水印模板列表

4.3.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/watermark/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.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.3.4 响应状态码

HTTP状态码 含义
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/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.4 修改视频水印模板

4.4.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/watermark/update

用于修改水印模板,可修改:视频转码模板名称、视频转码模板对应的格式。

4.4.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.4.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

4.4.4 响应状态码

HTTP状态码 含义
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 '{"watermarkId":6,"watermarkName":"haha","coordinate":"20%_20%"}' https://vcloud.163.com/app/vod/watermark/update

输出1

{
  "ret": {},
  "code": 200
}

4.5 删除视频水印模板

4.5.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/watermark/delete

删除水印模板。

4.5.2 输入参数

参数 类型 必须 说明
watermarkId Int 视频水印模板Id

4.5.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

4.5.4 响应状态码

HTTP状态码 含义
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 '{"watermarkId":6}' https://vcloud.163.com/app/vod/watermark/delete

输出1

{
  "ret": {},
  "code": 200
}

5 视频文件管理

5.1 获取视频文件信息

5.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/video/get

获取单个视频文件信息,包括:Id、视频名称、各个视频格式的播放地址、各个视频格式的下载地址、各个视频格式的视频大小、视频截图地址、视频所属分类Id和名称、视频播放时长、视频转码完成时间。

5.1.2 输入参数

参数 类型 必须 说明
vid Int 视频Id

5.1.3 输出参数

参数 类型 说明
code Int 状态码
videoName String 视频的名称
status Int 视频的状态,10表示初始,20表示失败,30表示处理中,40表示成功,50表示屏蔽
description String 视频的描述信息
completeTime Int 转码完成时间
duration Int 视频播放时长(单位:秒)
durationMsec Int 视频播放时长(单位:毫秒)
width String 视频宽度,默认为"0"
height String 视频高度,默认为"0"
typeId Int 视频所属分类Id
typeName String 视频所属分类名称
snapshotUrl String 视频封面截图URL地址
origUrl String 原始视频的播放地址
downloadOrigUrl String 原始视频的下载地址
initialSize Int 原始视频文件大小(单位:字节)
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 Int 视频上传时间(单位:毫秒)
updateTime Int 视频更新时间(单位:毫秒)
msg String 错误信息

5.1.4 响应状态码

HTTP状态码 含义
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、视频转码模板名称、视频转码模板对应的格式。

5.2.2 输入参数

参数 类型 必须 说明
currentPage Int 获取视频列表分页后的索引
pageSize Int 获取视频列表一页的记录数,取值范围:[1,500]
status Int 根据视频状态过滤选择(0表示获取所有状态视频,10表示初始,20表示失败,30表示处理中,40表示成功,50表示屏蔽)
type Int 根据视频分类过滤选择(0表示获取所有分类视频)

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 Int 转码完成时间
list.duration Int 视频播放时长(单位:秒)
list.durationMsec Int 视频播放时长(单位:毫秒)
list.width String 视频宽度,默认为"0"
list.height String 视频高度,默认为"0"
list.typeId Int 视频所属分类Id
list.typeName String 视频所属分类名称
list.snapshotUrl String 视频封面截图URL地址
list.origUrl String 原始视频的播放地址
list.downloadOrigUrl String 原始视频的下载地址
list.initialSize Int 原始视频文件大小(单位:字节)
list.sdMp4Url String 标清Mp4视频格式文件播放地址
list.downloadSdMp4Url String 标清Mp4视频格式文件下载地址
list.sdMp4Size Int 标清Mp4视频格式文件的大小(单位:字节)
list.sdMp4Width String 标清Mp4视频宽度,默认为"0"
list.sdMp4Height String 标清Mp4视频高度,默认为"0"
list.hdMp4Url String 高清Mp4视频格式文件播放地址
list.downloadHdMp4Url String 高清Mp4视频格式文件下载地址
list.hdMp4Size Int 高清Mp4视频格式文件的大小(单位:字节)
list.hdMp4Width String 高清Mp4视频宽度,默认为"0"
list.hdMp4Height String 高清Mp4视频高度,默认为"0"
list.shdMp4Url String 超清Mp4视频格式文件播放地址
list.downloadShdMp4Url String 超清Mp4视频格式文件下载地址
list.shdMp4Size Int 超清Mp4视频格式文件的大小(单位:字节)
list.shdMp4Width String 超清Mp4视频宽度,默认为"0"
list.shdMp4Height String 超清Mp4视频高度,默认为"0"
list.sdFlvUrl String 标清Flv视频格式文件播放地址
list.downloadSdFlvUrl String 标清Flv视频格式文件下载地址
list.sdFlvSize Int 标清Flv视频格式文件的大小(单位:字节)
list.sdFlvWidth String 标清Flv视频宽度,默认为"0"
list.sdFlvHeight String 标清Flv视频高度,默认为"0"
list.hdFlvUrl String 高清Flv视频格式文件播放地址
list.downloadHdFlvUrl String 高清Flv视频格式文件下载地址
list.hdFlvSize Int 高清Flv视频格式文件的大小(单位:字节)
list.hdFlvWidth String 高清Flv视频宽度,默认为"0"
list.hdFlvHeight String 高清Flv视频高度,默认为"0"
list.shdFlvUrl String 超清Flv视频格式文件播放地址
list.downloadShdFlvUrl String 超清Flv视频格式文件下载地址
list.shdFlvSize Int 超清Flv视频格式文件的大小(单位:字节)
list.shdFlvWidth String 超清Flv视频宽度,默认为"0"
list.shdFlvHeight String 超清Flv视频高度,默认为"0"
list.sdHlsUrl String 标清Hls视频格式文件播放地址
list.downloadSdHlsUrl String 标清Hls视频格式文件下载地址
list.sdHlsSize Int 标清Hls视频格式文件的大小(单位:字节)
list.sdHlsWidth String 标清Hls视频宽度,默认为"0"
list.sdHlsHeight String 标清Hls视频高度,默认为"0"
list.hdHlsUrl String 高清Hls视频格式文件播放地址
list.downloadHdHlsUrl String 高清Hls视频格式文件下载地址
list.hdHlsSize Int 高清Hls视频格式文件的大小(单位:字节)
list.hdHlsWidth String 高清Hls视频宽度,默认为"0"
list.hdHlsHeight String 高清Hls视频高度,默认为"0"
list.shdHlsUrl String 超清Hls视频格式文件播放地址
list.downloadShdHlsUrl String 超清Hls视频格式文件下载地址
list.shdHlsSize Int 超清Hls视频格式文件的大小(单位:字节)
list.shdHlsWidth String 超清Hls视频宽度,默认为"0"
list.shdHlsHeight String 超清Hls视频高度,默认为"0"
list.createTime Int 视频上传时间(单位:毫秒)
list.updateTime Int 视频更新时间(单位:毫秒)

5.2.4 响应状态码

HTTP状态码 含义
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 Int 视频Id
videoName String 视频的名称
typeId Int 视频分类Id
description String 视频的描述信息

5.3.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

5.3.4 响应状态码

HTTP状态码 含义
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 Int 视频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 响应状态码

HTTP状态码 含义
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 Int 视频Id

5.5.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

5.5.4 响应状态码

HTTP状态码 含义
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 Int 视频Id

5.6.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

5.6.4 响应状态码

HTTP状态码 含义
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 Int 视频Id

5.7.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

5.7.4 响应状态码

HTTP状态码 含义
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组成的列表

5.8.3 输出参数

参数 类型 说明
code Int 错误码
msg String 错误信息

5.8.4 响应状态码

HTTP状态码 含义
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状态表

6 文件上传

6.1 文件上传初始化

6.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/upload/init

用于文件上传的初始化,获取xNosToken(上传凭证)、bucket(存储对象的桶名)、object(生成的唯一对象名)。

6.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 用户自定义信息,回调会返回此信息

6.1.3 输出参数

参数 类型 说明
code Int 状态码
xNosToken String 上传凭证
bucket String 存储上传文件的桶名
object String 存储上传文件的对象名
msg String 错误信息

6.1.4 响应状态码

HTTP状态码 含义
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'{"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"
    }
}

6.2 获取上传加速节点地址

6.2.1 接口描述

域名:http://wanproxy.127.net

接口名:/lbs?version=1.0&bucketname={bucket}

用于获取上传加速节点地址。

6.2.2 输入参数

参数 类型 必须 说明
version String API版本号,填写固定值1.0
bucketname String 存储上传文件的桶名,可在视频上传初始化接口的返回参数bucket获取

6.2.3 输出参数

参数 类型 说明
lbs String httpDNS的IP访问地址,用于避免后续查询的DNS解析时间、以及域名劫持
upload List 上传节点列表(前面的优先级高)

6.2.4 错误响应

参数 类型 说明
Code String 错误代码
Message String 错误描述信息

6.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"]}

6.3 文件数据上传

上传一块数据,此接口通过指定offset实现断点续传功能。用户每次上传要以服务器端返回的offset为准续传余下数据。

需注意以下事项:

6.3.1 接口描述

POST {UploadHost}/{bucket}/{object}

重要提示:{UploadHost}值为获取的上传加速节点地址,{bucket}值为存储对象的桶名,{object}值为生成的唯一对象名。

6.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

6.3.3 响应参数

参数 类型 必须 说明
requestId String uuid字符串,服务器端生成的唯一UUID
offset long 下一个上传片在上传块中的偏移。
注意:偏移从0开始,比如:用户上传0-128字节后,
服务器返回的offset为128,下一次上传offset值应置为128
context String 上传上下文
callbackRetMsg String 上传回调信息

6.3.4 错误响应

参数 类型 说明
requestId String uuid字符串,服务器端生成的唯一UUID
errMsg String 错误描述信息

6.3.5 响应状态码

HTTP状态码 含义
200 上传分片成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
403 上传凭证无效。token过期服务器会返回此状态码,用户需要重新申请token
500 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
520 回调失败

6.3.6 示例

输入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":""
}

6.4 断点续传查询断点

根据上传上下文查询对应分片上传当前续传的offset,上下文要与bucketName/objectName匹配,否则返回400状态码。(bucketName和objectName要进行URL编码,字符编码格式使用utf-8)。

6.4.1 接口描述

GET {UploadHost}/{bucket}/{object}?uploadContext

重要提示:{UploadHost}值为获取的上传加速节点地址,{bucket}值为存储对象的桶名,{object}值为生成的唯一对象名。

6.4.2 请求参数

参数 类型 必须 说明
x-nos-token String 上传token
bucketName String 存储对象的桶名
objectName String 生成的唯一对象名
context String 上传上下文。本字段是只能被上传服务器解读使用的不透明字段,
上传端不应修改其内容。对应context在服务端不存在则返回404。
context对应的桶名或者对象名不匹配返回400 code。
version String http api版本号。这里是固定值1.0

6.4.3 响应参数

参数 类型 必须 说明
requestId String uuid字符串,服务器端生成的唯一UUID,用于记录日志排查问题使用
offset long 下一个上传片在上传块中的偏移

6.4.4 错误响应

参数 类型 说明
requestId String uuid字符串,服务器端生成的唯一UUID
errMsg String 错误描述信息

6.4.5 响应状态码

HTTP状态码 含义
200 上传分片成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
403 上传凭证无效。token过期服务器会返回此错误码,用户需要重新申请token
500 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
404 对应context上传不存在

6.4.6 示例

输入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
}

6.5 上传完成根据对象名查询视频或水印图片主Id

6.5.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/video/query

用于视频或水印上传完成后查询主Id。

6.5.2 输入参数

参数 类型 必须 说明
objectNames List 上传文件的对象名列表

6.5.3 输出参数

参数 类型 说明
code Int 状态码
list List 对象名和视频Id对应的列表
list.vid Int 视频主Id
list.imgId Int 视频水印图片Id
list.objectName String 存储上传文件的对象名
msg String 错误信息

6.5.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

6.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
            }
        ]
    }
}

7 视频截图

7.1 获取视频截图地址

7.1.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。如有不支持格式视频,请进行转码,接口会根据转码后的视频截取图片。

截取图片比例如果和视频尺寸比例不相符合,会自动填充黑边,保证图片显示正常。

7.1.2 输入参数

参数 类型 必须 说明
vid Int 视频Id
size Int 截图尺寸,包含以下几种值:
0表示原始视频比例,1表示640360,2表示400300,3表示320180,
4表示200
150,5表示1280720,6表示960720,7表示360640,
8表示300
400,9表示180320,10表示150200,11表示7201280,
12表示720
960,13表示180180,14表示360360,15表示720*720
offset Int 截图偏移,包含以下几种值:
0表示视频第一秒,1表示时间轴10%位置,2表示时间轴20%位置,
3表示时间轴30%位置,4表示时间轴40%位置,5表示时间轴50%位置,
6表示时间轴60%位置,7表示时间轴70%位置,8表示时间轴80%位置,
9表示时间轴90%位置

7.1.3 输出参数

参数 类型 说明
code Int 状态码
url String 截图地址
width String 截图宽度
height String 截图高度
msg String 错误信息

7.1.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

7.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":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
}

7.2 设置视频封面

7.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/snapshot/set

为视频设置显示封面。

7.2.2 输入参数

参数 类型 必须 说明
vid Int 视频Id
type Int 封面设置方法:1表示使用截图URL,2表示使用本地上传图片
path String type值为1,则代表截图URL;type值为2,则代表本地图片路径
data String type值为2时,需填写,代表本地图片数据的base64编码字符串数据

重要提示:使用截图URL设置视频封面的URL必需是存储在网易云视频点播服务的URL,暂不支持第三方URL。

7.2.3 输出参数

参数 类型 说明
code Int 状态码
url String 截图地址
msg String 错误信息

7.2.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

7.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 '{"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
}

8 视频转码

8.1 视频文件转码

8.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/transcode/resetmulti

用于视频转码,批量进行视频转码(只有处于正常或失败的视频才允许执行此操作)。

8.1.2 输入参数

参数 类型 必须 说明
vids List 多个视频Id组成的列表
presetId Int 转码模板Id
watermarkId Int 视频水印Id(不填写为不添加水印,且若填写,presetId值不能为默认模板)
userDefInfo String 用户自定义信息,回调会返回此信息

8.1.3 输出参数

参数 类型 说明
code Int 状态码
successCount Int 转码成功的数量
failCount Int 转码失败的数量
passCount Int 转码忽略的数量,即已经存在该转码格式视频
msg String 错误信息

8.1.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

8.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 '{"vids":[29,30],"presetId":174,"watermarkId":23}' https://vcloud.163.com/app/vod/transcode/resetmulti

输出1

{
  "ret": {
    "passCount": 0,
    "failCount": 0,
    "successCount": 2
  },
  "code": 200
}

9 回调通知

9.1 说明

网易云视频点播的回调通知分为单个级别和用户级别,且处理优先级为:单个级别->用户级别->无回调。当用户设置了单个级别的回调地址,使用单个级别的回调地址;否则查询是否设置用户级别的回调地址,如果设置,使用用户级别的回调地址;否则不回调通知。单个级别的回调通知在上传初始化中指定,用户级别的回调通知可通过9.2和9.3设置。

回调通知会在请求头中增加sign字段,其值为拼接回调包体内容的字符串和签名字符串,然后对拼接后的字符串进行md5加密(32位小写)。签名字符串可通过接口9.2和9.3设置,默认为:vcloud。

目前网易云视频点播支持的回调通知包含上传成功和转码结果。

9.2 设置上传回调地址

9.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/upload/setcallback

用于视频上传,设置上传成功后的回调地址。

9.2.2 输入参数

参数 类型 必须 说明
callbackUrl String 上传成功后回调客户端的URL地址
signKey String 上传成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过32位

9.2.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

9.2.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
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 '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/upload/setcallback

输出1

{
    "msg" : "",
    "code" : 200
}

:上传完成后回调给客户地址为POST请求,包体为json格式数据,类似:{"name":"snow.mp4","origAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/b3d259f4-a7bc-4119-ae24-60e0eb09216e.mp4","type":"upload","vid":1022,"user_defined":"userId=123456"}

9.3 设置转码回调地址

9.3.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/transcode/setcallback

用于视频转码,设置转码成功后的回调地址。

9.3.2 输入参数

参数 类型 必须 说明
callbackUrl String 转码成功后回调客户端的URL地址
signKey String 转码成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过32位

9.3.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

9.3.4 响应状态码

HTTP状态码 含义
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 '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/transcode/setcallback

输出1

{
    "msg" : "",
    "code" : 200
}

:转码完成后回调给客户地址为POST请求,包体为json格式数据,类似:{"sdFlvAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/flv/rDM5V7HM_1021_sd.flv","name":"snow.mp4","type":"transcode","vid":1021,"user_defined":"userId=123456"}

10 数据查询

10.1 流量统计查询

10.1.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/stats/flow

用于查询点播的流量使用统计数据。

10.1.2 输入参数

参数 类型 必须 说明
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 获取流量数据列表分页后的索引
pageSize Int 获取流量数据列表一页的记录数,取值范围:[1,500]

10.1.3 输出参数

参数 类型 说明
code Int 状态码
totalFlow Double 查询时段的总流量(单位:MB)
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 当前取得页数
pageSize Int 一页的记录数目
pageNum Int 总页数
totalRecords Int 获取流量数据的数目
list List 流量数据列表
list.begintime Int 起始时间(单位:毫秒)
list.endtime Int 结束时间(单位:毫秒)
list.flow Double 流量值(单位:MB)
msg String 错误信息

10.1.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

10.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":1459478685000,"endDate":1459478685000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/flow

输出1

{
    "ret" : {
        "startDate" : 1459478685000,
        "endDate" : 1459478685000,
        "totalFlow" : 1234.23,
        "type" : 2,
        "flowList" : [
            {
                "begintime" : 1459478685000,
                "endtime" : 1459478685,
                "flow" : 123.21
            },
            ...
        ],
        "currentPage" : 1,
        "pageSize" : 10,
        "pageNum" : 2,
        "totalRecords" : 18
    },
    "code" : 200
}

10.2 带宽统计查询

10.2.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/stats/band

用于查询点播的带宽使用统计数据(统计粒度(1:每小时(2~7天);2:每天(32~366天);3:每十分钟(0~1天),4:每四小时(8~31天)))。

10.2.2 输入参数

参数 类型 必须 说明
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 获取带宽数据列表分页后的索引
pageSize Int 获取带宽数据列表一页的记录数,取值范围:[1,500]

10.2.3 输出参数

参数 类型 说明
code Int 状态码
maxBand Double 查询时段的最大带宽值(单位:Mb/s)
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 当前取得页数
pageSize Int 一页的记录数目
pageNum Int 总页数
totalRecords Int 获取带宽数据的数目
bandList List 获取的带宽列表
bandList.begintime Int 起始时间(单位:毫秒)
bandList.endtime Int 结束时间(单位:毫秒)
bandList.band Double 带宽值(单位:Mb/s)
msg String 错误信息

10.2.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

10.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":1459478685000,"endDate":1459478685000,"type":2,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/band

输出1

{
    "ret" : {
        "startDate" : 1459478685000,
        "endDate" : 1459478685000,
        "maxBand" : 1234.23,
        "type" : 2,
        "bandList" : [
            {
                "begintime" : 1459478685000,
                "endtime" : 1459478685,
                "band" : 123.21
            },
            ...
        ],
        "currentPage" : 1,
        "pageSize" : 10,
        "pageNum" : 2,
        "totalRecords" : 18
    },
    "code" : 200
}

10.3 存储统计查询

10.3.1 接口描述

域名:vcloud.163.com

接口名:/app/vod/stats/storage

用于查询点播的存储使用统计数据(查询粒度为天)。

10.3.2 输入参数

参数 类型 必须 说明
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 获取存储数据列表分页后的索引
pageSize Int 获取存储数据列表一页的记录数,取值范围:[1,500]

10.3.3 输出参数

参数 类型 说明
code Int 状态码
totalStorage Double 查询时段的总存储量(单位:GB)
startDate Int 需要查询的开始时间戳(单位:毫秒)
endDate Int 需要查询的结束时间戳(单位:毫秒)
currentPage Int 当前取得页数
pageSize Int 一页的记录数目
pageNum Int 总页数
totalRecords Int 获取存储数据的数目
type Int 统计粒度(2:每天)
storageList List 获取的存储列表
storageList.begintime Int 起始时间(单位:毫秒)
storageList.endtime Int 结束时间(单位:毫秒)
storageList.storage Double 存储量(单位:GB)
msg String 错误信息

10.3.4 响应状态码

HTTP状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足。
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

10.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":1459478685000,"endDate":1459478685000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/flow

输出1

{
    "ret" : {
        "startDate" : 1459478685000,
        "endDate" : 1459478685000,
        "totalStorage" : 1234.23,
        "type" : 2,
        "storageList" : [
            {
                "begintime" : 1459478685000,
                "endtime" : 1459478685,
                "storage" : 123.21
            },
            ...
        ],
        "currentPage" : 1,
        "pageSize" : 10,
        "pageNum" : 2,
        "totalRecords" : 18
    },
    "code" : 200
}

11 回源鉴权

11.1 概述

回源鉴权是一种保护用户视频内容安全的功能。通过使用回源鉴权功能,用户可实时自行生成视频文件播放链接,该链接在用户指定时间内可用,从而有效保护视频内容。如果在使用回源鉴权功能之前,用户已经发布了播放地址。则在使用回源鉴权功能后,之前的播放地址不可用。用户需要通过动态生成链接以访问视频文件。

11.2 使用说明

点播回源鉴权使用说明

12 点播终端用户说明

12.1 概述

移动端上传适用于 andriod 端和 ios 端,其使用方式是终端直接上传视频,上传完成后回调业务服务器,由业务服务器通知终端上传成功。

12.2 使用说明

点播终端用户说明

13 视频加密

13.1 概述

视频加密是一种保护视频内容安全的功能。通过将视频的内容进行加密,用户必须使用网易云视频播放SDK才能实现视频的观看,从而有效保护视频内容。

:目前,仅支持flv视频类型进行加密。

13.2 使用说明

视频加密使用说明