媒资管理 - IM 即时通讯（含 UI）

开发者中心

IM 即时通讯（含 UI）

服务端 API

媒资管理

更新时间： 2022/11/02 06:07:13

音视频管理
音视频分类
图片管理

媒资管理模块主要展示视频图片等文件管理相关的 API 调用和代码示例。包括视频管理、分类管理、截图及封面管理等功能。

存储在点播服务中的文件，在服务期有效期内无过期时间，可无限次播放或下载。服务到期后，所有文件内容均无法访问，但文件等资源会保存 35 天，35 天内续费即可恢复使用。若 35 天后仍未续费，包括文件在内的所有资源将会被销毁。

音视频管理

查询视频文件信息

接口描述

域名：vcloud.163.com

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

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

输入参数

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

输出参数

参数	类型	说明
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	Long	视频所属分类Id
typeName	String	视频所属分类名称
snapshotUrl	String	视频封面截图URL地址
origUrl	String	原始视频的播放地址如果点播域名开启了URL鉴权，该地址为防盗链 URL 地址。请务必关注防盗链 URL 地址的有效期，在有效期到期之前，重新获取新的播放地址。您可以在网易云信控制台上查询并设置URL鉴权的鉴权KEY有效时间。
downloadOrigUrl	String	原始视频的下载地址如果点播域名开启了URL鉴权，该地址为防盗链 URL 地址。请务必关注防盗链的有效期，在有效期到期之前，重新获取新的下载地址。您可以在网易云信控制台上查询并设置URL鉴权的鉴权KEY有效时间。
initialSize	Long	原始视频文件大小（单位：字节）
sdMp4Url	String	流畅Mp4视频格式文件播放地址
downloadSdMp4Url	String	流畅Mp4视频格式文件下载地址
sdMp4Size	Long	流畅Mp4视频格式文件的大小（单位：字节）
sdMp4Width	String	流畅Mp4视频宽度，默认为"0"
sdMp4Height	String	流畅Mp4视频高度，默认为"0"
hdMp4Url	String	标清Mp4视频格式文件播放地址
downloadHdMp4Url	String	标清Mp4视频格式文件下载地址
hdMp4Size	Long	标清Mp4视频格式文件的大小（单位：字节）
hdMp4Width	String	标清Mp4视频宽度，默认为"0"
hdMp4Height	String	标清Mp4视频高度度，默认为"0"
shdMp4Url	String	高清Mp4视频格式文件播放地址
downloadShdMp4Url	String	高清Mp4视频格式文件下载地址
shdMp4Size	Long	高清Mp4视频格式文件的大小（单位：字节）
shdMp4Width	String	高清Mp4视频宽度，默认为"0"
shdMp4Height	String	高清Mp4视频高度，默认为"0"
sdFlvUrl	String	流畅Flv视频格式文件播放地址
downloadSdFlvUrl	String	流畅Flv视频格式文件下载地址
sdFlvSize	Long	流畅Flv视频格式文件的大小（单位：字节）
sdFlvWidth	String	流畅Flv视频宽度，默认为"0"
sdFlvHeight	String	流畅Flv视频高度，默认为"0"
hdFlvUrl	String	标清Flv视频格式文件播放地址
downloadHdFlvUrl	String	标清Flv视频格式文件下载地址
hdFlvSize	Long	标清Flv视频格式文件的大小（单位：字节）
hdFlvWidth	String	标清Flv视频宽度，默认为"0"
hdFlvHeight	String	标清Flv视频高度，默认为"0"
shdFlvUrl	String	高清Flv视频格式文件播放地址
downloadShdFlvUrl	String	高清Flv视频格式文件下载地址
shdFlvSize	Long	高清Flv视频格式文件的大小（单位：字节）
shdFlvWidth	String	高清Flv视频宽度，默认为"0"
shdFlvHeight	String	高清Flv视频高度，默认为"0"
sdHlsUrl	String	流畅Hls视频格式文件播放地址
downloadSdHlsUrl	String	流畅Hls视频格式文件下载地址
sdHlsSize	Long	流畅Hls视频格式文件的大小（单位：字节）
sdHlsWidth	String	流畅Hls视频宽度，默认为"0"
sdHlsHeight	String	流畅Hls视频高度，默认为"0"
hdHlsUrl	String	标清Hls视频格式文件播放地址
downloadHdHlsUrl	String	标清Hls视频格式文件下载地址
hdHlsSize	Long	标清Hls视频格式文件的大小（单位：字节）
hdHlsWidth	String	标清Hls视频宽度，默认为"0"
hdHlsHeight	String	标清Hls视频高度，默认为"0"
shdHlsUrl	String	高清Hls视频格式文件播放地址
downloadShdHlsUrl	String	高清Hls视频格式文件下载地址
shdHlsSize	Long	高清Hls视频格式文件的大小（单位：字节）
shdHlsWidth	String	高清Hls视频宽度，默认为"0"
shdHlsHeight	String	高清Hls视频高度，默认为"0"
createTime	Long	视频上传时间（毫秒时间戳）
updateTime	Long	视频更新时间（毫秒时间戳）
videoExpireTime	Long	视频过期删除时间（时间戳秒）
msg	String	错误信息

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4****c9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a****584e65a2abe7ae13" -d '{"vid":32}' https://vcloud.163.com/app/vod/video/get

返回示例

	{
	  "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=ab1856bb***8e5ee&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=ab1856bb***8e5ee&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=ab1856bb***8e5ee&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=ab1856bb***8e5ee&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=ab1856bb***8e5ee&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
	}

查询视频文件信息列表

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/list

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

输入参数

参数	类型	必须	说明
currentPage	Int	是	获取视频列表分页后的索引
pageSize	Int	是	获取视频列表一页的记录数，取值范围：[1,500]，currentPage * pageSize不能超过500
beginTime	Long	是	需要查询的开始时间戳（单位：毫秒）
endTime	Long	是	需要查询的结束时间戳（单位：毫秒）, 时间跨度小于7天
status	Int	是	根据视频状态过滤选择（0表示获取所有状态视频，10表示初始，20表示失败，30表示处理中，40表示成功，50表示屏蔽，70表示加密中，80表示加密失败）
type	Int	是	根据视频分类过滤选择（0表示获取所有分类视频）
sortStr	String	否	按视频上传时间排序，desc表示按上传时间降序，asc表示按上传时间升序，默认为desc

为避免分页过大，建议您合理选择sortStr。比如，如果您想删除时间久远的视频，可以设置sortStr=asc，再调用删除接口进行删除。

输出参数

参数	类型	说明
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	Long	视频所属分类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	Long	流畅Mp4视频格式文件的大小（单位：字节）
list.hdMp4Url	String	标清Mp4视频格式文件播放地址
list.downloadHdMp4Url	String	标清Mp4视频格式文件下载地址
list.hdMp4Size	Long	标清Mp4视频格式文件的大小（单位：字节）
list.shdMp4Url	String	高清Mp4视频格式文件播放地址
list.downloadShdMp4Url	String	高清Mp4视频格式文件下载地址
list.shdMp4Size	Long	高清Mp4视频格式文件的大小（单位：字节）
list.sdFlvUrl	String	流畅Flv视频格式文件播放地址
list.downloadSdFlvUrl	String	流畅Flv视频格式文件下载地址
list.sdFlvSize	Long	流畅Flv视频格式文件的大小（单位：字节）
list.hdFlvUrl	String	标清Flv视频格式文件播放地址
list.downloadHdFlvUrl	String	标清Flv视频格式文件下载地址
list.hdFlvSize	Long	标清Flv视频格式文件的大小（单位：字节）
list.shdFlvUrl	String	高清Flv视频格式文件播放地址
list.downloadShdFlvUrl	String	高清Flv视频格式文件下载地址
list.shdFlvSize	Long	高清Flv视频格式文件的大小（单位：字节）
list.sdHlsUrl	String	流畅Hls视频格式文件播放地址
list.downloadSdHlsUrl	String	流畅Hls视频格式文件下载地址
list.sdHlsSize	Long	流畅Hls视频格式文件的大小（单位：字节）
list.hdHlsUrl	String	标清Hls视频格式文件播放地址
list.downloadHdHlsUrl	String	标清Hls视频格式文件下载地址
list.hdHlsSize	Long	标清Hls视频格式文件的大小（单位：字节）
list.shdHlsUrl	String	高清Hls视频格式文件播放地址
list.downloadShdHlsUrl	String	高清Hls视频格式文件下载地址
list.shdHlsSize	Long	高清Hls视频格式文件的大小（单位：字节）
list.createTime	Long	视频上传时间（毫秒时间戳）
list.updateTime	Long	视频更新时间（毫秒时间戳）
list.vid	Long	视频Id

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf0****d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a****65a2abe7ae13" -d '{"currentPage":1,"pageSize":2,"status":0,"type":0}' https://vcloud.163.com/app/vod/video/list

返回示例

	{
	  "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=ab1856bb***8e5ee&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=ab1856bb***8e5ee&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
	}

修改视频文件信息

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/edit

用于视频文件信息管理，修改视频文件信息，可修改：视频文件名称、视频分类Id和视频描述信息。

输入参数

参数	类型	必须	说明
vid	Long	是	视频Id
videoName	String	是	视频的名称，长度不超过256
typeId	Long	是	视频分类Id
description	String	否	视频的描述信息，长度不超过256

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05c****5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a****4e65a2abe7ae13" -d '{"vid":20,"videoName":"for_love.mp4","typeId":20,"description":"编辑视频"}' https://vcloud.163.com/app/vod/video/edit

返回示例

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

删除单个转码输出视频

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/delete_single

用于视频管理，删除单个转码输出视频（不允许删除单个源视频）。转码视频文件删除，无法恢复

输入参数

参数	类型	必须	说明
vid	Long	是	视频Id
style	Int	是	视频转码格式（1表示流畅mp4，2表示标清mp4，3表示高清mp4，13表示超清mp4 4表示流畅flv，5表示标清flv，6表示高清flv，14表示超清flv， 7表示流畅hls，8表示标清hls，9表示高清hls，15表示超清hls）

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05c****98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028****e65a2abe7ae13" -d '{"vid":32,"style":3}' https://vcloud.163.com/app/vod/video/delete_single

返回示例

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

删除视频源文件

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/videoDelete

用于视频管理，删除视频文件。原视频、转码视频、视频截图等文件全部删除，无法恢复

输入参数

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

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05****bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028****584e65a2abe7ae13" -d '{"vid":32}' https://vcloud.163.com/app/vod/video/videoDelete

返回示例

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

批量删除视频

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/delete

用于视频管理，批量删除视频文件。原视频、转码视频、视频截图等文件全部删除，无法恢复

输入参数

参数	类型	必须	说明
vids	List	是	多个视频ID组成的列表,最多一次删除50个视频

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a6****bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c510****84e65a2abe7ae13" -d '{"vids":[20]}' https://vcloud.163.com/app/vod/video/delete

返回示例

    "Content-Type": "application/json; charset=utf-8"
    {
    	"code" : 200,
    	"msg" : ""
    }

请求示例2

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4****9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5****584e65a2abe7ae13" -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]
    	}
    }

视频屏蔽

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/videoDisable

用于视频管理，屏蔽视频文件（只有正常状态下的视频才能做屏蔽操作）。

输入参数

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

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a6****6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****2abe7ae13" -d '{"vid":35}' https://vcloud.163.com/app/vod/video/videoDisable

返回示例

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

视频恢复

接口描述

域名：vcloud.163.com

接口名：/app/vod/video/videoRecover

用于视频管理，恢复视频文件（只有被屏蔽的视频才能做恢复操作）。

输入参数

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

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4****f80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5****584e65a2abe7ae13" -d '{"vid":35}' https://vcloud.163.com/app/vod/video/videoRecover

返回示例

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

视频设置过期删除

接口描述

域名：vcloud.163.com

接口名：/app/vod/expire/add

用于视频管理，指定视频在指定时间自动删除。

输入参数

参数	类型	必须	说明
vidSet	List	是	多个视频ID组成的列表,长度限制20个
expireTime	Long	是	视频的绝对过期时间（秒）,大于当前时间；0表示删除视频过期设置

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a****f80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51****65a2abe7ae13" -d '{"vidSet":[20],"expireTime":1630555269}' https://vcloud.163.com/app/vod/expire/add

返回示例

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

音视频分类

创建视频分类

接口描述

域名：vcloud.163.com

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

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

输入参数

参数	类型	必须	说明
typeName	String	是	视频分类的名称，长度不超过128
parentTypeId	Int	否	父分类Id
description	String	否	视频分类的描述信息，长度不超过128

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b****f80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51****5a2abe7ae13" -d'{"typeName":"movie","parentTypeId":0,"description":"电影"}' https://vcloud.163.com/app/vod/type/create

返回示例

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

查询视频分类信息

接口描述

域名：vcloud.163.com

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

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

输入参数

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

输出参数

参数	类型	说明
code	Int	状态码
typeId	Int	视频分类Id
typeName	String	视频分类的名称
parentTypeId	Int	父分类Id
desc	String	视频分类的描述信息
number	Int	该类别下的视频文件数量该参数已废弃，请勿将该参数中返回的数值作为实际视频文件数量。
isDel	Int	是否允许被删除（默认分类不允许删除），1：允许，0：不允许
createTime	Long	视频分类的创建时间（毫秒时间戳）
childNum	Int	子分类数量
msg	String	错误信息

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a****f80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51****65a2abe7ae13" -d '{"typeId":227}' https://vcloud.163.com/app/vod/type/get

返回示例

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

查询视频分类列表信息

接口描述

域名：vcloud.163.com

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

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

输入参数

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

输出参数

参数	类型	说明
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	视频分类的创建时间（单位：毫秒）

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a6****80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51****a2abe7ae13" -d '{"currentPage":1,"pageSize":2}' https://vcloud.163.com/app/vod/type/list

返回示例

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

修改视频分类信息

接口描述

域名：vcloud.163.com

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

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

输入参数

参数	类型	必须	说明
typeId	Int	是	视频分类的Id
typeName	String	是	视频分类的名称，长度不超过128
description	String	否	视频分类的描述信息，长度不超过128

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65****b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5102****e65a2abe7ae13" -d '{"typeId":227, "typeName":"娱乐","description":"更改分类"}' https://vcloud.163.com/app/vod/type/update

返回示例

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

删除视频分类

接口描述

域名：vcloud.163.com

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

删除视频分类。

输入参数

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

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a6****af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51****4e65a2abe7ae13" -d '{"typeId":227}' https://vcloud.163.com/app/vod/type/typeDelete

返回示例

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

设置视频的分类

接口描述

域名：vcloud.163.com

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

设置视频的分类。

输入参数

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

输出参数

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

响应状态码

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

示例代码

请求示例

    curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65****af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c510****e65a2abe7ae13" -d '{"vid":12,"typeId":227}' https://vcloud.163.com/app/vod/type/set

返回示例

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

图片管理

查询上传图片

查询上传的图片信息

接口描述

用于查询通过上传接口上传的图片和水印文件

域名：vcloud.163.com

接口名：/app/vod/image/list

输入参数

参数	类型	是否必传	说明
currentPage	int	是	当前页，大于等于1
pageSize	int	是	取值[1,1000]

输出参数

ret返回参数

参数	类型	说明
totalRecords	Long	所有图片的数量
pageSize	Int	一页的记录数目
currentPage	Int	当前取得页数
pageNum	Int	总页数
list	JsonObject	返回图片对象

图片对象参数

参数	类型	说明
imageId	long	id
objectKey	string	对象名称
url	string	访问地址
width	int	图片宽
height	int	图片高

响应状态码

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

示例代码

请求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: et4b4r" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd8****e65a2abe7ae13" -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
}

查询截图

查询视频的截图信息

接口描述

查询某视频的截图信息

域名：vcloud.163.com

接口名：/app/vod/snapshot/get

输入参数

参数	类型	是否必传	说明
vid	long	是	视频vid

输出参数

ret返回参数

参数	类型	说明
list	JsonObject	截图对象信息

list截图参数

参数	类型	说明
snapshotId	long	id
vid	long	vid
objectKey	string	对象名称
url	string	访问地址
width	int	图片宽
height	int	图片高

响应状态码

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

示例代码

请求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: ert24" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c5***65a2abe7ae13" -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
}

删除图片

删除上传的图片或者视频截图

接口描述

删除上传的图片，水印或者删除某视频下的所有截图，或者删除某个指定id的截图

域名：vcloud.163.com

接口名：/app/vod/picture/delete

输入参数

参数	类型	是否必填	描述
deleteIdType	string	是	image：表示传入的id为imageId； video：表示传入的id为vid，此时会删除这个vid下面的所有截图； snapshot：表示传入的id为snapshotId
ids	long array	是	删除指定id的图片，最多传100个

输出参数

无特殊返回值

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

响应状态码

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

示例代码

请求示例

// 删除视频截图
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
}

在线咨询

微信咨询

电话咨询

此文档是否对你有帮助？

有帮助

去反馈

音视频管理
查询视频文件信息
接口描述
输入参数
输出参数
响应状态码
示例代码
查询视频文件信息列表
接口描述
输入参数
输出参数
响应状态码
示例代码
修改视频文件信息
接口描述
输入参数
输出参数
响应状态码
示例代码
删除单个转码输出视频
接口描述
输入参数
输出参数
响应状态码
示例代码
删除视频源文件
接口描述
输入参数
输出参数
响应状态码
示例代码
批量删除视频
接口描述
输入参数
输出参数
响应状态码
示例代码
视频屏蔽
接口描述
输入参数
输出参数
响应状态码
示例代码
视频恢复
接口描述
输入参数
输出参数
响应状态码
示例代码
视频设置过期删除
接口描述
输入参数
输出参数
响应状态码
示例代码
音视频分类
创建视频分类
接口描述
输入参数
输出参数
响应状态码
示例代码
查询视频分类信息
接口描述
输入参数
输出参数
响应状态码
示例代码
查询视频分类列表信息
接口描述
输入参数
输出参数
响应状态码
示例代码
修改视频分类信息
接口描述
输入参数
输出参数
响应状态码
示例代码
删除视频分类
接口描述
输入参数
输出参数
响应状态码
示例代码
设置视频的分类
接口描述
输入参数
输出参数
响应状态码
示例代码
图片管理
查询上传图片
接口描述
输入参数
输出参数
响应状态码
示例代码
查询截图
接口描述
输入参数
输出参数
响应状态码
示例代码
删除图片
接口描述
输入参数
输出参数
响应状态码
示例代码