ONAIR视频云
点播API接口调用规范
版本号：V2.0.3
北京阳光云视科技有限公司
2019年1月
目 录
第1章 接口定义说明 ............................................................................................ 1 1.1 概述 ......................................................................................................................................... 1 1.2 请求结构说明 ........................................................................................................................ 1
请求地址 .............................................................................................................................. 1 公共参数 .............................................................................................................................. 1 地址示例 .............................................................................................................................. 1 1.3 返回结果 ................................................................................................................................. 2 第2章 文件上传接口 ............................................................................................ 3 2.1 获取视频文件上传令牌 ........................................................................................................ 3
功能描述 .............................................................................................................................. 3 请求参数 .............................................................................................................................. 3 返回参数 .............................................................................................................................. 3 调用示例 .............................................................................................................................. 4 2.2 视频上传完成回调 ................................................................................................................ 4
功能描述 .............................................................................................................................. 4 视频上传完成回调请求参数 ............................................................................................ 4 视频处理完成回调请求参数 ............................................................................................ 5 2.3 获取图片文件上传令牌 ........................................................................................................ 8
功能描述 .............................................................................................................................. 8 请求参数 .............................................................................................................................. 8 返回参数 .............................................................................................................................. 8 调用示例 .............................................................................................................................. 8 2.4 图片上传完成回调 ................................................................................................................ 9
功能描述 .............................................................................................................................. 9 图片上传完成后回调请求参数 ........................................................................................ 9 2.5 获取已上传视频文件大小 ................................................................................................. 10
功能描述 ............................................................................................................................ 10 请求参数 ............................................................................................................................ 10 返回参数 ............................................................................................................................ 10 调用示例 ............................................................................................................................ 10 2.6 文件上传 ............................................................................................................................... 10
功能描述 ............................................................................................................................ 10
I
请求参数 ............................................................................................................................ 11 返回参数 ............................................................................................................................ 11 调用示例 ............................................................................................................................ 11 2.7 文件注册 ............................................................................................................................... 12
功能描述 ............................................................................................................................ 12 请求参数 ............................................................................................................................ 13 返回参数 ............................................................................................................................ 13 调用示例 ............................................................................................................................ 13 2.8 直播内容接入 ...................................................................................................................... 13
功能描述 ............................................................................................................................ 13 请求参数 ............................................................................................................................ 14 返回参数 ............................................................................................................................ 14 调用示例 ............................................................................................................................ 14 第3章 视频管理接口 .......................................................................................... 15 3.1 获取视频信息 ...................................................................................................................... 15
功能描述 ............................................................................................................................ 15 请求参数 ............................................................................................................................ 15 返回参数 ............................................................................................................................ 15 调用示例 ............................................................................................................................ 15 3.2 修改视频信息 ...................................................................................................................... 18
功能描述 ............................................................................................................................ 18 请求参数 ............................................................................................................................ 18 返回参数 ............................................................................................................................ 18 调用示例 ............................................................................................................................ 18 3.3 获取视频信息列表 .............................................................................................................. 20
功能描述 ............................................................................................................................ 20 请求参数 ............................................................................................................................ 21 返回参数 ............................................................................................................................ 21 调用示例 ............................................................................................................................ 21 3.4 获取源文件地址 .................................................................................................................. 24
功能描述 ............................................................................................................................ 24 请求参数 ............................................................................................................................ 24 返回参数 ............................................................................................................................ 24 调用示例 ............................................................................................................................ 24
II
3.5 删除视频文件 ...................................................................................................................... 25
功能描述 ............................................................................................................................ 25 请求参数 ............................................................................................................................ 25 返回参数 ............................................................................................................................ 25 调用示例 ............................................................................................................................ 25 第4章 全局设置接口 .......................................................................................... 26 4.1 转码设置 ............................................................................................................................... 26
新增转码组 ........................................................................................................................ 26 更新转码组 ........................................................................................................................ 27 查询转码组列表 ............................................................................................................... 28 查询转码组 ........................................................................................................................ 30 删除转码组 ........................................................................................................................ 31 设置默认转码组 ............................................................................................................... 32 查询转码模板 ................................................................................................................... 32 4.2 审核设置 ............................................................................................................................... 33
新增审核模板 ................................................................................................................... 34 更新审核模板 ................................................................................................................... 35 查询审核模板列表 ........................................................................................................... 36 查询模板详情 ................................................................................................................... 38 删除审核模板 ................................................................................................................... 39 4.3 水印设置 ............................................................................................................................... 39
新增水印模板 ................................................................................................................... 39 更新水印模板 ................................................................................................................... 40 查询水印详情 ................................................................................................................... 41 查询水印列表 ................................................................................................................... 42 删除水印模板 ................................................................................................................... 43 4.4 截图设置 ............................................................................................................................... 44
新增截图模板 ................................................................................................................... 44 更新截图模板 ................................................................................................................... 45 查询截图详情 ................................................................................................................... 46 查询模板列表 ................................................................................................................... 47 删除截图模板 ................................................................................................................... 48 4.5 视频分类设置 ...................................................................................................................... 49
新增分类 ............................................................................................................................ 49
III
修改分类 ............................................................................................................................ 50 删除分类 ............................................................................................................................ 50 获取分类及其子分类 ....................................................................................................... 51 4.6 回调设置 ............................................................................................................................... 53
设置回调地址 ................................................................................................................... 53 第5章 附录 ........................................................................................................ 55 5.1 数据类型 ............................................................................................................................... 55
TemplateGroup ............................................................................................................... 55 TranscodeTemplate ....................................................................................................... 55 WaterMarkTemplate ..................................................................................................... 55 CensoredTemplate ........................................................................................................ 56 SnapshotTemplate ......................................................................................................... 56 Category ........................................................................................................................... 57 TranscodeInfo ................................................................................................................. 57 TranscodeFile .................................................................................................................. 57 SnapshotInfo ................................................................................................................... 57 SnapshotFile ................................................................................................................. 57 AuditInfo ........................................................................................................................ 58 AuditResult .................................................................................................................... 58 AuditPoint ...................................................................................................................... 58 AuditLabel ..................................................................................................................... 58 MediaFile ........................................................................................................................ 59 MediaInfo ...................................................................................................................... 59 MediaInfoGeneral ....................................................................................................... 59 MediaInfoVideo ........................................................................................................... 59 MediaInfoAudio ........................................................................................................... 60 MediaInfoPic ................................................................................................................. 60 FileInfo ............................................................................................................................ 60 MaterialFile .................................................................................................................... 60 TextWaterMark ............................................................................................................. 61 CallbackConfig ............................................................................................................. 61 5.2 参数详情 ............................................................................................................................... 61
转码模板配置详情 ........................................................................................................... 61 水印模版配置详情 ........................................................................................................... 61
IV
水印Timeline详情 ......................................................................................................... 62 截图SnapshotConfig 详情 ......................................................................................... 62 文字水印TextWaterMark参数详情 ........................................................................... 63 waterMarkTemplates详情 ........................................................................................... 63 5.3 FONTCOLOR列表 .................................................................................................................. 63 第6章 预置转码模板： ....................................................................................... 67 第7章 附录： ..................................................................................................... 69
V
视频云点播API接口调用规范
第1章 接口定义说明
1.1 概述
欢迎使用视频云点播服务。用户可以使用本文档介绍的 API规范，完成点播相关接口的对接工作。为了加强接口调用的安全和可控性，需要遵循API网关的验证规范。 服务接口调用统一采用标准的RESTFul风格的API形式，支持 HTTP GET 请求，请求参数需要包含在请求的 URL 中，同时支持HTTP POST 请求， 请求参数需要以表单形式提交。
调用服务端统一 HTTP(S) 协议的请求，为了获得更高的安全性，推荐您使用HTTPS 通道发送请求。根据请求的处理情况，系统响应数据格式统一为JSON数据格式。
1.2 请求结构说明
请求地址
服务调用接口地址规则：
https://[域名]/[接口地址]?[公共参数]
访问地址由三部分组成：
域 名：接口服务部署后提供访问域名。
接口地址：接口服务根据实现功能的不同提供相应的地址。 公共参数：公共请求参数是指每一个接口都需要使用到的参数。
注：非必填项的值可以不传，所有请求参数区分大小写，命名遵循驼峰命名规则。请求及返回结果都使用 UTF-8 字符集进行编码，请求参数需要先进行urlEncode编码 示例：URLEncoder.encode(value, ”UTF-8“).replace(\"+\\"%20\").replace(\"*\\"%2A\").replace(\"%7E\。 时间示例：
编码前：2018-03-05 21:07:49 编码后：2018-03-05%2b21%253a07%253a49
公共参数
属性 version 含义 版本号 类型 String 说明 目前固定填写“V1” 必填 是 地址示例
https:// dbapi.apistore.huaweicloud.com/api/log/v1/getLogs?version=V1 [ 第一部分 ][ 第二部分 ]
1
视频云点播API接口调用规范
第一部分是具体接口服务的接口地址，由接口服务根据一定规则（按照不同功能进行命名上的区分）自定义，第二部分为公共参数，在调用每个接口时均需填入该部分。
1.3 返回结果
{ \"code\": 0, #状态码,参照附录 \"message\": \"success\ #描述信息 \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\" } #结果数据 }
2
视频云点播服务接口调用规范
第2章 文件上传接口
2.1 获取视频文件上传令牌
功能描述
根据用户提供的视频名称、视频大小（字节数），获取素材断点续传的上传令牌。
请求参数
名称 materialName 类型 String 说明 视频名称，需要包含后缀名（会作为文件上传完成之后的后缀名），长度不超过128个字节； 后缀名支持：*.avi; *.dv; *.flv; *.mp4; *.swf; *.mxf; *.rm; *.m4v; *.ts; *.3gp; *.hls; *.m3u8; *.ogg；*.vob；*.3g2；*.webm，... ; materialLength title description cateId coverURL templateGroupId Long String String String String String 视频大小，单位：字节 视频标题，长度不超过128个字节，不填默认为视频名称 视频描述，长度不超过512个字节，不填写默认为空 视频分类ID，不填写默认为空 自定义视频封面URL地址，不填写默认为空 转码模板组ID，不填写时会选用默认模板组ID进行转码处理 注: 系统自带两个模板组（不转码即分发模板组和系统标清模板组），默认使用系统标清模板组进行标准转码 snapshotId censoredId tags String String String 截图模板ID，不填写时不进行截图 审核模板组ID，支持鉴黄、涉政、暴恐识别，当为空时不进行视频审核服务 视频标签 单个标签不超过32字节。 多个用逗号分隔。 最多不超过16个标签。 标签内容需使用UTF8进行编码。 否 否 否 否 否 否 否 是 否 必填 是 返回参数
参数
类型 说明 视频云点播API接口调用规范
uploadDomain uploadToken requestId String String String 获取文件大小及文件上传服务对应接口的URI (如: http://vodupload.yunshicloud.com) 上传令牌 请求ID 调用示例 请求示例：
http(s)://[域名]/token/createUploadFileToken?version=V1&materialName=测试视频.mp4&materialLength=52113140 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"uploadToken\": \"1630DDC50D23445BBA7B914E9756CF64\ \"uploadDomain\": \"http://vodupload.yunshicloud.com\ \"requestId\": \"x-request-xiaodai-test\" } } 2.2 视频上传完成回调
功能描述
当在回调配置里配置了回调地址且置为开启状态后系统在视频上传完成和视频处理完成后会主动回调。
视频上传完成回调请求参数
名称 FILE_TYPE ACTION RESULT UPLOAD_TOKEN ACTION_CONTENT 类型 String String String String JSON 视频上传固定值为FILE 视频上传完成固定值为 UPLOAD_FINISH 上传成功为 SUCCESS，上传失败为 FAILURE 上传token JSON对象，上传完成后创建的素材，当上传成功时包含该字段，参考5.1.22附录-数据类型-MaterialFile 说明 视频上传完成回调示例：
{ \"code\": 0, \"message\": \"处理成功\ \"data\": { 4
视频云点播API接口调用规范
\"ACTION_CONTENT\": {
\"materialName\": \"2018.mp4\ \"materialLength\": \"10485760\ \"description\": \"描述\ \"fileInfo\": {
\"fileUrl\": \"http://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b407c81145dc5225d8b8999/2261186058BD4A2F9DFD0DBD9A39B0D4.mp4\" },
\"id\": \"5b407c81145dc5225d8b8999\ \"title\": \"测试视频2018.mp4\ \"thumbURL\": \"\
\"status\": \"PROCESSING\ \"tags\": \"tags\
\"md5\": \"2197a478a30c42140fd342f6f6044bc7\" },
\"FILE_TYPE\": \"FILE\
\"ACTION\": \"UPLOAD_FINISH\ \"RESULT\": \"SUCCESS\
\"UPLOAD_TOKEN\": \"C55176AA62E84F568E316CBC545E7D4B\" } }
视频处理完成回调请求参数
名称 FILE_TYPE ACTION RESULT UPLOAD_TOKEN ACTION_CONTENT 类型 String String String String JSON 视频上传固定值为FILE 视频上传完成固定值为 PROCESS_FINISH 处理成功为 SUCCESS，处理失败为 FAILURE 上传token JSON对象，任务处理完成后创建的素材，当处理成功时包含该字段，参考5.1.22附录-数据类型-MaterialFile 说明 视频处理完成后的回调示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"FILE_TYPE\": \"FILE\5
视频云点播API接口调用规范
\"RESULT\": \"SUCCESS\
\"UPLOAD_TOKEN\": \"C55176AA62E84F568E316CBC545E7D4B\ \"ACTION\": \"PROCESS_FINISH\ \"ACTION_CONTENT\": { \"snapshotInfo\": {
\"snapshotName\": \"测试\ \"snapshotFiles\": [ {
\"pointTime\": \"0\ \"fileInfo\": {
\"fileUrl\": \"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b407c81145dc5225d8b8999/832AA2C04BEE4353AEF7F44DEE297061.jpg\" } } ],
\"snapshotId\": \"5b407927145dc51f1111ba7c\ \"status\": \"SUCCESS\" },
\"description\": \"描述\ \"fileInfo\": {
\"fileUrl\": \"http://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b407c81145dc5225d8b8999/2261186058BD4A2F9DFD0DBD9A39B0D4.mp4\" },
\"title\": \"测试视频2018.mp4\ \"transcodeInfo\": {
\"transcodeTemplateName\": \"测试\ \"transcodeFiles\": [ {
\"templateId\": \"\ \"fileInfo\": {
\"fileUrl\": \"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b407c81145dc5225d8b8999/05F7601E2746440C9474B14E1953B078.mp4\" } } ],
6
视频云点播API接口调用规范
\"transcodeTemplateId\": \"5b40786e145dc51f1111ba78\ \"status\": \"SUCCESS\" },
\"tags\": \"小呆tags\ \"auditInfo\": { \"politics\": {
\"status\": \"SUCCESS\" },
\"terrorism\": {
\"status\": \"SUCCESS\" },
\"grenScan\": {
\"status\": \"SUCCESS\" } },
\"materialName\": \"测试视频2018.mp4\ \"materialLength\": \"10485760\ \"id\": \"5b407c81145dc5225d8b8999\ \"thumbURL\": \"\ \"mediaInfo\": { \"general\": { \"size\": 376178, \"format\": \"MPEG-4\" }, \"video\": {
\"duration\": 10000, \"frameRate\": 25, \"depth\": null, \"size\": 376178, \"bitRate\": 164.472, \"format\": \"AVC\ \"width\": 384, \"height\": 216 } },
\"status\": \"SUCCESS\
\"md5\": \"2197a478a30c42140fd342f6f6044bc7\" }
7
视频云点播API接口调用规范
} } 2.3 获取图片文件上传令牌
功能描述
根据用户提供的图片名称，获取图片上传令牌（图片上传不支持断点续传）。
请求参数
名称 materialName 类型 String 128个字节； 后缀名支持： *.jpg, *.png, *.jpeg, *.gif materialLength title description Long String String 图片大小，单位：字节 图片标题，长度不超过128个字节 不填默认为图片名称 图片描述，长度不超过512个字符。不填默认为空 否 是 否 说明 图片名称，需要包含后缀名，长度不超过必填 是 返回参数
参数 uploadDomain uploadToken requestId 类型 String String String 说明 图片文件上传服务对应接口的URI (如: http://vodupload.yunshicloud.com) 上传令牌 请求ID 调用示例 请求示例：
http(s):// [域名]/token/createUploadImageToken?version=V1&materialName=测试视频.mp4&materialLength=52113140 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"uploadToken\": \"1630DDC50D23445BBA7B914E9756CF64\ \"uploadDomain\": \"http://vodupload.yunshicloud.com\ \"requestId\": \"x-request-xiaodai-test\" }} 8
视频云点播API接口调用规范
2.4 图片上传完成回调
功能描述
当在回调配置里配置了回调地址且置为开启状态后系统在图片上传完成后会主动回调。
图片上传完成后回调请求参数
名称 FILE_TYPE ACTION RESULT UPLOAD_TOKEN ACTION_CONTENT 类型 String String String String JSON 说明 图片上传固定值为 IMAGE 视频上传完成固定值为 UPLOAD_FINISH 上传成功为 SUCCESS，上传失败为 FAILURE 上传token JSON对象，上传完成后创建的素材，当上传成功时包含该字段，参考5.1.22附录-数据类型-MaterialFile 图片上传完成后的回调示例: {
\"code\": 0,
\"message\": \"处理成功\ \"data\": {
\"ACTION_CONTENT\": {
\"materialName\": \"2018.mp4\ \"materialLength\": \"10485760\ \"fileInfo\": {
\"fileUrl\": \"http://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b407c81145dc5225d8b8999/2261186058BD4A2F9DFD0DBD9A39B0D4.mp4\" },
\"id\": \"5b407c81145dc5225d8b8999\
\"md5\": \"2197a478a30c42140fd342f6f6044bc7\" },
\"FILE_TYPE\": \"IMAGE\ \"ACTION\": \"UPLOAD_FINISH\ \"RESULT\": \"SUCCESS\
\"UPLOAD_TOKEN\": \"C55176AA62E84F568E316CBC545E7D4B\" } }
9
视频云点播API接口调用规范
2.5 获取已上传视频文件大小
功能描述
根据用户提供的上传令牌、公共参数信息，获取该上传令牌对应的素材文件已上传的大小（字节数）。此接口的请求地址是获取视频文件上传令牌返回参数uploadDomain的
值。
请求参数
名称 uploadToken 类型 String 上传令牌 说明 必填 是 返回参数
参数 uploadedSize 类型 long 已上传文件的字节数 说明 调用示例 请求示例：
http://[域名]/api/video/v1/getUploadProgress?version=V1&uploadToken=123456 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"uploadedSize\": 1895 } } 2.6 文件上传
功能描述
进行文件上传前，必须先获取文件上传令牌（见获取视频文件上传令牌）；
可根据用户提供的上传令牌、与文件流，实现文件断点续传功能。此接口的请求地址是获取视频文件上传令牌返回参数uploadDomain的值。 ➢ 直接上传：
参数中breakpoint传入no或不传该值，不支持文件的断点续传，文件上传失败再次上传应从0字节开始上传。 ➢ 断点续传：
参数中breakpoint传入continue，文件上传前，必须查询已上传文件大小（见获取已
10
视频云点播API接口调用规范
上传文件大小接口），最后执行上传（不包含图片上传，图片上传失败每次重新上传，不做断点）。
本接口的Content-Type为multipart/form-data
请求参数
名称 uploadToken breakpoint 类型 String String 上传令牌 本次上传是否是断点上传，取值为： continue时将先检查上次断点文件； 传入no或不传该值将会使文件每次都重新上传，不会实现断点功能 md5 file String stream 如果此参数不为空，则上传完成后会进行文件md5校验 文件流 是 否 说明 必填 是 否 返回参数
参数 id fileURL 类型 String String 说明 视频ID（通过此ID能够查询视频详细信息，由于视频处理是异步机制，即时查询可能会存在查询不到详情的情况，建议处理流程完成回调后查询详情。）。 文件在点播系统中的访问地址。 调用示例 请求示例：
http://[域名]/api/video/v1/upload?version=V1&md5=3d952b46dd6f04471750bb42fc20fc9b&uploadToken=123456 Content-Type:multipart/form-data 并且在表单项中的file字段传入待上传的文件。 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"fileURL\": \"http://upload.yunshicloud.com/mydomain/your.mp4\ \"id\": \"5b3c40a4145dc524eb6aa8b1\" } } JAVA版文件上传示例 11
视频云点播API接口调用规范
注：java示例代码需要引入的jar【httpmime-4.3.6.jar，httpcore-4.3.3.jar，httpclient-4.3.6.jar，commons-logging-1.1.3.jar】
//调用视频或者图片文件上传令牌的返回值uploadDomain设置为上传的URI String url=\"uploadDomain/api/video/v1/upload?uploadToken=123456\"; String filePath=\"文件的磁盘路径\";
CloseableHttpClient httpclient = HttpClients.createDefault(); try {
HttpPost httppost = new HttpPost(url); FileBody file = new FileBody(new File(filePath));
HttpEntity reqEntity = MultipartEntityBuilder.create().addPart(\"file\ httppost.setEntity(reqEntity);
CloseableHttpResponse response = httpclient.execute(httppost); try {
HttpEntity resEntity = response.getEntity(); if (resEntity != null) {
System.out.println(\"Response EntityUtils.toString(resEntity)); }
EntityUtils.consume(resEntity); } finally {
response.close(); }
} catch (ClientProtocolException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try {
httpclient.close(); } catch (IOException e) { e.printStackTrace(); } } }
content:
\"
+
2.7 文件注册
功能描述
进行文件注册前，必须先获取文件上传令牌（见获取视频文件上传令牌）；
12
视频云点播API接口调用规范
可根据用户提供的上传令牌与文件URL，实现文件向点播服务中的注册。此接口的请求地址是获取视频文件上传令牌返回参数uploadDomain的值。
请求参数
名称 uploadToken fileUrl 类型 String String 说明 上传令牌 文件原始路径，文件内容需可通过直接访问路径获取 必填 是 是 返回参数
参数 id fileURL 类型 String String 说明 视频ID（通过此ID能够查询视频详细信息，由于视频处理是异步机制，即时查询可能会存在查询不到详情的情况，建议处理流程完成回调后查询详情。）。 文件在点播系统中的访问地址。 调用示例 请求示例
http://[域名]/api/video/v1/pulla?version=V1&uploadToken=657FDB12A29D4CEE8A41DC4275425420&fileUrl=http://testhwyoss.yunshicloud.com/onair/record/onsite/vgjj8d/20181105/vgjj8d_369AD5458B02459B8A2743E418A30B4C.m3u8 返回示例 { \"code\": 0, \"message\": \"success\ \"data\": { \"fileURL\": \"https://hss.yunshicloud.com/huawei_gateway/huawei_gateway/5b5c20580f23884954d9bacc/5be96fcb2b76030e363456e0/E99A49022245476BA8CB9C9D81DAE76D.m3u8\ \"id\": \"5be96fcb2b76030e363456e0\" } } 2.8 直播内容接入
功能描述
调用接口前，客户需已购买并使用视频云直播API服务。
可根据客户提供的直播通道信息与时间区间，将直播中指定的内容片断接入点播系统，并根据传入的各辅助参数定义素材及自动执行各媒体处理任务。
13
视频云点播API接口调用规范
请求参数
名称 streamName beginTime endTime appName title description cateId coverURL templateGroupId 类型 String String String String String String String String String 说明 视频云直播API服务中频道的流名称 直播内容片段的截取时间起点 直播内容片断的截取时间终点 视频云直播API服务中频道的应用名称 视频标题，长度不超过128个字节，不填默认为视频名称 视频描述，长度不超过512个字节，不填写默认为空 视频分类ID，不填写默认为空 自定义视频封面URL地址，不填写默认为空 转码模板组ID，不填写时会选用默认模板组ID进行转码处理 注: 系统自带两个模板组（不转码即分发模板组和系统标清模板组），默认使用系统标清模板组进行标准转码 snapshotId censoredId tags String String String 截图模板ID，不填写时不进行截图 审核模板组ID，支持鉴黄、涉政、暴恐识别，当为空时不进行视频审核服务 视频标签 单个标签不超过32字节。 多个用逗号分隔。 最多不超过16个标签。 标签内容需使用UTF8进行编码。 否 否 否 否 否 否 否 必填 是 是 是 否 否 返回参数
参数 id fileURL 类型 String String 说明 视频ID（通过此ID能够查询视频详细信息，由于视频处理是异步机制，即时查询可能会存在查询不到详情的情况，建议处理流程完成回调后查询详情。）。 文件在点播系统中的访问地址。 调用示例 请求示例
http://[域名]/token/createLiveToVodStorage?version=V1&appName=28d26u&streamName=v2jj8d&beginTime=2018-11-08 08:00:00&endTime=2018-11-08 09:00:00 返回示例 14
视频云点播API接口调用规范
{ \"code\": 0, \"message\": \"success\ \"data\": { \"fileURL\": \"https://hwys.yunshicloud.com/huawei_gateway/huawei_gateway/5b5c202f23884954d9bacc/5bed68782b76031bd3667560/CF52AE884FE28FBF7CA2B.m3u8\ \"id\": \"5bed68282b76031bd3667560\ \"requestId\": \"1B41209F04D2427BB5D2FA2C635278AE\" } } 第3章 视频管理接口
3.1 获取视频信息
功能描述
通过参数中所传递的要查询的视频标识，返回该视频的详情信息。
请求参数
名称 id 类型 String 说明 视频唯一标识 必填 是 返回参数
属性 requestId materialFile 类型 String JSON 请求ID JSON对象，返回视频文件信息，参考5.1.22附录-数据类型-MaterialFile 说明 调用示例 请求示例：
http(s)://[域名]/material/findMaterial?version=V1&id=5b3e4fb2145dc562f8defe45 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { 15
视频云点播API接口调用规范
\"materialFile\": { \"auditInfo\": { \"politics\": {
\"status\": \"SUCCESS\" },
\"terrorism\": {
\"status\": \"SUCCESS\" },
\"grenScan\": {
\"status\": \"SUCCESS\" } },
\"uploadToken\": \"BCC3C6E4A0164A6CB175BB91EBA6D52E\ \"snapshotInfo\": {
\"snapshotName\": \"test\ \"snapshotFiles\": [ {
\"pointTime\": \"0\ \"fileInfo\": {
\"fileUrl\": \"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/22C2394EBE5D43D9B2B62E046A1BF2F9.jpg\" } } ],
\"snapshotId\": \"5b3cb772145dc52fb73ec4a3\ \"status\": \"SUCCESS\" },
\"description\": \"\ \"fileInfo\": {
\"fileUrl\": \"http://bucketName.obs.cn-north-1.myhwclouds.com/31Q888piC7wM.mp4_10s.mp4\" },
\"id\": \"5b3e4fb2145dc562f8defe45\ \"title\": \"\ \"thumbURL\": \"\ \"mediaInfo\": { \"general\": {
16
视频云点播API接口调用规范
\"size\": 376178, \"format\": \"MPEG-4\" }, \"video\": {
\"duration\": 10000, \"frameRate\": 25, \"depth\": null, \"size\": 376178, \"bitRate\": 164.472, \"format\": \"AVC\ \"width\": 384, \"height\": 216 } },
\"transcodeInfo\": {
\"transcodeTemplateName\": \"test\ \"transcodeFiles\": [ {
\"templateId\": \"\ \"fileInfo\": {
\"fileUrl\": \"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/7F9BF304C1894A1D84C528A5F1239CCA.mp4\" } } ],
\"transcodeTemplateId\": \"5b3c945f145dc52df19ab44e\ \"status\": \"SUCCESS\" },
\"status\": \"SUCCESS\ \"md5\": \"\" },
\"requestId\": \"875B07C9127840688A23279778708503\" } }
17
视频云点播API接口调用规范
3.2 修改视频信息
功能描述
通过参数中所传递的视频信息，会对参数进行合法性校验，通过校验的信息会做相应更新并返回更新状态及视频id。
请求参数
名称 id title thumbURL cateId tags description 类型 String String String String String String 视频唯一标识 标题，长度不超过128个字节 缩略图地址，HTTP(S)格式地址，需要确保可以访问 分类ID 多个标签之间用英文半角逗号（“,”）隔开 描述，长度不超过512个字符 否 否 否 说明 必填 是 否 否
返回参数
属性 requestId materialFile 类型 String JSON 请求ID JSON对象，返回视频文件信息，参考5.1.22附录-数据类型-MaterialFile 说明 调用示例 请求示例：
http(s)://[域名]/material/updateMaterial?version=V1&id=5b3e4fb2145dc562f8defe45&title=test&thumbURL=https://obs-eb59.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/22C2394EBE5D43D9B2B62E046A1BF2F9.jpg 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"materialFile\": { \"auditInfo\": { \"politics\": { \"status\": \"SUCCESS\" 18
视频云点播API接口调用规范
},
\"terrorism\": {
\"status\": \"SUCCESS\" },
\"grenScan\": {
\"status\": \"SUCCESS\" } },
\"uploadToken\": \"BCC3C6E4A0164A6CB175BB91EBA6D52E\ \"snapshotInfo\": {
\"snapshotName\": \"test\ \"snapshotFiles\": [ {
\"pointTime\": \"0\ \"fileInfo\": { \"fileUrl\":
\"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/22C2394EBE5D43D9B2B62E046A1BF2F9.jpg\" } } ],
\"snapshotId\": \"5b3cb772145dc52fb73ec4a3\ \"status\": \"SUCCESS\" },
\"description\": \"\ \"fileInfo\": { \"fileUrl\":
1.myhwclouds.com/31Q888piC7wM.mp4_10s.mp4\" },
\"id\": \"5b3e4fb2145dc562f8defe45\ \"title\": \"test\ \"thumbURL\":
\"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/22C2394EBE5D43D9B2B62E046A1BF2F9.jpg\ \"mediaInfo\": { \"general\": { \"size\": 376178, \"format\": \"MPEG-4\"
19
\"http://bucketName.obs.cn-north-
视频云点播API接口调用规范
}, \"video\": {
\"duration\": 10000, \"frameRate\": 25, \"depth\": null, \"size\": 376178, \"bitRate\": 164.472, \"format\": \"AVC\ \"width\": 384, \"height\": 216 } },
\"transcodeInfo\": {
\"transcodeTemplateName\": \"test\ \"transcodeFiles\": [ {
\"templateId\": \"\ \"fileInfo\": { \"fileUrl\":
\"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/7F9BF304C1894A1D84C528A5F1239CCA.mp4\" } } ],
\"transcodeTemplateId\": \"5b3c945f145dc52df19ab44e\ \"status\": \"SUCCESS\" },
\"status\": \"SUCCESS\ \"md5\": \"\" },
\"requestId\": \"291890BB062C4BD581F1BBD84C1DDD82\" }}
3.3 获取视频信息列表
功能描述
通过参数中所传递的信息，返回该用户的视频列表信息（按照创建时间倒序），其中视频文件的属性信息，均为原始视频的基本属性信息。
20
视频云点播API接口调用规范
请求参数
名称 currentPage pageSize status 类型 String String String 当前页，默认为1 页大小，默认为10，最多100条 状态，SUCCESS:处理成功;FAILURE:处理失败;PROCESSING:处理中;DISABLE:停用,ALL:所有，默认获取所有 cateId startTime endTime String String String 分类ID，默认获取所有 开始时间（yyyy-MM-dd HH:mm:ss） 结束时间（yyyy-MM-dd HH:mm:ss） 否 否 否 说明 必填 否 否 否 返回参数
属性 requestId list currentPage pageSize totalCount 类型 String Array int int int 请求ID JSON数组，视频列表，JSON结构参考5.1.22附录-数据类型-MaterialFile 当前页 页大小 总条数 说明 调用示例 请求示例：
http(s)://[域名]/material/findListMaterial?version=V1¤tPage=1&pageSize=1&status=SUCCESS 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"x-request-xiaodai-test\ \"pageSize\": 10, \"list\": [ { \"snapshotInfo\": { \"snapshotName\": \"xiaodai截测试\ \"snapshotFiles\": [ { \"pointTime\": \"0\21
视频云点播API接口调用规范
\"fileInfo\": {
\"fileUrl\": \"https://obs22F4.jpg\" } } ],
\"snapshotId\": \"5b407927145dc51f1111ba7c\ \"status\": \"SUCCESS\" },
\"description\": \"小呆 描述3\ \"fileInfo\": {
\"fileUrl\": \"http://o440DB4A9D9A245ECBC73DA043.mp4\" },
\"title\": \"测试视频33.mp4\ \"cateName\": \"视频测试分类\ \"transcodeInfo\": {
\"transcodeTemplateName\": \"xiao测试水印转码审核\ \"transcodeFiles\": [ {
\"templateId\": \"\ \"fileInfo\": { \"fileUrl\": \"https:/460E28142ECAF31696D479B3AD3.mp4\" } } ],
\"transcodeTemplateId\": \"5b40786e145dc51f1111ba78\ \"status\": \"SUCCESS\" },
\"tags\": \"小呆tags3\ \"auditInfo\": { \"politics\": {
\"status\": \"SUCCESS\" },
\"terrorism\": {
\"status\": \"SUCCESS\" },
\"grenScan\": { \"auditPoints\": [
22
视频云点播API接口调用规范
{
\"pointTime\": \"102000\ \"results\": [ {
\"confidence\": \"0.6277\ \"label\": \"normal\" }, {
\"confidence\": \"0.3723\ \"label\": \"porn\" } ] }, {
\"pointTime\": \"36000\ \"results\": [ {
\"confidence\": \"0.6238\ \"label\": \"normal\" }, {
\"confidence\": \"0.3762\ \"label\": \"porn\" } ] } ],
\"status\": \"SUCCESS\" } },
\"materialName\": \"测试视频33.mp4\ \"materialLength\": \"10485760\
\"cateId\": \"5b407811145dc51f1111ba76\ \"id\": \"5b40c18c145dc529201c7d9b\ \"thumbURL\": \"\ \"mediaInfo\": { \"general\": {
\"size\": 24659898,
23
视频云点播API接口调用规范
\"format\": \"MPEG-4\" }, \"video\": {
\"duration\": 166656, \"frameRate\": 29, \"depth\": null, \"size\": 24659898, \"bitRate\": 1100, \"format\": \"AVC\ \"width\": 1024, \"height\": 576 } },
\"status\": \"SUCCESS\
\"md5\": \"847411f927daa6c36f73456e1a0f4e7d\" } ], \"currentPage\": 1, \"totalCount\": 1 }}
3.4 获取源文件地址
功能描述 获取视频源文件地址。
注：只有审核通过才能获取到视频原地址。
请求参数
名称 id 类型 String 视频id 说明 必填 是 返回参数
属性 requestId sourceUrl 类型 String String 请求ID 源文件地址 说明 调用示例 请求示例：
http(s)://[域名]/material/findMaterialUrl?version=V1&id=5b3e4fb2145dc562f8defe45 返回示例： 24
视频云点播API接口调用规范
{ \"code\": 0, \"message\": \"success\ \"data\": { \"sourceUrl\": \"https://bucketName.obs.cn-north-1.myhwclouds.com/huawei_gateway/huawei_gateway/5b3b868b145dc512778e0372/5b3e4fb2145dc562f8defe45/7F9BF304C1894A1D84C528A5F1239CCA.mp4\ \"requestId\": \"81118A12303A4B0EAF96D31F0BA6AB7A\" }} 3.5 删除视频文件
功能描述
通过参数中所传递视频的唯一标识，将从存储中彻底删除所对应的视频文件和视频截图转码产生的相关文件，删除后释放存储空间，文件不可恢复，请慎重操作。
请求参数
名称 id 类型 String 视频id 说明 必填 是 返回参数
属性 requestId id 类型 String String 请求id 视频id 说明 调用示例 请求示例：
http(s)://[域名]/material/deleteMaterial?version=V1&id=5b3e4fb2145dc562f8defe45 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"id\":\"5b3e4fb2145dc562f8defe45\ \"requestId\": \"81118A12303A4B0EAF96D31F0BA6AB7A\" } } 25
视频云点播API接口调用规范
第4章 全局设置接口
4.1 转码设置
视频上传完成后，会自动进入转码处理的过程。根据您的业务需要，您可以选择系统转码模版组和不转码模版组两种处理方式（系统默认为系统转码模板组），如果有新的需求可以自定义新的转码组。
新增转码组 4.1.1.1 功能描述
根据业务需要，您可以新增转码模版组，并进行自定义设置。可设置内容包括转码模板和水印。
4.1.1.2 请求参数
名称 transcodeTemplates 类型 Array 说明 模板组名称，长度不超过64个字节 转码模板集合，JSON数组，JSON结构参考5.2.1附录-参数详情-转码模板配置详情，如: [{\"transcodeTemplateId\":\"S00000000-000010\"，\"waterMarkTemplates\":[{\"waterMarkTemplateId\":\"88c6ca184c0e47098a5b665e2a126797\MarkTemplateId\":\"88c6ca184c0e47098a5b665e2a126798\000011\ 必填 是 是 templateGroupName String 4.1.1.3 返回参数
属性 requestId templateGroup 类型 String JSON 请求ID JSON对象，转码模板组 参考5.1.1附录-数据类型-TemplateGroup 说明 4.1.1.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/createTranscodeTemplateGroup/?version=V1&templateGroupName=转码模板组&transcodeTemplates=[{\"transcodeTemplateId\":\"S00000000-000010\ 返回示例： { \"code\": 0, 26
视频云点播API接口调用规范
\"message\": \"success\ \"data\": { \"templateGroup\": { \"isDefault\": \"notDefault\ \"transcodeTemplates\": [ { \"transcodeTemplateId\": \"S00000000-000010\" } ], \"templateGroupName\": \"默认转码模板组\ \"templateGroupType\": \"personal\ \"templateGroupId\": \"5b3cfcb4cf65684c9040bb9e\ \"templateTranscodeMode\": \"transcode\" }, \"requestId\": \"D08AD0BB49084CC9999688571ED2CC15\" } }
更新转码组 4.1.2.1 功能描述
更新已经设置的转码模板组配置信息。 4.1.2.2 请求参数
名称 templateGroupId transcodeTemplates 类型 String Array 转码模板组主键 转码模板组名称，长度不超过64个字节 转码模板集合，JSON数组字符串，JSON结构参考5.2.1附录-参数详情-转码模板配置详情， 如: [{\"transcodeTemplateId\":\"S00000000-000010\"，waterMarkTemplates:[{\"waterMarkTemplateId\":\"88c6ca184c0e47098a5b665e2a126797\waterMarkTemplateId\":\"88c6ca184c0e47098a5b665e2a126798\0000000-000011\ 说明 必填 是 是 是 templateGroupName String 4.1.2.3 返回参数 属性 类型 27
说明 视频云点播API接口调用规范
requestId templateGroup String JSON 请求ID JSON对象，转码模板组 参考5.1.1附录-数据类型-TemplateGroup 4.1.2.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/updateTranscodeTemplateGroup/?version=V1&templateGroupName=修改转码模板组&templateGroupId=5b3cfcb4cf65684c9040bb9e&transcodeTemplates=[{\"transcodeTemplateId\":\"S00000000-000011\ 返回示例： {
\"code\": 0,
\"message\": \"success\ \"data\": {
\"templateGroup\": {
\"isDefault\": \"notDefault\ \"transcodeTemplates\": [ {
\"transcodeTemplateId\": \"S00000000-000011\" } ],
\"templateGroupName\": \"修改转码模板组\ \"templateGroupType\": \"personal\
\"templateGroupId\": \"5b3cfcb4cf65684c9040bb9e\ \"templateTranscodeMode\": \"transcode\" },
\"requestId\": \"6C27988D8BF9433C890864C5065F915E\" } }
查询转码组列表 4.1.3.1 功能描述 获取转码组列表。 4.1.3.2 请求参数
参数 currentPage pageSize 格式 String String 说明 当前页，默认为1 页大小，默认为10，最多100条 28
必填 否 否 视频云点播API接口调用规范
转码模板类型 取值范围： templateGroupType String system（系统） personal（个人的） 默认为personal 否 4.1.3.3 返回参数
参数 list currentPage pageSize totalCount requestId Array Int Int int String 格式 说明 JSON数组，查询到的模板列表，JSON结构参考5.1.1附录-数据类型-TemplateGroup 当前页 页大小 总条数 请求ID 4.1.3.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/findListTranscodeTemplateGroup/?version=V1 返回示例：
{
\"code\": 0,
\"message\": \"success\ \"data\": {
\"requestId\": \"0A09D15755A54392ADFA266291878755\ \"pageSize\": 10, \"list\": [ {
\"isDefault\": \"notDefault\ \"transcodeTemplates\": [ {
\"transcodeTemplateId\": \"S00000000-000011\" } ],
\"templateGroupName\": \"修改转码模板组\ \"templateGroupType\": \"personal\ \"waterMarkTemplates\": [],
\"templateGroupId\": \"5b3cfcb4cf65684c9040bb9e\ \"templateTranscodeMode\": \"transcode\" },
29
视频云点播API接口调用规范
{
\"isDefault\": \"notDefault\ \"transcodeTemplates\": [ {
\"transcodeTemplateId\": \"S00000000-000010\" } ],
\"templateGroupName\": \"默认转码模板组\ \"templateGroupType\": \"personal\ \"waterMarkTemplates\": [],
\"templateGroupId\": \"5b3cfa42cf65684c9040bb9d\ \"templateTranscodeMode\": \"transcode\" }, ... ],
\"currentPage\": 1, \"totalCount\": 7 } }
查询转码组 4.1.4.1 功能描述
根据转码组id查询转码组详情。 4.1.4.2 请求参数
名称 templateGroupId 类型 String 转码模板组主键 说明 必填 是 4.1.4.3 返回参数
属性 requestId templateGroup 类型 String JSON 请求ID JSON对象，转码模板组 参考5.1.1附录-数据类型-TemplateGroup 说明 4.1.4.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/findTranscodeTemplateGroup/?version=V1&templateGroupId=5b3cfcb4cf65684c9040bb9e 返回示例： 30
视频云点播API接口调用规范
{
\"code\": 0,
\"message\": \"success\ \"data\": {
\"templateGroup\": {
\"isDefault\": \"notDefault\ \"transcodeTemplates\": [ {
\"transcodeTemplateId\": \"S001-0024\" } ],
\"templateGroupName\": \"test\ \"templateGroupType\": \"system\ \"waterMarkTemplates\": [],
\"templateGroupId\": \"5b3ba372145dc5188ca27dbe\ \"templateTranscodeMode\": \"transcode\" },
\"requestId\": \"C7F661E308A2472EBF2DC0E916F96C3C\" } }
删除转码组 4.1.5.1 功能描述
根据ID删除已经设置的转码组。 4.1.5.2 请求参数
名称 templateGroupId 类型 String 转码模板组主键 说明 必填 是 4.1.5.3 返回参数 属性 requestId templateGroupId 类型 String String 请求ID 删除成功的转码模板组ID 说明 4.1.5.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/deleteTranscodeTemplateGroup/?version=V1&templateGroupId=5b3cfcb4cf65684c9040bb9e 返回示例：
{ 31
视频云点播API接口调用规范
\"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"8E294902E2AD4BFBB139E35D8B2E69BD\ \"templateGroupId\": \"5b3cfcb4cf65684c9040bb9e\" } } 设置默认转码组 4.1.6.1 功能描述 设置一个默认的转码组。 4.1.6.2 请求参数
参数 templateGroupId 格式 String 转码模板组主键 说明 必填 是 4.1.6.3 返回参数 属性 requestId templateGroupId 类型 String String 请求ID 默认转码模板组ID 说明 4.1.6.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplateGroup/setTranscodeTemplateGroup/?version=V1&templateGroupId=5b3ba372145dc5188ca27dbe 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"043E2E4FB4494C6FA31450104331093E\ \"templateGroupId\": \"5b3ba372145dc5188ca27dbe\" } } 查询转码模板 4.1.7.1 功能描述 查询所有的转码模板列表；
指定转码模板id查询该转码模板详情。
32
视频云点播API接口调用规范
4.1.7.2 请求参数
参数 transcodeTemplateId currentPage pageSize 格式 String String String 说明 转码模板的主键，唯一标识 当前页，默认为1 页大小，默认为10，最多100条 必填 否 否 否 4.1.7.3 返回参数
属性 类型 说明 JSON数组，查询到的转码模板，JSON结构参考5.1.1附录-数据类型-TranscodeTempllist currentPage pageSize totalCount requestId Array int int int String ate 当前页 页大小 总条数 请求ID 4.1.7.4 调用示例 请求示例：
http(s)://[域名]/transcodeTemplate/findListTranscodeTemplate/?version=V1 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"x-request-xiaodai-test\ \"pageSize\": 10, \"list\": [ { \"transcodeTemplateName\": \"123456模板名\ \"transcodeTemplateId\": \"123456-TemplateId\" } ], \"currentPage\": 1, \"totalCount\": 1 }} 4.2 审核设置
视频点播审核服务集成了图片鉴黄、涉政、暴恐机器智能识别服务，为视频人工审核提供参考依据。
33
视频云点播API接口调用规范
新增审核模板 4.2.1.1 功能描述 新增审核模板。 4.2.1.2 请求参数
名称 censoredName porn 类型 String String 说明 审核模板名称，长度不超过64个字节 是否开启鉴黄识别服务 取值范围： close（关闭） open（开启） 默认值为close politics String 是否开启涉政识别服务 取值范围： close（关闭） open（开启） 默认值为close terrorism String 是否开启暴恐识别服务 取值范围： close（关闭） open（开启） 默认值为close 否 否 必填 是 否 4.2.1.3 返回参数 属性 requestId censoredTemplate 类型 String JSON 请求ID JSON对象，审核模板 参考5.1.4附录-数据类型-CensoredTemplate 说明 4.2.1.4 调用示例 请求示例：
http(s)://[域名]/censoredConfig/createCensoredConfig?version=V1&censoredName=test&eg 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"censoredTemplate\": { \"censoredId\": \"5b3c8234cdf56f39c09e223a\ \"politics\": \"close\34
视频云点播API接口调用规范
\"terrorism\": \"open\ \"censoredName\": \"审核设置名1111\ \"porn\": \"open\" } } } 更新审核模板 4.2.2.1 功能描述 修改审核模板。 4.2.2.2 请求参数
名称 censoredId censoredName porn 类型 String String String 审核模版ID 审核模板名称，长度不超过64个字节 是否开启鉴黄服务 取值范围： close（关闭） open（开启） 默认值为close politics String 是否开启涉政服务 取值范围： close（关闭） open（开启） 默认值为close terrorism String 是否开启暴恐服务 取值范围： close（关闭） open（开启） 默认值为close 否 否 说明 必填 是 否 否 4.2.2.3 返回参数 属性 requestId censoredTemplate String Array 类型 请求ID JSON对象，审核模板 参考5.1.4附录-数据类型-CensoredTemplate 说明 4.2.2.4 调用示例 请求示例：
http(s)://[域名]/censoredConfig/updateCensoredConfig?version=V1&censoredId=5b3c71cecdf56f21b44fcdb8&censoredName=test 返回示例：
35
视频云点播API接口调用规范
{ \"code\": 0, \"message\": \"success\ \"data\": { \"censoredTemplate\": { \"censoredId\": \"5b5c23500f23764954d9bacf\ \"politics\": \"close\ \"terrorism\": \"open\ \"censoredName\": \"test\ \"porn\": \"close\" }, \"requestId\": \"7CFC074D6FE441938B9445D435CBE9C6\" } } 查询审核模板列表 4.2.3.1 功能描述 获取审核模板列表。
36
视频云点播API接口调用规范
4.2.3.2 请求参数
参数 currentPage pageSize 格式 String String 说明 当前页，默认为1 页大小，默认为10，最多100条 必填 否 否 4.2.3.3 返回参数 参数 list currentPage pageSize totalCount requestId Array int int int String 格式 说明 JSON数组，查询到的审核模板列表，JSON结构参考5.1.4附录-数据类型-CensoredTemplate 当前页 页大小 总条数 请求ID 4.2.3.4 调用示例 请求示例：
http(s)://[域名]/censoredConfig/findListCensoredConfig?version=V1¤tPage=1&pageSize=10 返回示例：
{
\"code\": 0,
\"message\": \"success\ \"data\": {
\"pageSize\": 2, \"list\": [ {
\"censoredId\": \"5b3c822dcdf56f39c09e2239\ \"politics\": \"close\ \"terrorism\": \"open\
\"censoredName\": \"审核名称123\ \"porn\": \"open\" }, {
\"censoredId\": \"5b3c8234cdf56f39c09e223a\ \"politics\": \"close\ \"terrorism\": \"open\
\"censoredName\": \"审核名称12334\ \"porn\": \"open\"
37
视频云点播API接口调用规范
} ], \"currentPage\": 1, \"totalCount\": 4 } } 查询模板详情 4.2.4.1 功能描述
根据审核模板ID查询审核模板详情。 4.2.4.2 请求参数
名称 censoredId 类型 String 审核模版ID 说明 必填 是 4.2.4.3 返回参数 属性 requestId censoredTemplate 类型 String JSON 请求ID JSON对象，审核模板 参考5.1.4附录-数据类型-CensoredTemplate 说明 4.2.4.4 调用示例 请求示例：
http(s)://[域名]/censoredConfig/findCensoredConfig?version=V1&censoredId=5b3c8224cdf56f39c09e2238 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"censoredTemplate\": { \"censoredId\": \"5b3c8224cdf56f39c09e2238\ \"politics\": \"open\ \"terrorism\": \"close\ \"censoredName\": \"审核设置名称123\ \"porn\": \"open\" } } } 38
视频云点播API接口调用规范
删除审核模板 4.2.5.1 功能描述 根据ID删除审核模板。 4.2.5.2 请求参数
名称 censoredId 类型 String 审核模版ID 说明 必填 是 4.2.5.3 返回参数 属性 requestId censoredId 类型 String String 请求ID 删除成功的审核模版ID 说明 4.2.5.4 调用示例 请求示例：
http(s)://[域名]/censoredConfig/deleteCensoredConfig?version=V1&censoredId=5b3c8224cdf56f39c09e2238 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"censoredId\": \"5b3c8224cdf56f39c09e2238\" }} 4.3 水印设置
水印功能主要用于视频转码过程。您可以根据自己的需要，设置水印内容的大小和位置，以便在视频转码时将水印画面压制到视频之中。在水印设置中，可以进行水印内容的添加、删除等一系列操作。
新增水印模板 4.3.1.1 功能描述 创建水印模板。 4.3.1.2 请求参数
参数 name config 格式 String JSON 说明 模板名称，最大长度128字节 水印模板配置，JSON对象，参考5.2.2附录-参数详39
必填 是 是 视频云点播API接口调用规范
情-水印模版配置详情 4.3.1.3 返回参数
参数 waterMarkTemplate JSON requestId String 格式 说明 JSON对象，水印模板,参考5.1.4附录-数据类型-WaterMarkTemplate 请求ID 4.3.1.4 调用示例 请求示例：
http(s)://[域名]/waterMark/createWaterMark?version=V1&name=test&eg 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"waterMarkTemplate\": { } } } \"waterMarkTemplateId\": \"5b3cd5e00f1f480c68a9733b\\"dx\": \"0\\"dy\": \"0\\"name\": \"wwww\\"type\": \"Image\ ...... 更新水印模板 4.3.2.1 功能描述 更新已创建的水印模板。 4.3.2.2 请求参数
参数 waterMarkTemplateId name config 格式 String String String 水印模板ID 模板名称，最大长度128字节 水印模板配置，JSON对象，参考 附录-参数详情 水印模版配置详情。 说明 必填 是 否 否 40
视频云点播API接口调用规范
4.3.2.3 返回参数
参数 waterMarkTemplate requestId JSON String 格式 说明 JSON结构，更新后的模板，参考5.1.4附录-数据类型-WaterMarkTemplate 请求ID 4.3.2.4 调用示例 请求示例：
http(s)://[域名]/waterMark/updateWaterMark?version=V1&waterMarkTemplateId=5b3cd5e00f1f480c68a9733b 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"waterMarkTemplate\": { } } } \"waterMarkTemplateId\": \"5b3cd5e00f1f480c68a9733b\\"dx\": \"0\\"dy\": \"0\\"name\": \"wwww\\"type\": \"Image\ ...... 查询水印详情 4.3.3.1 功能描述
根据水印模板id查询水印模板详情。 4.3.3.2 请求参数
参数 waterMarkTemplateId 格式 String 水印模板ID 说明 必填 是 4.3.3.3 返回参数 参数 waterMarkTemplate JSON 41
格式 说明 JSON对象，水印模板详情，参考5.1.4视频云点播API接口调用规范
附录-数据类型-WaterMarkTemplate requestId String 请求ID 4.3.3.4 调用示例 请求示例：
http(s)://[域名]/waterMark/findWaterMark?version=V1&waterMarkTemplateId=5b3cd5e00f1f480c68a9733b 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"waterMarkTemplate\": { } } } \"waterMarkTemplateId\": \"5b3cd5e00f1f480c68a9733b\\"dx\": \"0\\"dy\": \"0\\"name\": \"wwww\\"type\": \"Image\ ...... 查询水印列表 4.3.4.1 功能描述 获取已经创建的水印列表。 4.3.4.2 请求参数
参数 currentPage pageSize 格式 String String 说明 当前页，默认为1 页大小，默认为10，最多100条 必填 否 否 4.3.4.3 返回参数
参数 格式 说明 JSON数组，查询到的模板列表，JSON结构参考5.1.4附录-数据类型-Watlist currentPage pageSize Array int int 42 erMarkTemplate 当前页 页大小 视频云点播API接口调用规范
totalCount requestId int String 总条数 请求id 4.3.4.4 调用示例 请求示例：
http(s)://[域名]/waterMark/findListWaterMark?version=V1¤tPage=1&pageSize=10 返回示例： {
\"code\": 0,
\"message\": \"success\ \"data\": {
\"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"currentPage\": 1, \"pageSize\": 10, { } ...... ] } }
\"waterMarkTemplateId\": \"5b3cd5e00f1f480c68a9733b\ \"dx\": \"0\ \"dy\": \"0\
\"name\": \"wwww\ \"type\": \"Image\
\"totalCount\": 3
\"list\":[
......
删除水印模板 4.3.5.1 功能描述 根据ID删除水印模板。 4.3.5.2 请求参数
参数 waterMarkTemplateId 含义 水印模板id 格式 String 说明 需要删除的水印模板id 必填 是 4.3.5.3 返回参数 参数 格式 43
说明 视频云点播API接口调用规范
waterMarkTemplateId requestId String String 删除成功的水印模板id 请求id 4.3.5.4 调用示例 请求示例：
http(s)://[域名]/waterMark/deleteWaterMark?version=V1&waterMarkTemplateId=5b3cd5e00f1f480c68a9733b 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"waterMarkTemplateId\": \"5b3cd5e00f1f480c68a9733b\" } } 4.4 截图设置
在视频处理中，您可以根据自己的需要进行截图。支持按时间间隔，截图数量进行截图处理。
新增截图模板 4.4.1.1 功能描述 新增截图模板。 4.4.1.2 请求参数
名称 snapshotName snapshotConfig 类型 String JSON 说明 截图模板名称，长度不超过64个字节 截图配置，JSON对象，参考5.2.4附录-参数详情-SnapshotConfig 详情。 必填 是 否 4.4.1.3 返回参数 参数 snapshotTemplate requestId JSON String 格式 说明 JSON对象，截图模板，参考5.1.5附录-数据类型 SnapshotTemplate 请求ID 4.4.1.4 调用示例 请求示例：
http(s)://[域名]/snapshotConfig/createSnapshotConfig?version=V1&snapshotName=tes44
视频云点播API接口调用规范
t&snapshotConfig={\"interval\":\"23\返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"snapshotTemplate\": { \"snapshotName\": \"xiaodai截图模板名称\ \"width\": 200, \"interval\": 23, \"snapshotId\": \"5b3c71cecdf56f21b44fcdb8\ \"num\": 143, \"height\": 120 } } } 更新截图模板 4.4.2.1 功能描述 更新截图模板参数。 4.4.2.2 请求参数
名称 snapshotId snapshotName snapshotConfig 类型 String String JSON 截图模板ID 截图模板名称，长度不超过64个字节 截图配置，JSON对象，参考5.2.4附录-参数详情-SnapshotConfig 详情。 说明 必填 是 否 否 4.4.2.3 返回参数
参数 snapshotTemplate requestId JSON String 格式 说明 JSON对象，截图模板，参考5.1.5附录-数据类型 SnapshotTemplate 请求ID 4.4.2.4 调用示例 请求示例：
http(s)://[域名]/snapshotConfig/updateSnapshotConfig?version=V1&snapshotId=5b3c71cecdf56f21b44fcdb8 返回示例： { 45
视频云点播API接口调用规范
\"code\": 0, \"message\": \"success\ \"data\": { \"snapshotTemplate\": { \"snapshotName\": \"xiaodai截图模板名称\ \"width\": 200, \"interval\": 23, \"snapshotId\": \"5b3c71cecdf56f21b44fcdb8\ \"num\": 143, \"height\": 120 } } } 查询截图详情 4.4.3.1 功能描述
根据截图模板id查询截图模板详情。 4.4.3.2 请求参数
名称 snapshotId 类型 String 截图模版ID 说明 必填 是 4.4.3.3 返回参数 属性 requestId snapshotTemplate String SnapshotTemplate 类型 请求ID 截图模板，参考5.1.5附录-数据类型 SnapshotTemplate 说明 4.4.3.4 调用示例 请求示例：
http(s)://[域名]/snapshotConfig/findSnapshotConfig?version=V1&snapshotId=5b3c71cecdf56f21b44fcdb8 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"snapshotTemplate\": { \"snapshotName\": \"xiaodai截图模板名称\ \"width\": 200, 46
视频云点播API接口调用规范
\"interval\": 23, \"snapshotId\": \"5b3c71cecdf56f21b44fcdb8\ \"num\": 143, \"height\": 120 } }} 查询模板列表 4.4.4.1 功能描述 获取截图模板列表。 4.4.4.2 请求参数
参数 currentPage pageSize 格式 String String 说明 当前页，默认为1 页大小，默认为10，最多100条 必填 否 否 4.4.4.3 返回参数
参数 格式 说明 JSON数组，查询到的截图模板列表，JSON结构参考5.1.5附录-数据类型 Snlist currentPage pageSize totalCount requestId Array int int int String apshotTemplate 当前页 页大小 总条数 请求ID 4.4.4.4 调用示例 请求示例：
http(s)://[域名]/snapshotConfig/findListSnapshotConfig?version=V1¤tPage=1&pageSize=10 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"pageSize\": 2, \"list\": [ { \"snapshotName\": \"xiaodai截图模板名称3344\ \"width\": \"401\47 视频云点播API接口调用规范
\"interval\": \"23\ \"snapshotId\": \"5b3c7925ddffda20d096c166\ \"num\": \"143\ \"height\": \"120\" }, { \"snapshotName\": \"xiaodai截图模板名称333\ \"width\": \"401\ \"interval\": \"23\ \"snapshotId\": \"5b3c7924ddffda20d096c165\ \"num\": \"143\ \"height\": \"120\" } ], \"currentPage\": 2, \"totalCount\": 4 } } 删除截图模板 4.4.5.1 功能描述
根据截图ID删除截图模板。 4.4.5.2 请求参数
名称 snapshotId 类型 String 截图模板ID 说明 必填 是 4.4.5.3 返回参数 属性 requestId snapshotId 类型 String String 请求ID 截图模板ID 说明 4.4.5.4 调用示例 请求示例：
http(s)://[域名]/snapshotConfig/deleteSnapshotConfig?version=V1&snapshotId=5b3c71cecdf56f21b44fcdb8 返回示例：
{ \"code\": 0, \"message\": \"success\48
视频云点播API接口调用规范
\"data\": { \"snapshotId\": \"5b3c71cecdf56f21b44fcdb8\ \"requestId\": \"x-request-xiaodai-test\" } } 4.5 视频分类设置
新增分类 4.5.1.1 功能描述
创建视频分类，最大支持三级分类，每个分类最多支持创建200个子分类。 4.5.1.2 请求参数
名称 parentId 类型 说明 必填 是 否 cateName String 分类名称，长度不超过64个字节，UTF8编码 String 父分类ID，若不填，则默认生成一级分类，根节点分类ID为-1 4.5.1.3 返回参数
属性 requestId category 类型 String JSON 请求ID JSON对象，视频分类信息，参考5.1.6附录-数据类型-Category 说明 4.5.1.4 调用示例 请求示例：
http(s)://[域名]/category/createCategory?version=V1&cateName=视频分类 返回示例： { \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"category\": { \"level\": 1, \"cateId\": \"5b3cd3d7cf65684d3ccaa2b4\ \"cateName\": \"视频分类\ \"parentId\": \"-1\" } } } 49
视频云点播API接口调用规范
修改分类 4.5.2.1 功能描述 修改分类。 4.5.2.2 请求参数
名称 cateName cateId 类型 String String 分类ID 说明 分类名称，长度不超过64个字节，UTF8编码 必填 是 是 4.5.2.3 返回参数 属性 requestId category 类型 String JSON 请求ID JSON对象，视频分类信息，参考5.1.6附录-数据类型-Category 说明 4.5.2.4 调用示例 请求示例：
http(s)://[域名]/category/updateCategory?version=V1&cateName=视频分类修改&cateId=5b3cd3d7cf65684d3ccaa2b4 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"requestId\": \"45123875-5F38-4W33-BER5-D7345672CA58\ \"category\": { \"level\": 1, \"cateId\": \"5b3cd3d7cf65684d3ccaa2b4\ \"cateName\": \"视频分类修改\ \"parentId\": \"-1\" } } } 删除分类 4.5.3.1 功能描述
删除视频分类。若该分类下有子分类，删除时会同时删除其下级分类（包括二级分类和三级分类），请慎重操作。
50
视频云点播API接口调用规范
4.5.3.2 请求参数
名称 cateId 类型 String 分类ID 说明 必填 是 4.5.3.3 返回参数 属性 requestId cateId 类型 String String 请求ID 已删除的分类ID 说明 4.5.3.4 调用示例 请求示例：
http(s)://[域名]/category/deleteCategory?version=V1&cateId=5b3cd3d7cf65684d3ccaa2b4 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"cateId\": \"5b3cd3d7cf65684d3ccaa2b4\ \"requestId\": \"0440AF8F84E544E49E74328644359CA2\" } } 获取分类及其子分类 4.5.4.1 功能描述
获取指定的分类信息，及其子分类（即下一级分类）的列表。 4.5.4.2 请求参数
名称 cateId currentPage pageSize 类型 String int int 说明 分类ID，默认为根节点分类ID即-1 子分类列表页号，默认1 子分类列表页长，默认10，最大不超过100 必填 否 否 否 4.5.4.3 返回参数
属性 requestId category subTotal subCategories 类型 String JSON Long JSON 请求ID JSON对象，视频分类信息，参考5.1.6附录-数据类型-Category 子分类总数 JSON对象，子分类列表，参考5.1.6附录-数据类型-Cat51
说明 视频云点播API接口调用规范
egory 4.5.4.4 调用示例 请求示例：
http(s)://[域名]/category/findCategory/?version=V1&cateId=5b3c3bcdcf65682d60c3af3a 返回示例：
{
\"code\": 0,
\"message\": \"success\ \"data\": {
\"cateId\": \"5b3c3bcdcf65682d60c3af3a\
\"requestId\": \"84CAEA4FCB6C404CBD4746979D0FDC74\ \"category\": { \"level\": 1,
\"cateId\": \"5b3c3bcdcf65682d60c3af3a\ \"cateName\": \"视频分类1的修改\ \"parentId\": \"-1\" },
\"subCategories\": { \"pageSize\": 10, \"subTotal\": 4, \"currentPage\": 1, \"category\": [ {
\"level\": 2,
\"cateId\": \"5b3c3bf1cf65682d60c3af3b\ \"cateName\": \"视频分类1的子分类\ \"parentId\": \"5b3c3bcdcf65682d60c3af3a\" }, {
\"level\": 2,
\"cateId\": \"5b3c4756cf6568125c3d98a6\ \"cateName\": \"视频分类1的子分类1\ \"parentId\": \"5b3c3bcdcf65682d60c3af3a\" }, {
\"level\": 2,
52
视频云点播API接口调用规范
\"cateId\": \"5b3c475bcf6568125c3d98a7\ \"cateName\": \"视频分类1的子分类2\ \"parentId\": \"5b3c3bcdcf65682d60c3af3a\" }, { \"level\": 2, \"cateId\": \"5b3c475fcf6568125c3d98a8\ \"cateName\": \"视频分类1的子分类3\ \"parentId\": \"5b3c3bcdcf65682d60c3af3a\" } ] } } } 4.6 回调设置
设置回调地址 4.6.1.1 功能描述
当视频处理（如上传、转码）完成后，视频点播服务可以通过配置的回调地址即时通知用户。目前只支持上传完成后回调、任务全部处理完成后回调。 4.6.1.2 请求参数
名称 callBackUrl openFlag 类型 String String 的可用性进行校验 是否开启回调 取值范围： close（关闭） open（开启） 默认值为open 否 说明 回调地址，目前不支持带参地址，不对地址必填 是 4.6.1.3 返回参数 属性 requestId callbackConfig 类型 String JSON 请求ID JSON对象，视频分类信息，参考5.1.24附录-数据类型 CallbackConfig 说明 4.6.1.4 调用示例 请求示例：
http(s)://[域名]/callbackConfig/setCallBackConfig/?version=V1&callBackUrl=http://api.y53
视频云点播API接口调用规范
unshicloud.com&openFlag=close 返回示例：
{ \"code\": 0, \"message\": \"success\ \"data\": { \"callbackConfig\": { \"callBackUrl\": \"http://api.yunshicloud.com\ \"openFlag\": \"close\" }, \"requestId\": \"1757176898704FB0AB579AAEA7CBE21F\" } }
54
视频云点播API接口调用规范
第5章 附录
5.1 数据类型
TemplateGroup 转码模板组
templateGroupId templateGroupName transcodeTemplates waterMarkTemplates 格式 String String JSON JSON 转码模板组主键 转码模板组名称 JSON对象，参考5.1.2附录-数据类型-TranscodeTemplate JSON对象，参考5.1.3附录-数据类型-WaterMarkTemplate 转码模板类型 取值范围： templateGroupType String system（系统） personal（个人的） 是否进行转码 取值范围: templateTranscodeMode String noTranscode(不转码) transcode (转码) 是否是默认值，同一用户下只有一个默认isDefault String 值， 取值范围: default(是默认值) notDefault(不是默认值) 说明 TranscodeTemplate 转码模板
名称 transcodeTemplateId transcodeTemplateName 格式 String String 转码模版id 转码模版名称 说明 WaterMarkTemplate 水印模板
名称 waterMarkTemplateId name width height dx String String Number Number Number 55
格式 水印模版ID 水印模版名称 说明 宽，[8,4096]，单位px 高，[8,4096]，单位px 水平偏移量，[-4096,4096]，单位px 视频云点播API接口调用规范
dy referPos type imgUrl textWaterMark Number String String String JSON 垂直偏移量，[-4096,4096]，单位px 水印的位置，TopRight、TopLeft、BottomRight、BottomLeft 水印类型，Image、Text，目前仅支持 Image 图片水印地址 JSON对象，文字水印，参见5.1.23附录-数据类型-TextWaterMark CensoredTemplate
名称 censoredId censoredName porn 格式 String String String 审核模版ID 审核模板名称，长度不超过64个字节 是否开启鉴黄服务 取值范围： close（关闭） open（开启） 默认值为close politics String 是否开启涉政服务 取值范围： close（关闭） open（开启） 默认值为close terrorism String 是否开启暴恐服务 取值范围： close（关闭） open（开启） 默认值为close 说明 SnapshotTemplate
名称 snapshotId snapshotName interval String String String 格式 截图模板ID 截图模板名称，长度不超过64个字节 截图间隔时间，单位秒，若指定则表示定时截图，interval必须大于0，优先于num参数生效。 截图数量，若指定则表示定量截图，且num String 必须大于0,当interval、num都没有值时使用首帧截图 width height String String 56
说明 截图输出图片宽度，单位px，范围[8,4096]，默认200，只支持整数 截图输出图片高度，单位px，范围[8,40视频云点播API接口调用规范
96]，默认120，只支持整数 Category
属性 cateId cateName parentId level 类型 String String String Long 视频分类ID 分类名称，最大64字节，UTF8编码 父分类ID，一级分类父ID为-1 分类层级，一级分类层级为0 说明 TranscodeInfo
名称 transcodeTemplateId transcodeTemplateName JSON数组，转码成功后生成的文件，JStranscodeFile Array ON结构参见5.1.8附录-数据类型-TranscodeFile status String SUCCESS:处理成功;FAILURE:处理失败;PROCESSING:处理中; String String 格式 转码模板ID 转码模板名称 说明 TranscodeFile
名称 templateId templateName fileInfo String String JSON 格式 转码模板ID 转码模板名称 JSON对象，转码生成的文件，参见5.1.21附录-数据类型-FileInfo 说明 SnapshotInfo
名称 snapshotId snapshotName snapshotFiles String String Array 格式 截图模板ID 截图模板名称 JSON数组，截图后生成的文件列表，JSON结构参见5.1.8附录-数据类型-SnapshotFile status String SUCCESS:处理成功;FAILURE:处理失败;PROCESSING:处理中; 说明 SnapshotFile
名称 fileInfo JSON 57
格式 说明 JSON对象，截图后生成的文件地址，参视频云点播API接口调用规范
见5.1.21附录-数据类型-FileInfo pointTime String 时间点毫秒数 AuditInfo
名称 grenScan JSON 格式 说明 JSON对象如果开启鉴黄设置则有该参数，参见5.1.12附录-数据类型-AuditResult politics JSON JSON对象，如果开启涉政设置则有该参数，参见5.1.12附录-数据类型-AuditResult terrorism JSON JSON对象，如果开启暴恐设置则有该参数，参见5.1.12附录-数据类型-AuditResult AuditResult
名称 auditPoints Array 格式 说明 JSON数组，需要处理审核时间点，当结果正常时没有该字段，JSON结构参见5.1.13附录-数据类型-AuditPoint status String SUCCESS:处理成功；FAILURE:处理失败;PROCESSING:处理中 AuditPoint
名称 pointTime suggestion String String 格式 时间点毫秒数 建议用户处理，取值范围：[“pass”, “review”, “block”], pass:图片正常，review：需要人工审核，block：图片违规，可以直接删除或者做限制处理 results array JSON数组，该时间点审核出的标签，JSON结构参见5.1.14附录-数据类型-AuditLabel 说明 AuditLabel
名称 confidence label String String 格式 置信度 当为鉴黄任务时取值：normal(正常图片，无色情),sexy(性感图片);porn（色情图片）。 当为涉政任务时取值:对应政治任务信息。 当为暴恐任务时取值:normal(正常)、knife(刀58
说明 视频云点播API接口调用规范
具)、gun(枪具)、fire(火) MediaFile
r名称 file mediaInfo JSON JSON 格式 说明 JSON对象，转码后生成的文件地址,，参见5.1.21附录-数据类型-FileInfo 文件媒体信息，当有分析到文件信息时包含该字段，参见5.1.16附录-数据类型-MediaInfo fileType String VIDEO:视频文件,AUDIO:音频文件,PIC:图片文件，当有分析到文件信息时包含该字段 MediaInfo
名称 general JSON 格式 说明 JSON对象，文件基本信息，参见5.1.17附录-数据类型-MediaInfoGeneral JSON对象，文件视频信息，当存在视频信息时video JSON 存在，参见5.1.18附录-数据类型-MediaInfoVideo JSON对象，文件音频信息，当存在音频信息时audio JSON 存在，参见5.1.19附录-数据类型-MediaInfoAudio pic JSON JSON对象，文件图片信息，当存在图片信息时存在，参见5.1.20附录-数据类型-MediaInfoPic MediaInfoGeneral
名称 format size 格式 String String 文件格式 文件大小 说明 MediaInfoVideo
名称 format size duration width height frameRate bitRate 格式 String String String String String String String 视频编码格式 视频文件大小 视频时长 视频分辨率：宽 视频分辨率：高 视频帧率 视频码率 说明 59
视频云点播API接口调用规范
MediaInfoAudio
名称 format size duration bitRate 格式 String String String String 音频编码格式 音频文件大小 音频时长 音频码率 说明 MediaInfoPic
名称 format size width height 格式 String String String String 图片格式 图片大小 图片分辨率：宽 图片分辨率：高 说明 FileInfo
名称 fileUrl 格式 String 文件地址 说明 MaterialFile
属性 materialName materialLength id title status thumbURL tags description uploadTime md5 cateId cateName requestId transcodeInfo snapshotInfo auditInfo 类型 String String String String String String String String String String String String String JSON JSON JSON 文件名称 文件的声明大小 视频Id 标题 SUCCESS:处理成功;FAILURE:处理失败;PROCESSING:处理中;DISABLE:停用 缩略图 标签 描述 时间格式：yyyy-MM-dd HH:mm:ss 文件的md5信息 分类ID 分类名称 请求ID JSON对象，如果有转码模版设置则包含该参数，参见5.1.7附录-数据类型-TranscodeInfo JSON对象，如果有截图模版设置则包含该参数，参见5.1.9附录-数据类型-SnapshotInfo JSON对象，如果有审核设置则包含该参数，参见5.1.1160
说明 视频云点播API接口调用规范
附录-数据类型-AuditPic mediaInfo fileInfo JSON JSON JSON对象，如果该文件分析成功则包含参数，参见5.1.16附录-数据类型-MediaInfo JSON对象，文件地址，参见5.1.21附录-数据类型-FileInfo TextWaterMark
属性 Content FontSize FontColor FontAlpha Top Left 类型 String int String float int int 文字水印内容 字体大小，默认16，范围：(4, 120) 字体颜色，取值参见5.3附件-FontColor列表 字体透明度，范围：(0, 1]，默认1 文本上边距，默认0，范围：[0,] 文本左边距，默认0，范围：[0,] 说明 CallbackConfig
属性 callBackUrl openFlag 类型 String String 是否开启回调 取值范围： close（关闭） open（开启） 说明 回调地址，目前不支持带参地址，不对地址的可用性进行校验 5.2 参数详情
转码模板配置详情
名称 transcodeTemplateId 格式 String 转码模版ID JSON数组，转码模板中设置的水waterMarkTemplates Array 印模板，JSON结构参考5.2.6附录-参数详情-waterMarkTemplates详情 否 说明 必填 是 水印模版配置详情
名称 格式 说明 水印内容的宽度，默认为水印源文件宽度 值有两种形式：整数型代水印内容宽的像素值，width Number 范围[8,4096]，单位px；小数型代表相对输出视频分辨率宽的比率，范围(0,1],支持4位小数，如0.9999，超出部分系统自动丢弃。 height Number 水印内容的高度，默认为水印源文件高度 61
必填 否 否 视频云点播API接口调用规范
值有两种形式：整数型代表水印图片高的像素值，范围[8,4096]，单位px；小数型代表相对输出视频分辨率高的比率，范围(0,1],支持4位小数，如0.9999，超出部分系统自动丢弃。 水印内容相对输出视频的水平偏移量，默认值是0；值有两种形式：整数型代表偏移像素，范围dx Number [0,4096]，单位px；小数型代表水平偏移量与输出分辨率宽的比率，范围(0,1),支持4位小数，如0.9999，超出部分系统自动丢弃，默认值为0。 水印内容相对输出视频的垂直偏移量，默认值是0；值有两种形式：整数型代表偏移像素，范围dy Number [0,4096]，单位px；小数型代表垂直偏移量与输出分辨率高的比率，范围(0,1),支持4位小数，如0.9999，超出部分系统自动丢弃，默认值为0。 水印的位置，值范围TopRight、TopLeft、referPos String BottomRight、BottomLeft，默认值为TopRight。 水印类型，Image、Text，默认为Image，type String Image:图片水印，Text:文字水印，若填写Text，则必须填写textWaterMark字段 imgUrl String 水印图片的地址（图片地址必须是通过文件上传接口返回的图片地址） JSON对象，水印文本，参见5.2.5附录-参数详textWaterMark JSON 情-文字水印TextWaterMark参数详情 文字水印的输出效果以该字段内的内容为准 timeline JSON JSON对象，动态水印，参见5.2.3附录-参数详情-水印Timeline详情,默认为空 否 否 否 否 否 否 否 水印Timeline详情
名称 start duration 格式 String String 字， 默认为0 水印持续时间， 取值范围[数字，ToEND], 默认为ToEND 说明 单位 秒， 水印开始出现时间， 取值范围 数必填 否 否 截图SnapshotConfig 详情
名称 格式 62
说明 必填 视频云点播API接口调用规范
截图间隔时间，单位秒，若指定则表示定时截interval String 图，interval必须大于0，优先于num参数生效。 num width height String String String 截图数量，若指定则表示定量截图，且必须大于0,当interval、num都没有值时使用首帧截图 截图输出图片宽度，单位px，范围[8,4096]，默认200，只支持整数 截图输出图片高度，单位px，范围[8,4096]，默认120，只支持整数 否 否 否 否 文字水印TextWaterMark参数详情
名称 Content FontSize FontColor FontAlpha Top Left String int String float int int 格式 文字水印内容 字体大小，默认16，范围：(4, 120) 字体颜色，默认为黑色，取值参见5.3附件-FontColor列表 字体透明度，范围：(0, 1]，默认1 文本上边距，默认0，范围：[0,] 文本左边距，默认0，范围：[0,] 说明 必填 是 否 否 否 否 否 waterMarkTemplates详情
名称 waterMarkTemplateId String 格式 水印模板Id 说明 必填 否 5.3 FontColor列表
FontColor名称 AliceBlue AntiqueWhite Aqua Aquamarine Azure Beige Bisque Black BlanchedAlmond Blue BlueViolet 对应16进制颜色 0xF0F8FF 0xFAEBD7 0x00FFFF 0x7FFFD4 0xF0FFFF 0xF5F5DC 0xFFE4C4 0x000000 0xFFEBCD 0x0000FF 0x8A2BE2 63 视频云点播API接口调用规范
Brown BurlyWood CadetBlue Chartreuse Chocolate Coral CornflowerBlue Cornsilk Crimson Cyan DarkBlue DarkCyan DarkGoldenRod DarkGray DarkGreen DarkKhaki DarkMagenta DarkOliveGreen Darkorange DarkOrchid DarkRed DarkSalmon DarkSeaGreen DarkSlateBlue DarkSlateGray DarkTurquoise DarkViolet DeepPink DeepSkyBlue DimGray DodgerBlue FireBrick FloralWhite ForestGreen Fuchsia Gainsboro GhostWhite 0xA52A2A 0xDEB887 0x5F9EA0 0x7FFF00 0xD2691E 0xFF7F50 0x6495ED 0xFFF8DC 0xDC143C 0x00FFFF 0x00008B 0x008B8B 0xB8860B 0xA9A9A9 0x006400 0xBDB76B 0x8B008B 0x556B2F 0xFF8C00 0x9932CC 0x8B0000 0xE9967A 0x8FBC8F 0x483D8B 0x2F4F4F 0x00CED1 0x9400D3 0xFF1493 0x00BFFF 0x696969 0x1E90FF 0xB22222 0xFFFAF0 0x228B22 0xFF00FF 0xDCDCDC 0xF8F8FF 64
视频云点播API接口调用规范
Gold GoldenRod Gray Green GreenYellow HoneyDew HotPink IndianRed Indigo Ivory Khaki Lavender LavenderBlush LawnGreen LemonChiffon LightBlue LightCoral LightCyan LightGoldenRodYellow LightGreen LightGrey LightPink LightSalmon LightSeaGreen LightSkyBlue LightSlateGray LightSteelBlue LightYellow Lime LimeGreen Linen Magenta Maroon MediumAquaMarine MediumBlue MediumOrchid MediumPurple 0xFFD700 0xDAA520 0x808080 0x008000 0xADFF2F 0xF0FFF0 0xFF69B4 0xCD5C5C 0x4B0082 0xFFFFF0 0xF0E68C 0xE6E6FA 0xFFF0F5 0x7CFC00 0xFFFACD 0xADD8E6 0xF08080 0xE0FFFF 0xFAFAD2 0x90EE90 0xD3D3D3 0xFFB6C1 0xFFA07A 0x20B2AA 0x87CEFA 0x778899 0xB0C4DE 0xFFFFE0 0x00FF00 0x32CD32 0xFAF0E6 0xFF00FF 0x800000 0x66CDAA 0x0000CD 0xBA55D3 0x9370D8 65
视频云点播API接口调用规范
MediumSeaGreen MediumSlateBlue MediumSpringGreen MediumTurquoise MediumVioletRed MidnightBlue MintCream MistyRose Moccasin NavajoWhite Navy OldLace Olive OliveDrab Orange OrangeRed Orchid PaleGoldenRod PaleGreen PaleTurquoise PaleVioletRed PapayaWhip PeachPuff Peru Pink Plum PowderBlue Purple Red RosyBrown RoyalBlue SaddleBrown Salmon SandyBrown SeaGreen SeaShell Sienna 0x3CB371 0x7B68EE 0x00FA9A 0x48D1CC 0xC71585 0x191970 0xF5FFFA 0xFFE4E1 0xFFE4B5 0xFFDEAD 0x000080 0xFDF5E6 0x808000 0x6B8E23 0xFFA500 0xFF4500 0xDA70D6 0xEEE8AA 0x98FB98 0xAFEEEE 0xD87093 0xFFEFD5 0xFFDAB9 0xCD853F 0xFFC0CB 0xDDA0DD 0xB0E0E6 0x800080 0xFF0000 0xBC8F8F 0x4169E1 0x8B4513 0xFA8072 0xF4A460 0x2E8B57 0xFFF5EE 0xA0522D 66
视频云点播API接口调用规范
Silver SkyBlue SlateBlue SlateGray Snow SpringGreen SteelBlue Tan Teal Thistle Tomato Turquoise Violet Wheat White WhiteSmoke Yellow YellowGreen 0xC0C0C0 0x87CEEB 0x6A5ACD 0x708090 0xFFFAFA 0x00FF7F 0x4682B4 0xD2B48C 0x008080 0xD8BFD8 0xFF6347 0x40E0D0 0xEE82EE 0xF5DEB3 0xFFFFFF 0xF5F5F5 0xFFFF00 0x9ACD32 第6章 预置转码模板：
注意：预置模板信息未能及时随文档更新，以查询转码模板接口返回信息为准。
普通转码模板 模板ID S001-0023 S001-0024 S001-0025 H001-0025 S001-0026 H001-0026 S001-0027 H001-0027 S001-0028 H001-0028 S001-0029 H001-0029 S002-0035 模板名 MP4 H264 120p MP4 H264流畅 270p MP4 H264流畅 360p MP4 H265流畅 360p MP4 H264标清 540p MP4 H265标清 540p MP4 H264高清 720p MP4 H265高清 720p MP4 H264超清 1080p MP4 H265超清 1080p MP4 H264 2K 1440p MP4 H265 2K 1440p FLV H264流畅 360p 容器 格式 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 MP4 FLV 67
容器 格式 H.264 H.264 H.264 H.265 H.264 H.265 H.264 H.265 H.264 H.265 H.264 H.265 H.264 视频码率 (Kbps) 80 300 500 400 800 500 1200 1200 2000 1700 2600 2300 500 音频码率 (Kbps) 32 32 32 32 64 64 96 96 128 128 128 128 32 分辨率-宽 160 480 640 640 960 960 1280 1280 1920 1920 2560 2560 640 视频云点播API接口调用规范
S002-0036 S002-0037 S002-0038 S002-0039 FLV H264标清 540p FLV H264高清 720p FLV H264超清 1080p FLV H264 2K 1440p FLV FLV FLV FLV H.264 H.264 H.264 H.264 800 1200 2000 2600 64 96 128 128 960 1280 1920 2560 感知增强高清模板 模板ID D001-0029 D001-0028 D001-0027 D001-0026 D001-0025 D002-0039 D002-0038 D002-0037 D002-0036 D002-0035 模板名 感知增强 MP4 h264 2K 1440p 感知增强 MP4 h264 超清 1080p 感知增强 MP4 h264 高清 720p 感知增强 mp4 h264 标清 540p 感知增强 mp4 h264 流畅 320p 感知增强 FLV h264 2K 1440p 感知增强 FLV h264 超清1080p 感知增强 FLV h264 高清 720p 感知增强 flv h264 标清 540p 感知增强 flv h264 流畅 360p 容器 格式 MP4 MP4 MP4 MP4 MP4 FLV FLV FLV FLV FLV 视频编码格式 H.264 H.264 H.264 H.264 H.264 H.264 H.264 H.264 H.264 H.264 视频码率音频码率分辨率-宽 2560 1920 1280 960 640 2560 1920 1280 960 640 (Kbps) (Kbps) 2300 1700 1200 500 400 2600 1700 1200 500 400 128 128 128 64 64 128 128 128 64 64 低转高模板 模板ID LTH001-0027 LTH001-0030 模板名 容器格式 视频编码格式 视频码率 (Kbps) 6000 20000 6000 20000 音频码率 (Kbps) 128 128 128 128 分辨率-宽 1280 3840 1280 1280 LowToHigh-SD_HD 720p MP4 H.264 LowToHigh-2k-4k 2160p MP4 H.264 MP4 H.264 LTH001-F06027 LowToHigh-60Fps 720p LTH001-F12027 LowToHigh-120Fps 720p MP4 H.264 68
视频云点播API接口调用规范
音视频抽离模板 模板ID 模板名 中文名 容器格式 视频码率 (Kbps) - - 音频码率 (Kbps) - - - - 分辨率-宽 VS001-0001 视音频抽离-视频 AS001-0001 视音频抽离-音频 视音频抽离-视频 MP4 视音频抽离-音频 MP4
竖屏转码模板 模板ID V001-0025 V001-0026 V001-0027 模板名 容器 格式 视频编码 格式 H.264 H.265 H.264 H.265 H.264 H.265 H.264 H.265 H.264 H.264 H.264 H.264 视频码率 (Kbps) 500 400 800 500 1200 1200 2000 1700 500 800 1200 2000 音频码率 (Kbps) 32 32 64 64 96 96 128 128 32 64 96 128 分辨率-宽 360 360 540 540 720 720 1080 1080 360 540 720 1080 MP4 H264流畅 360p 竖屏 MP4 MP4 H264标清 540p 竖屏 MP4 MP4 H264高清 720p 竖屏 MP4 MP4 H264超清 1080p 竖屏 MP4 H265超清 1080p 竖屏 FLV H264流畅 360p 竖屏 FLV H264标清 540p 竖屏 FLV H264高清 720p 竖屏 HV001-0025 MP4 H265流畅 360p 竖屏 MP4 HV001-0026 MP4 H265标清 540p 竖屏 MP4 HV001-0027 MP4 H265高清 720p 竖屏 MP4 V001-0028 HV001-0028 V002-0025 V002-0026 V002-0027 V002-0028 MP4 MP4 FLV FLV FLV FLV H264超清 1080p 竖屏 FLV 音频模板 模板ID S003-0011 模板名 MP3 64Kbps 容器格式 MP3 音频码率 (Kbps) 64 采样率 48000 声道数 2 第7章 附录：
代码 0 1 2 10001 success fail processing input Parameter Invalid 69
描述 操作成功 处理失败 处理中 说明 输入参数不合法 视频云点播API接口调用规范
10002 10003 10004 10005 10006 10007 10008 10009 10010 20001 20002 20003 20004 20005 20006 30001 30002 30003 30004 30005 30006 30007 30008 30009 30010 30011 30012 30013 30014 40001 inner Error unknow Error query Error modify The Error delete The Error insert The Error 注册用户失败 获取用户失败 No access 分类不存在 等级超过3级 子类型超过200个 分类名称过长 时间类型参数有误 开始时间不能晚于结束时间 资源不存在 资源标识为空 根据token没有找到文件 token无效 文件的MD5不相等 接口IO异常 接口上传文件异常 文件名称有误，需加后缀 文件大小有误 描述过长 没有接收到流 非法的时间戳 非法的模板标识 不支持的文件格式 播放地址不存在 系统内部错误 未知错误 查询失败 修改失败 删除失败 添加失败 注册用户失败 获取用户失败 没有操作权限或操作对象不存在 分类不存在 等级超过3级 子类型超过200个 分类名称过长 时间类型参数有误 开始时间不能晚于结束时间 资源不存在 资源标识为空 根据token没有找到文件 token无效 文件的MD5不相等 接口IO异常 接口上传文件异常 文件名称有误，需加后缀 文件大小有误 描述最长不超过512个字符 没有接收到流 非法的时间戳 非法的模板标识 不支持的文件格式 播放地址不存在 70
因篇幅问题不能全部显示，请点此查看更多更全内容
Copyright © 2019- stra.cn 版权所有 赣ICP备2024042791号-4
违法及侵权请联系：TEL:199 1889 7713 E-MAIL:2724546146@qq.com
本站由北京市万商天勤律师事务所王兴未律师提供法律服务