當(dāng)前位置：首頁(yè) > 编程资源 > 编程问答 >内容正文

编程问答

云信api_服务端API文档

發(fā)布時(shí)間：2024/8/1 编程问答 31 豆豆

生活随笔收集整理的這篇文章主要介紹了云信api_服务端API文档小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

點(diǎn)播服務(wù)端API文檔

1 調(diào)用方式

1.1 請(qǐng)求說(shuō)明

1.1.1 服務(wù)地址

網(wǎng)易視頻云點(diǎn)播服務(wù)使用的域名訪問(wèn)地址為：vcloud.163.com。

1.1.2 通信協(xié)議

網(wǎng)易視頻云點(diǎn)播服務(wù)的所有接口均通過(guò)HTTPS進(jìn)行通信，提供高安全性的通信通道。

重要提示：獲取上傳加速節(jié)點(diǎn)和斷點(diǎn)續(xù)傳查詢斷點(diǎn)接口除外，只支持HTTP通信。

1.1.3 請(qǐng)求方法

所有接口都只支持POST請(qǐng)求。

重要提示：獲取上傳加速節(jié)點(diǎn)和斷點(diǎn)續(xù)傳查詢斷點(diǎn)接口除外，為GET請(qǐng)求。

1.1.4 字符編碼

所有接口均使用UTF-8編碼。

1.2 公共參數(shù)

所有接口均需要放置以下公共參數(shù)在請(qǐng)求頭中，用于標(biāo)識(shí)用戶和接口鑒權(quán)。后續(xù)的接口說(shuō)明不再對(duì)這些參數(shù)進(jìn)行說(shuō)明，但每次發(fā)起請(qǐng)求均需要攜帶。

參數(shù)

類型

必須

說(shuō)明

AppKey

String

是

開(kāi)發(fā)者平臺(tái)分配的AppKey

Nonce

String

是

隨機(jī)數(shù)(隨機(jī)數(shù)，最大長(zhǎng)度128個(gè)字符)

CurTime

String

是

當(dāng)前UTC時(shí)間戳，從1970年1月1日0點(diǎn)0分0秒開(kāi)始到現(xiàn)在的秒數(shù)

CheckSum

String

是

服務(wù)器認(rèn)證需要，SHA1(AppSecret+Nonce+CurTime)，16進(jìn)制字符小寫

重要提示：獲取上傳加速節(jié)點(diǎn)、文件數(shù)據(jù)上傳、斷點(diǎn)續(xù)傳查詢斷點(diǎn)三個(gè)接口，不使用上述公共參數(shù)。

1.3 接口鑒權(quán)

接口通過(guò)請(qǐng)求頭中的公共參數(shù)進(jìn)行鑒權(quán)。登錄網(wǎng)易云控制臺(tái)，點(diǎn)擊應(yīng)用名稱 > 右側(cè)[App Key管理]，即可查看AppKey和AppSecret，通過(guò)該安全憑證進(jìn)行SHA1(AppSecret+Nonce+CurTime)計(jì)算。

重要提示: 本文檔中提供的所有接口均面向開(kāi)發(fā)者服務(wù)器端調(diào)用，用于計(jì)算CheckSum的AppSecret開(kāi)發(fā)者應(yīng)妥善保管,可在應(yīng)用的服務(wù)器端存儲(chǔ)和使用，但不應(yīng)存儲(chǔ)或傳遞到客戶端，也不應(yīng)在網(wǎng)頁(yè)等前端代碼中嵌入。

計(jì)算CheckSum的java代碼舉例如下：

import java.security.MessageDigest;

public class CheckSumBuilder {

public static String getCheckSum(String appSecret, String nonce, String curTime){

return encode("sha1", appSecret + nonce + curTime);

}

private static String encode(String algorithm, String value){

if (value == null) {

return null;

}

try {

MessageDigest messageDigest = MessageDigest.getInstance(algorithm);

messageDigest.update(value.getBytes());

return getFormattedText(messageDigest.digest());

} catch (Exception e) {

throw new RuntimeException(e);

}

private static String getFormattedText(byte[] bytes){

int len = bytes.length;

StringBuilder buf = new StringBuilder(len * 2);

for (int j = 0; j < len; j++) {

buf.append(HEX_DIGITS[(bytes[j] >> 4) & 0x0f]);

buf.append(HEX_DIGITS[bytes[j] & 0x0f]);

}

return buf.toString();

}

private static final char[] HEX_DIGITS = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };

}

1.4 返回說(shuō)明

所有接口返回類型為JSON。返回字段如下：

名稱

類型

說(shuō)明

code

Int

返回結(jié)果的狀態(tài)碼

ret

String

返回的結(jié)果集

msg

String

當(dāng)返回結(jié)果的狀態(tài)碼不為200時(shí)，包含的錯(cuò)誤信息

重要提示：獲取上傳加速節(jié)點(diǎn)、文件數(shù)據(jù)上傳、斷點(diǎn)續(xù)傳查詢斷點(diǎn)三個(gè)接口除外。

1.5 接口頻率說(shuō)明

目前每個(gè)接口頻率限制為80次/秒。

2 調(diào)用流程

3 文件上傳

文件上傳模塊主要展示通過(guò)服務(wù)端API進(jìn)行文件上傳的API調(diào)用、回調(diào)和代碼示例(含斷點(diǎn)續(xù)傳)。除服務(wù)端API調(diào)用上傳外，也可通過(guò)登錄控制臺(tái)進(jìn)行網(wǎng)頁(yè)上傳，或接入上傳SDK進(jìn)行上傳。

3.1 文件上傳初始化

3.1.1 接口描述

域名：vcloud.163.com

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

用于文件上傳的初始化，獲取xNosToken(上傳憑證)、bucket(存儲(chǔ)對(duì)象的桶名)、object(生成的唯一對(duì)象名)。

3.1.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

originFileName

String

是

上傳文件的原始名稱(包含后綴名)

userFileName

String

否

用戶命名的上傳文件名稱

typeId

Int

否

視頻所屬的類別Id(不填寫為默認(rèn)分類)

presetId

Int

否

視頻所需轉(zhuǎn)碼模板Id(不填寫為默認(rèn)模板，默認(rèn)模板不進(jìn)行轉(zhuǎn)碼)

uploadCallbackUrl

String

否

上傳成功后回調(diào)客戶端的URL地址(需標(biāo)準(zhǔn)http格式)

callbackUrl

String

否

轉(zhuǎn)碼成功后回調(diào)客戶端的URL地址(需標(biāo)準(zhǔn)http格式)

description

String

否

上傳視頻的描述信息

watermarkId

Int

否

視頻水印Id(不填寫為不添加水印，如果選擇，

請(qǐng)務(wù)必在水印管理中提前完成水印圖片的上傳和參數(shù)的配置；

且必需設(shè)置prestId字段，且presetId字段不為默認(rèn)模板)

userDefInfo

String

否

用戶自定義信息，回調(diào)會(huì)返回此信息(長(zhǎng)度不能超過(guò)256字符)

transOffset

Int

否

視頻轉(zhuǎn)碼處理裁剪視頻的起始位置(單位：秒)

transDuration

Int

否

視頻轉(zhuǎn)碼處理裁剪視頻的視頻時(shí)長(zhǎng)(單位：秒)

3.1.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

xNosToken

String

上傳憑證

bucket

String

存儲(chǔ)上傳文件的桶名

object

String

存儲(chǔ)上傳文件的對(duì)象名

msg

String

錯(cuò)誤信息

3.1.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

3.1.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"originFileName":"love.mp4","userFileName":"for_love.mp4","typeId":20,"presetId":20,"description":"for love","wartermarkId":20}' https://vcloud.163.com/app/vod/upload/init

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"code" : 200,

"ret" : {

"xNosToken" : "UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=",

"bucket" : "vodk32ywxdf",

"object" : "d37906a7-0119-4dd9-820d-4c66a71952ad.mp4"

}

3.2 獲取上傳加速節(jié)點(diǎn)地址

3.2.1 接口描述

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

用于獲取上傳加速節(jié)點(diǎn)地址。

3.2.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

version

String

是

API版本號(hào)，填寫固定值1.0

bucketname

String

是

存儲(chǔ)上傳文件的桶名，可在視頻上傳初始化接口的返回參數(shù)bucket獲取

3.2.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

lbs

String

httpDNS的IP訪問(wèn)地址，用于避免后續(xù)查詢的DNS解析時(shí)間、以及域名劫持

upload

List

上傳節(jié)點(diǎn)列表(前面的優(yōu)先級(jí)高)

3.2.4 響應(yīng)狀態(tài)碼

參數(shù)

類型

說(shuō)明

Code

String

錯(cuò)誤代碼

Message

String

錯(cuò)誤描述信息

3.2.5 示例代碼

輸入1

curl -X GET http://wanproxy.127.net/lbs?version=1.0&bucketname=vodk32ywxdf

輸出1

{"lbs":"http://223.252.196.39/lbs","upload"：["http://223.252.216.48","http://223.252.216.49"]}

3.3 文件數(shù)據(jù)上傳

上傳一塊數(shù)據(jù)，此接口通過(guò)指定offset實(shí)現(xiàn)斷點(diǎn)續(xù)傳功能。用戶每次上傳要以服務(wù)器端返回的offset為準(zhǔn)續(xù)傳余下數(shù)據(jù)。

需注意以下事項(xiàng)：

大文件需要自行分片上傳，分片大小不超過(guò)4MB，請(qǐng)求相同接口，注意參數(shù)的填寫。

如果需要斷點(diǎn)續(xù)傳，需保存 context 值，根據(jù) context 值查詢斷點(diǎn)值，然后繼續(xù)使用此接口。

包體數(shù)據(jù)為二進(jìn)制數(shù)據(jù)。

3.3.1 接口描述

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

重要提示：{UploadHost}值為獲取的上傳加速節(jié)點(diǎn)地址，{bucket}值為存儲(chǔ)對(duì)象的桶名，{object}值為生成的唯一對(duì)象名。

3.3.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

x-nos-token

String

是

請(qǐng)求頭參數(shù)，上傳token

Content-Length

long

否

請(qǐng)求頭參數(shù)，當(dāng)前片的內(nèi)容長(zhǎng)度，

單位：字節(jié)(Byte)。Content-Length合法值是[0~4M]，

否則返回400 httpcode給客戶端，拒絕本次請(qǐng)求

Content-Type

String

否

請(qǐng)求頭參數(shù)，標(biāo)準(zhǔn)http頭。表示請(qǐng)求內(nèi)容的類型，

比如：image/jpeg。僅第一次上傳生效，續(xù)傳不生效

Content-MD5

String

否

請(qǐng)求頭參數(shù)，文件內(nèi)容md5值

bucket

String

是

存儲(chǔ)對(duì)象的桶名

object

String

是

生成的唯一對(duì)象名

offset

long

是

當(dāng)前分片在整個(gè)對(duì)象中的起始偏移量，單位：字節(jié)(Byte)

complete

String

是

是否為最后一塊數(shù)據(jù)。合法值：true/false

version

String

是

http api版本號(hào)。這里是固定值1.0

context

String

是

上傳上下文。本字段是只能被上傳服務(wù)器解讀使用的不透明字段，

上傳端不應(yīng)修改其內(nèi)容。

注意：用戶第一次上傳應(yīng)不帶此參數(shù)或置為空字符串，

之后上傳剩余部分?jǐn)?shù)據(jù)都需要帶上這個(gè)參數(shù)。

context對(duì)應(yīng)的桶名或者對(duì)象名不匹配返回400 code

3.3.3 輸出參數(shù)

3.3.3.1 響應(yīng)成功輸出參數(shù)

參數(shù)

類型

必須

說(shuō)明

requestId

String

是

uuid字符串，服務(wù)器端生成的唯一UUID

offset

long

是

下一個(gè)上傳片在上傳塊中的偏移。

注意：偏移從0開(kāi)始，比如：用戶上傳0-128字節(jié)后，

服務(wù)器返回的offset為128，下一次上傳offset值應(yīng)置為128

context

String

是

上傳上下文

callbackRetMsg

String

是

上傳回調(diào)信息

3.3.3.2 響應(yīng)失敗輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

uuid字符串，服務(wù)器端生成的唯一UUID

errMsg

String

錯(cuò)誤描述信息

3.3.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

上傳分片成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

403

上傳憑證無(wú)效。token過(guò)期服務(wù)器會(huì)返回此狀態(tài)碼，用戶需要重新申請(qǐng)token

500

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

520

回調(diào)失敗

3.3.5 示例代碼

輸入1

curl -X POST -H "Content-Length: 4194304" -H "x-nos-token: UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=" -d'[本次上傳視頻文件二進(jìn)制內(nèi)容數(shù)據(jù)]' "http://223.252.216.49/vodk32ywxdf/d37906a7-0119-4dd9-820d-4c66a71952ad.mp4?offset=0&complete=false&version=1.0"

輸出1

{

"requestId":"be82c2a0dffc000000005770a189d831",

"offset":4194304,

"context":"f3e26818-83c3-5a21-6ee4-39ff47af21c7",

"callbackRetMsg":""

}

3.4 斷點(diǎn)續(xù)傳查詢斷點(diǎn)

根據(jù)上傳上下文查詢對(duì)應(yīng)分片上傳當(dāng)前續(xù)傳的offset，上下文要與bucketName/objectName匹配，否則返回400狀態(tài)碼。(bucketName和objectName要進(jìn)行URL編碼,字符編碼格式使用utf-8)。

3.4.1 接口描述

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

重要提示：{UploadHost}值為獲取的上傳加速節(jié)點(diǎn)地址，{bucket}值為存儲(chǔ)對(duì)象的桶名，{object}值為生成的唯一對(duì)象名。

3.4.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

x-nos-token

String

是

上傳token

bucketName

String

是

存儲(chǔ)對(duì)象的桶名

objectName

String

是

生成的唯一對(duì)象名

context

String

是

上傳上下文。本字段是只能被上傳服務(wù)器解讀使用的不透明字段，

上傳端不應(yīng)修改其內(nèi)容。對(duì)應(yīng)context在服務(wù)端不存在則返回404。

context對(duì)應(yīng)的桶名或者對(duì)象名不匹配返回400 code。

version

String

是

http api版本號(hào)。這里是固定值1.0

3.4.3 輸出參數(shù)

3.4.3.1 響應(yīng)成功輸出參數(shù)

參數(shù)

類型

必須

說(shuō)明

requestId

String

是

uuid字符串，服務(wù)器端生成的唯一UUID，用于記錄日志排查問(wèn)題使用

offset

long

是

下一個(gè)上傳片在上傳塊中的偏移

3.4.3.2 響應(yīng)失敗輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

uuid字符串，服務(wù)器端生成的唯一UUID

errMsg

String

錯(cuò)誤描述信息

3.4.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

上傳分片成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

403

上傳憑證無(wú)效。token過(guò)期服務(wù)器會(huì)返回此錯(cuò)誤碼，用戶需要重新申請(qǐng)token

500

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

404

對(duì)應(yīng)context上傳不存在

3.4.5 示例代碼

輸入1

curl -X GET -H "x-nos-token: UPLOAD ab1856bb39044591939d7b94e1b8e5ee:n5VKrOLVFkLM7JIBDaCyPjzVKswqfxBZak2U2fXh0xM=:eyJCdWNrZXQiOiJ2b2RrMzJ5d3hkZiIsIk9iamVjdCI6ImEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEciLCJFeHBpcmVzIjoxNDY5NTg3NTc5LCJDYWxsYmFja1VybCI6Imh0dHA6Ly8xMDYuMi40NC4yNDgveGhyL3ZvZC9ub3MvY2FsbGJhY2siLCJDYWxsYmFja0JvZHkiOiJmaWxlTmFtZT10ZXN0LkpQRyZvYmplY3ROYW1lPWEzM2U1MmQ3LTUxZGMtNDZhNS1iMTFlLWFiNmMyMmJiOTk2ZC5KUEcmJChPYmplY3RTaXplKSZ1aWQ9MjQxMzMmdHlwZUlkPTAmcHJlc2V0SWQ9MCZ3YXRlcm1hcmtJZHM9bnVsbCZkZXNjcmlwdGlvbj1udWxsJnZpZGVvQ2FsbGJhY2s9bnVsbCYkKEFWaW5mby5WaWRlby5EdXJhdGlvbikmJChBVmluZm8uVmlkZW8uSGVpZ2h0KSYkKEFWaW5mby5WaWRlby5XaWR0aCkmMCYwJjAmbnVsbCZ1cGxvYWRTdGFydD0xNDY2OTk1NTc5NjU4In0=" "http://223.252.216.49/vodk32ywxdf/d37906a7-0119-4dd9-820d-4c66a71952ad.mp4?uploadContext&context=f3e26818-83c3-5a21-6ee4-39ff47af21c7&version=1.0"

輸出1

{

"requestId":"be82c2a0dffc000000005770a189d832",

"offset":4194304

}

3.5 上傳完成根據(jù)對(duì)象名查詢視頻或水印圖片主Id

3.5.1 接口描述

域名：vcloud.163.com

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

用于視頻或水印上傳完成后查詢主Id。

3.5.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

objectNames

List

是

上傳文件的對(duì)象名列表

3.5.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

list

List

對(duì)象名和視頻Id對(duì)應(yīng)的列表

list.vid

Long

視頻主Id

list.imgId

Int

視頻水印圖片Id

list.objectName

String

存儲(chǔ)上傳文件的對(duì)象名

msg

String

錯(cuò)誤信息

3.5.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

3.5.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"objectNames":["33cf71b1-86ac-4555-a071-d70db07b9685.mp4"]}' https://vcloud.163.com/app/vod/video/query

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"code" : 200,

"ret" : {

list : [

{

"objectName" : "33cf71b1-86ac-4555-a071-d70db07b9685.mp4",

"vid" : 1008

}

]

}

3.6 設(shè)置上傳回調(diào)地址

3.6.1 上傳回調(diào)說(shuō)明

網(wǎng)易視頻云點(diǎn)播的上傳回調(diào)通知分為單個(gè)級(jí)別和用戶級(jí)別，且處理優(yōu)先級(jí)為：單個(gè)級(jí)別->用戶級(jí)別->無(wú)回調(diào)。當(dāng)用戶設(shè)置了單個(gè)級(jí)別的回調(diào)地址，使用單個(gè)級(jí)別的回調(diào)地址；否則查詢是否設(shè)置用戶級(jí)別的回調(diào)地址，如果設(shè)置，使用用戶級(jí)別的回調(diào)地址；否則不回調(diào)通知。單個(gè)級(jí)別的回調(diào)通知在上傳初始化中指定，用戶級(jí)別的回調(diào)通知可通過(guò)本接口設(shè)置。

回調(diào)通知會(huì)在請(qǐng)求頭中增加sign字段，其值為拼接回調(diào)包體內(nèi)容的字符串和簽名字符串，然后對(duì)拼接后的字符串進(jìn)行md5加密(32位小寫)。簽名字符串可通過(guò)本接口設(shè)置，默認(rèn)為：vcloud。

目前網(wǎng)易視頻云點(diǎn)播支持上傳成功回調(diào)通知。

3.6.2 接口描述

域名：vcloud.163.com

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

用于視頻上傳，設(shè)置上傳成功后的回調(diào)地址。

3.6.3 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

callbackUrl

String

是

上傳成功后回調(diào)客戶端的URL地址

signKey

String

否

上傳成功后回調(diào)客戶端的簽名字符串，要求是由字母和數(shù)字組成且不超過(guò)32位

3.6.4 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

3.6.5 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

3.6.6 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/upload/setcallback

輸出1

{

"msg" : "",

"code" : 200

}

3.6.7 回調(diào)內(nèi)容示例

{"name":"snow.mp4","origAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/b3d259f4-a7bc-4119-ae24-60e0eb09216e.mp4","type":"upload","vid":1022,"user_defined":"userId=123456"}。

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，上傳回調(diào)固定為“upload”

vid

Long

視頻文件標(biāo)識(shí)

name

String

視頻文件名稱(上傳時(shí)指定視頻名稱)

origAddr

String

視頻的播放地址

warnning

String

視頻類型檢測(cè)結(jié)果，比如視頻類型和上傳指定不一致，mp4和flv類型的視頻不適合流媒體播放拖動(dòng)等

user_defined

String

用戶自定義字段值(上傳時(shí)設(shè)置的值)

4 視頻轉(zhuǎn)碼

視頻轉(zhuǎn)碼模塊主要展示轉(zhuǎn)碼相關(guān)的API調(diào)用和代碼示例。包含轉(zhuǎn)碼模板的管理、水印模板的管理、視頻轉(zhuǎn)碼及回調(diào)等功能。

4.1 創(chuàng)建視頻轉(zhuǎn)碼模板

4.1.1 接口描述

域名：vcloud.163.com

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

用于視頻文件轉(zhuǎn)碼，創(chuàng)建模板。可使用視頻云的默認(rèn)格式模板或自定義格式參數(shù)。

4.1.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

presetName

String

是

視頻轉(zhuǎn)碼模板的名稱

sdMp4

Int

是

流暢Mp4格式(1表示選擇，0表示不選擇)

hdMp4

Int

是

標(biāo)清Mp4格式(1表示選擇，0表示不選擇)

shdMp4

Int

是

高清Mp4格式(1表示選擇，0表示不選擇)

copyMp4

Int

否

使用copy模式轉(zhuǎn)碼成Mp4格式(1表示選擇，0表示不選擇)

sdFlv

Int

是

流暢Flv格式(1表示選擇，0表示不選擇)

hdFlv

Int

是

標(biāo)清Flv格式(1表示選擇，0表示不選擇)

shdFlv

Int

是

高清Flv格式(1表示選擇，0表示不選擇)

copyFlv

Int

否

使用copy模式轉(zhuǎn)碼成Flv格式(1表示選擇，0表示不選擇)

sdHls

Int

是

流暢Hls格式(1表示選擇，0表示不選擇)

hdHls

Int

是

標(biāo)清Hls格式(1表示選擇，0表示不選擇)

shdHls

Int

是

高清Hls格式(1表示選擇，0表示不選擇)

copyHls

Int

否

使用copy模式轉(zhuǎn)碼成Hls格式(1表示選擇，0表示不選擇)

aacAudio

Int

否

aac音頻格式(1表示選擇，0表示不選擇)

mp3Audio

Int

否

mp3音頻格式(1表示選擇，0表示不選擇)

transConfig

List

否

自定義模板信息，不設(shè)置為系統(tǒng)默認(rèn)轉(zhuǎn)碼信息

transConfig參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

必須

說(shuō)明

presetType

Int

是

自定義模板格式：1表示sdMp4，2表示hdMp4，3表示shdMp4，4表示sdFlv，5表示hdFlv，6表示shdFlv，7表示sdHls，8表示hdHls，9表示shdHls，16表示aac，17表示mp3

video

String

否

視頻流配置，JSON對(duì)象，見(jiàn)參數(shù)video詳情，若不設(shè)置表示轉(zhuǎn)碼為純音頻格式，對(duì)應(yīng)presetType為16或17

audio

String

否

音頻流配置，JSON對(duì)象，見(jiàn)參數(shù)audio詳情

segmentTime

Int

否

hls格式的分片時(shí)長(zhǎng)，取值范圍：1-60，presetType為7、8、9時(shí)有效

textMarks

List

否

文字水印配置信息列表，JSON對(duì)象，見(jiàn)參數(shù)textMarks詳情

參數(shù)video詳情

參數(shù)

類型

必須

說(shuō)明

codec

String

否

輸出文件的視頻編解碼格式，包含：libx264，lib265，默認(rèn)是libx264。其中l(wèi)ib265僅支持mp4和hls格式

bitRate

String

否

輸出文件的視頻碼率，單位為bps。可設(shè)置值為auto或大于0的整數(shù)，默認(rèn)是auto。auto表示跟隨源視頻碼率

frameRate

String

否

輸出文件的視頻幀率，單位fps。可設(shè)置值為：auto、大于0，默認(rèn)值為auto，auto表示跟隨源視頻幀率

maxWidth

String

否

輸出文件的視頻寬度，單位px。可設(shè)置值為：auto、0、[128,4096]，默認(rèn)值為auto，auto表示跟隨源視頻寬度，0表示保持視頻寬高比的前提下，縮放視頻使得視頻高度等于maxHeight，注：此情況下，paddingPolicy必需是NoPad，maxHeight不能為0

maxHeight

String

否

輸出文件的視頻高度，可設(shè)置值為：auto、0、[128,4096]，默認(rèn)值為auto，auto表示跟隨源視頻高度，0表示保持視頻寬高比的前提下，縮放視頻使得視頻寬度等于maxWidth，注：此情況下，paddingPolicy必需是NoPad，maxWidth不能為0

paddingPolicy

String

否

輸出文件的縮放策略，輸出視頻若不能覆蓋maxWidth*maxHeight區(qū)域，是否通過(guò)填補(bǔ)黑邊將視頻擴(kuò)充到目標(biāo)大小。可設(shè)置值為：NoPad、Pad，NoPad表示不填補(bǔ)黑邊，Pad表示填補(bǔ)黑邊

參數(shù)audio詳情

參數(shù)

類型

必須

說(shuō)明

codec

String

否

輸出文件的音頻編解碼格式，包含：aac、mp3,默認(rèn)是aac

bitRate

String

否

輸出文件的音頻碼率，單位為bps。可設(shè)置值為：32000、64000、92000、128000、192000、256000、auto，默認(rèn)是auto。auto表示跟隨源音頻碼率

sampleRate

String

否

輸出文件的音頻采樣率，單位為Hz。可設(shè)置值為：8000、11025、22050、32000、44100、48000、96000、auto，默認(rèn)值是auto，auto表示跟隨源音頻采樣率。注：若視頻容器格式為flv，音頻編解碼格式選擇為mp3時(shí)，采樣率只能設(shè)置為44100或22050或11025

channel

String

否

輸出文件的音頻聲道數(shù)，可設(shè)置值為：1、2、auto。默認(rèn)值是auto，auto表示跟隨源音頻聲道數(shù)

參數(shù)textMarks詳情

參數(shù)

類型

必須

說(shuō)明

content

String

是

文字內(nèi)容

fontName

String

是

字體名字，目前支持：

(1) pingfang_bold (2) pingfang_light (3) pingfang_medium (4) pingfang_regular

fontSize

Int

否

字體大小，單位px，默認(rèn)值是24

fontColor

String

否

文字顏色，取值#000000~#FFFFFF，默認(rèn)值是#FFFFFF

fontOpacity

Float

否

文字透明度，取值范圍0.0～1.0，0.0透明，1.0不透明，默認(rèn)值是1.0

coordinate

String

否

相對(duì)于視頻左上角的位置，支持兩種格式：

(1)相對(duì)于左上角的絕對(duì)位置(單位px)：如5_5

(2)相對(duì)于左上角的相對(duì)位置：如5%_5%

默認(rèn)值是5%_5%

shadowX

Int

否

文字陰影x軸偏移量，單位px，默認(rèn)是0

shadowY

Int

否

文字陰影y軸偏移量，單位px，默認(rèn)是0

borderWidth

Int

否

文字邊框?qū)挾?#xff0c;單位px，默認(rèn)是0

borderColor

String

否

文字邊框顏色，取值#000000~#FFFFFF，默認(rèn)值是#FFFFFF

borderOpacity

Double

否

文字邊框透明度，取值范圍0.0～1.0，0.0透明，1.0不透明，默認(rèn)值是1.0

4.1.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

presetId

Int

新生成的視頻轉(zhuǎn)碼模板Id

msg

String

錯(cuò)誤信息

4.1.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.1.5 示例代碼

使用視頻云默認(rèn)的格式模板請(qǐng)求示例

輸入1

輸出1

{

"ret": {

"presetId": 184

"code": 200

}

使用自定義的格式參數(shù)請(qǐng)求示例

輸入2

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"presetName":"自定義流暢轉(zhuǎn)碼模板","sdMp4":1,"hdMp4":0,"shdMp4":0,"sdFlv":0,"hdFlv":0,"shdFlv":0,"sdHls":0,"hdHls":0,"shdHls":0,"transConfig":[{"presetType":1,"video":{"codec":"libx264","maxWidth":"640","MaxHeight":"0","bitRate":"600000","paddingPolicy":"NoPad"},"audio":{"codec":"aac","sampleRate":"44100","channel":"auto","bitRate":"128000"},"textMarks":[{"content":"網(wǎng)易視頻云","fontName":"pingfang_bold","fontSize":24,"fontColor":"#FFFFFF","fontOpacity":1.0,"coordinate":"5%_5%","shadowX":0,"shadowY":0,"borderWidth":1,"borderColor":"#000000","borderOpacity":1.0}]}]}' https://vcloud.163.com/app/vod/preset/create

輸出2

{

"ret": {

"presetId": 185

"code": 200

}

4.2 獲取視頻轉(zhuǎn)碼模板信息

4.2.1 接口描述

域名：vcloud.163.com

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

獲取單個(gè)視頻轉(zhuǎn)碼模板信息，包括：Id、視頻轉(zhuǎn)碼模板名稱、視頻轉(zhuǎn)碼模板對(duì)應(yīng)的格式。

4.2.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

presetId

Int

是

視頻轉(zhuǎn)碼模板Id

4.2.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

presetName

String

視頻轉(zhuǎn)碼模板的名稱

sdMp4

Int

流暢Mp4格式(1表示包含，0表示不包含)

hdMp4

Int

標(biāo)清Mp4格式(1表示包含，0表示不包含)

shdMp4

Int

高清Mp4格式(1表示包含，0表示不包含)

sdFlv

Int

流暢Flv格式(1表示包含，0表示不包含)

hdFlv

Int

標(biāo)清Flv格式(1表示包含，0表示不包含)

shdFlv

Int

高清Flv格式(1表示包含，0表示不包含)

sdHls

Int

流暢Hls格式(1表示包含，0表示不包含)

hdHls

Int

標(biāo)清Hls格式(1表示包含，0表示不包含)

shdHls

Int

高清Hls格式(1表示包含，0表示不包含)

aacAudio

Int

aac音頻格式(1表示選擇，0表示不選擇)

mp3Audio

Int

mp3音頻格式(1表示選擇，0表示不選擇)

isDel

Int

是否允許被刪除(默認(rèn)模板不允許刪除)，1：允許，0：不允許

transConfig

List

自定義模板信息，JSON對(duì)象，如果模板為自定義，則包含此元素

msg

String

錯(cuò)誤信息

4.2.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.2.5 示例代碼

輸入1

輸出1

{

"ret": {

"sdHls": 0,

"isDel": 1,

"shdHls": 0,

"hdHls": 1,

"presetId": 184,

"sdMp4": 0,

"sdFlv": 0,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "全高清",

"hdFlv": 1,

"hdMp4": 1

"code": 200

}

4.3 獲取視頻轉(zhuǎn)碼模板列表

4.3.1 接口描述

域名：vcloud.163.com

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

獲取視頻轉(zhuǎn)碼模板列表，并做分頁(yè)返回處理。單個(gè)視頻轉(zhuǎn)碼模板的信息包括：Id、視頻轉(zhuǎn)碼模板名稱、視頻轉(zhuǎn)碼模板對(duì)應(yīng)的格式。

4.3.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

currentPage

Int

是

獲取視頻轉(zhuǎn)碼模板列表分頁(yè)后的索引

pageSize

Int

是

獲取視頻轉(zhuǎn)碼模板列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

4.3.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取視頻轉(zhuǎn)碼模板列表的數(shù)目

list

List

獲取的視頻轉(zhuǎn)碼模板列表

list.presetId

Int

視頻轉(zhuǎn)碼模板Id

list.presetName

String

視頻轉(zhuǎn)碼模板的名稱

list.sdMp4

Int

流暢Mp4格式(1表示包含，0表示不包含)

list.hdMp4

Int

標(biāo)清Mp4格式(1表示包含，0表示不包含)

list.shdMp4

Int

高清Mp4格式(1表示包含，0表示不包含)

list.sdFlv

Int

流暢Flv格式(1表示包含，0表示不包含)

list.hdFlv

Int

標(biāo)清Flv格式(1表示包含，0表示不包含)

list.shdFlv

Int

高清Flv格式(1表示包含，0表示不包含)

list.sdHls

Int

流暢Hls格式(1表示包含，0表示不包含)

list.hdHls

Int

標(biāo)清Hls格式(1表示包含，0表示不包含)

list.shdHls

Int

高清Hls格式(1表示包含，0表示不包含)

list.aacAudio

Int

aac音頻格式(1表示選擇，0表示不選擇)

list.mp3Audio

Int

mp3音頻格式(1表示選擇，0表示不選擇)

list.isDel

Int

是否允許被刪除(默認(rèn)模板不允許刪除)，1：允許，0：不允許

list.transConfig

List

自定義模板信息，JSON對(duì)象，如果模板為自定義，則包含此元素

4.3.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.3.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 8,

"list": [

{

"sdHls": 0,

"isDel": 0,

"shdHls": 0,

"hdHls": 0,

"presetId": 39,

"sdMp4": 0,

"sdFlv": 0,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "默認(rèn)模板",

"hdFlv": 0,

"hdMp4": 0

{

"sdHls": 0,

"isDel": 1,

"shdHls": 0,

"hdHls": 0,

"presetId": 40,

"sdMp4": 1,

"sdFlv": 1,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "dd",

"hdFlv": 0,

"hdMp4": 0

}

"currentPage": 1,

"pageNum": 4

"code": 200

}

4.4 修改視頻轉(zhuǎn)碼模板信息

4.4.1 接口描述

域名：vcloud.163.com

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

用于視頻文件轉(zhuǎn)碼，修改轉(zhuǎn)碼模板，可修改：視頻轉(zhuǎn)碼模板名稱、視頻轉(zhuǎn)碼模板對(duì)應(yīng)的格式。

4.4.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

presetId

Int

是

視頻轉(zhuǎn)碼模板的Id

presetName

String

是

視頻轉(zhuǎn)碼模板的名稱

sdMp4

Int

是

流暢Mp4格式(1表示選擇，0表示不選擇)

hdMp4

Int

是

標(biāo)清Mp4格式(1表示選擇，0表示不選擇)

shdMp4

Int

是

高清Mp4格式(1表示選擇，0表示不選擇)

sdFlv

Int

是

流暢Flv格式(1表示選擇，0表示不選擇)

hdFlv

Int

是

標(biāo)清Flv格式(1表示選擇，0表示不選擇)

shdFlv

Int

是

高清Flv格式(1表示選擇，0表示不選擇)

sdHls

Int

是

流暢Hls格式(1表示選擇，0表示不選擇)

hdHls

Int

是

標(biāo)清Hls格式(1表示選擇，0表示不選擇)

shdHls

Int

是

高清Hls格式(1表示選擇，0表示不選擇)

aacAudio

Int

否

aac音頻格式(1表示選擇，0表示不選擇)

mp3Audio

Int

否

mp3音頻格式(1表示選擇，0表示不選擇)

transConfig

List

否

自定義模板信息，JSON對(duì)象，不設(shè)置為系統(tǒng)默認(rèn)轉(zhuǎn)碼信息

4.4.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

4.4.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.4.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.5 刪除視頻轉(zhuǎn)碼模板

4.5.1 接口描述

域名：vcloud.163.com

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

刪除視頻轉(zhuǎn)碼模板。

4.5.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

presetId

Int

是

視頻轉(zhuǎn)碼模板Id

4.5.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

4.5.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.5.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.6 創(chuàng)建視頻水印模板

4.6.1 接口描述

域名：vcloud.163.com

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

用于視頻文件管理水印，增加水印模板。

4.6.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

watermarkName

String

是

視頻水印的名稱

imageId

Int

是

視頻水印圖片的Id

description

String

否

視頻水印的描述信息

coordinate

String

否

視頻水印左上角的坐標(biāo)，其值為相對(duì)值，比如：

8%_6%表示在視頻左上角的偏右8%視頻寬度、偏下6%視頻高度的位置。

如果不選填，默認(rèn)設(shè)置為5%_5%

scale

String

否

視頻水印的長(zhǎng)寬，其值為相對(duì)值，比如：

10%x15%表示寬為視頻寬度的10%，高為視頻高度的15%。

如果不選填，默認(rèn)設(shè)置為不縮放或拉伸

重要提示：不建議設(shè)置水印的scale參數(shù)，縮放或拉伸水印圖片會(huì)影響水印圖片的效果，可能會(huì)出現(xiàn)模糊現(xiàn)象。

4.6.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

watermarkId

Int

視頻水印Id

msg

String

錯(cuò)誤信息

4.6.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.6.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d'{"watermarkName":"梅花水印","imageId":1,"description":"梅花水印","coordinate":"8%_6%"}' https://vcloud.163.com/app/vod/watermark/create

輸出1

{

"ret": {

"watermarkId": 16

"code": 200

}

4.7 獲取視頻水印模板信息

4.7.1 接口描述

域名：vcloud.163.com

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

獲取單個(gè)視頻水印模板信息，包括：Id、視頻水印模板名稱、視頻水印模板對(duì)應(yīng)的配置參數(shù)。

4.7.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

watermarkId

Int

是

視頻水印模板Id

4.7.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

watermarkId

Int

視頻水印模板Id

watermarkName

String

視頻水印模板的名稱

description

String

視頻水印的描述信息

coordinate

String

視頻水印左上角的坐標(biāo)，其值為相對(duì)值，比如：

8%_6%表示在視頻左上角的偏右8%視頻寬度、偏下6%視頻高度的位置。

如果不選填，默認(rèn)設(shè)置為5%_5%

scale

String

視頻水印的長(zhǎng)寬，其值為相對(duì)值，比如：

10%x15%表示長(zhǎng)為視頻寬度的10%，寬為視頻寬度的15%。

如果不選填，默認(rèn)設(shè)置為不縮放或拉伸

imageId

Int

水印圖片Id

imageUrl

String

水印圖片URL

isDel

Int

是否允許被刪除(默認(rèn)水印不允許刪除)，1:允許，0:不允許

msg

String

錯(cuò)誤信息

4.7.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.7.5 示例代碼

輸入1

輸出1

{

"ret": {

"scale": null,

"watermarkName": "梅花水印",

"coordinate": "8%_6%",

"description": "梅花水印",

"watermarkId": 16,

"imageId": 21,

"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",

"isDel": 1

"code": 200

}

4.8 獲取視頻水印模板列表

4.8.1 接口描述

域名：vcloud.163.com

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

獲取視頻水印模板列表，并做分頁(yè)返回處理。單個(gè)視頻水印模板的信息包括：Id、視頻水印模板名稱、視頻水印模板對(duì)應(yīng)的配置參數(shù)。

4.8.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

currentPage

Int

是

獲取視頻水印模板列表分頁(yè)后的索引

pageSize

Int

是

獲取視頻水印模板列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

4.8.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取視頻水印轉(zhuǎn)碼模板列表的分類數(shù)目

list

List

獲取的視頻水印模板列表

list.watermarkId

Int

視頻水印模板Id

list.watermarkName

String

視頻水印模板的名稱

list.description

String

視頻水印的描述信息

list.coordinate

String

視頻水印左上角的坐標(biāo)，其值為相對(duì)值，比如：

8%_6%表示在視頻左上角的偏右8%視頻寬度、偏下6%視頻高度的位置。

如果不選填，默認(rèn)設(shè)置為5%_5%

list.scale

String

視頻水印的長(zhǎng)寬，其值為相對(duì)值，比如：

10%x15%表示長(zhǎng)為視頻寬度的10%，寬為視頻寬度的15%。

如果不選填，默認(rèn)設(shè)置為不縮放或拉伸

list.imageId

Int

水印圖片Id

list.imageUrl

String

水印圖片URL

list.isDel

Int

是否允許被刪除(默認(rèn)水印不允許刪除)，1:允許，0:不允許

4.8.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.8.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 9,

"list": [

{

"scale": "10%x15%",

"watermarkName": "小熊水印",

"coordinate": "20%_12%",

"description": "ss",

"watermarkId": 6,

"imageId": 21,

"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",

"isDel": 1

{

"scale": "10%x15%",

"watermarkName": "royen_test",

"coordinate": "5%_5%",

"description": null,

"watermarkId": 7,

"imageId": 21,

"imageUrl": "http://vodk32ywxdf.nosdn.127.net/fda0bee8-6b96-45e4-9455-0490f84acc8a.jpg",

"isDel": 1

}

"currentPage": 1,

"pageNum": 5

"code": 200

}

4.9 修改視頻水印模板

4.9.1 接口描述

域名：vcloud.163.com

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

用于修改水印模板，可修改：視頻轉(zhuǎn)碼模板名稱、視頻轉(zhuǎn)碼模板對(duì)應(yīng)的格式。

4.9.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

watermarkId

Int

是

視頻水印模板Id

watermarkName

String

是

視頻水印的名稱

description

String

否

視頻水印的描述信息

coordinate

String

否

視頻水印左上角的坐標(biāo)，其值為相對(duì)值，比如：

8%_6%表示在視頻左上角的偏右8%視頻寬度、偏下6%視頻高度的位置。

如果不選填，默認(rèn)設(shè)置為5%_5%

scale

String

否

視頻水印的長(zhǎng)寬，其值為相對(duì)值，比如：

10%x15%表示長(zhǎng)為視頻寬度的10%，寬為視頻寬度的15%。

如果不選填，默認(rèn)設(shè)置為不縮放或拉伸

imageId

Int

否

水印圖片Id

4.9.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

4.9.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.9.5 示例代碼

輸入1

curl -X POST-H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"watermarkId":6,"watermarkName":"haha","coordinate":"20%_20%"}' https://vcloud.163.com/app/vod/watermark/update

輸出1

{

"ret": {},

"code": 200

}

4.10 刪除視頻水印模板

4.10.1 接口描述

域名：vcloud.163.com

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

刪除水印模板。

4.10.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

watermarkId

Int

是

視頻水印模板Id

4.10.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

4.10.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.10.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.11 視頻文件轉(zhuǎn)碼

4.11.1 接口描述

域名：vcloud.163.com

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

用于視頻轉(zhuǎn)碼，批量進(jìn)行視頻轉(zhuǎn)碼(只有處于正常或轉(zhuǎn)碼失敗狀態(tài)的視頻才允許執(zhí)行此操作)。

4.11.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vids

List

是

多個(gè)視頻Id組成的列表

presetId

Int

是

轉(zhuǎn)碼模板Id

watermarkId

Int

否

視頻水印Id(不填寫為不添加水印，且若填寫，presetId值不能為默認(rèn)模板)

userDefInfo

String

否

用戶自定義信息，回調(diào)會(huì)返回此信息

transOffset

Int

否

視頻轉(zhuǎn)碼處理裁剪視頻的起始位置(單位：秒)

transDuration

Int

否

視頻轉(zhuǎn)碼處理裁剪視頻的視頻時(shí)長(zhǎng)(單位：秒)

dynamicTransConfig

List

否

視頻動(dòng)態(tài)轉(zhuǎn)碼詳細(xì)參數(shù)配置列表，不設(shè)置則以presetId的配置為準(zhǔn)，設(shè)置則會(huì)覆蓋presetId對(duì)應(yīng)的transConfig中相同presetType的配置。詳見(jiàn)參數(shù)dynamicTransConfig

參數(shù)dynamicTransConfig詳情

參數(shù)

類型

必須

說(shuō)明

presetType

Int

是

自定義模板格式：1表示sdMp4，2表示hdMp4，3表示shdMp4，4表示sdFlv，5表示hdFlv，6表示shdFlv，7表示sdHls，8表示hdHls，9表示shdHls，16表示aac，17表示mp3

textMarks

List

否

文字水印配置信息列表，JSON對(duì)象，詳見(jiàn)本文4.1.2小節(jié)參數(shù)textMarks

4.11.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

successCount

Int

轉(zhuǎn)碼成功的數(shù)量

failCount

Int

轉(zhuǎn)碼失敗的數(shù)量

passCount

Int

轉(zhuǎn)碼忽略的數(shù)量，即已經(jīng)存在該轉(zhuǎn)碼格式視頻

msg

String

錯(cuò)誤信息

4.11.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.11.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vids":[29,30],"presetId":174,"watermarkId":23,"dynamicTransConfig":[{"presetType":1,"textMarks":[{"content":"網(wǎng)易視頻云","fontName":"pingfang_bold","fontSize":24,"fontColor":"#FFFFFF","fontOpacity":1.0,"coordinate":"5%_5%","shadowX":0,"shadowY":0,"borderWidth":1,"borderColor":"#000000","borderOpacity":1.0}]}]}' https://vcloud.163.com/app/vod/transcode/resetmulti

輸出1

{

"ret": {

"passCount": 0,

"failCount": 0,

"successCount": 2

"code": 200

}

4.12 設(shè)置轉(zhuǎn)碼回調(diào)地址

4.12.1 轉(zhuǎn)碼回調(diào)說(shuō)明

網(wǎng)易視頻云點(diǎn)播的轉(zhuǎn)碼回調(diào)通知分為單個(gè)級(jí)別和用戶級(jí)別，且處理優(yōu)先級(jí)為：單個(gè)級(jí)別->用戶級(jí)別->無(wú)回調(diào)。當(dāng)用戶設(shè)置了單個(gè)級(jí)別的回調(diào)地址，使用單個(gè)級(jí)別的回調(diào)地址；否則查詢是否設(shè)置用戶級(jí)別的回調(diào)地址，如果設(shè)置，使用用戶級(jí)別的回調(diào)地址；否則不回調(diào)通知。單個(gè)級(jí)別的回調(diào)通知在上傳初始化中指定，用戶級(jí)別的回調(diào)通知可通過(guò)本接口設(shè)置。

目前網(wǎng)易視頻云點(diǎn)播支持轉(zhuǎn)碼結(jié)果回調(diào)通知。

4.12.2 接口描述

域名：vcloud.163.com

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

用于視頻轉(zhuǎn)碼，設(shè)置轉(zhuǎn)碼成功后的回調(diào)地址。

4.12.3 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

callbackUrl

String

否

轉(zhuǎn)碼成功后回調(diào)客戶端的URL地址

signKey

String

否

轉(zhuǎn)碼成功后回調(diào)客戶端的簽名字符串，要求是由字母和數(shù)字組成且不超過(guò)32位

4.12.4 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

successCount

Int

轉(zhuǎn)碼成功的數(shù)量

failCount

Int

轉(zhuǎn)碼失敗的數(shù)量

passCount

Int

轉(zhuǎn)碼忽略的數(shù)量，即已經(jīng)存在該轉(zhuǎn)碼格式視頻

msg

String

錯(cuò)誤信息

4.12.5 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

4.12.6 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"callbackUrl":"http://127.0.0.1/client/callback"}' https://vcloud.163.com/app/vod/transcode/setcallback

輸出1

{

"msg" : "",

"code" : 200

}

4.12.7 轉(zhuǎn)碼成功回調(diào)內(nèi)容示例

{"sdFlvAddr":"http://vodk32ywxdf.vod.126.net/vodk32ywxdf/flv/rDM5V7HM_1021_sd.flv","name":"snow.mp4","type":"transcode","vid":1021,"user_defined":"userId=123456"}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，上傳回調(diào)固定為“transcode”

vid

Long

視頻文件標(biāo)識(shí)

name

String

視頻文件名稱

sdMp4Addr

String

流暢mp4視頻的播放地址

hdMp4Addr

String

標(biāo)清mp4視頻的播放地址

shdMp4Addr

String

高清mp4視頻的播放地址

sdFlvAddr

String

流暢flv視頻的播放地址

hdFlvAddr

String

標(biāo)清flv視頻的播放地址

shdFlvAddr

String

高清flv視頻的播放地址

sdHlsAddr

String

流暢hls視頻的播放地址

hdHlsAddr

String

標(biāo)清hls視頻的播放地址

shdHlsAddr

String

高清hls視頻的播放地址

user_defined

String

用戶自定義字段值(轉(zhuǎn)碼時(shí)設(shè)置的值)

4.12.8 轉(zhuǎn)碼失敗回調(diào)內(nèi)容示例

{"error":{"msg":"Failed","type":"transcode","vid":1021,"user_defined":"userId=123456","name":"snow.mp4"}}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，上傳回調(diào)固定為“transcode”

vid

Long

視頻文件標(biāo)識(shí)

name

String

視頻文件名稱

msg

String

轉(zhuǎn)碼失敗原因

user_defined

String

用戶自定義字段值(轉(zhuǎn)碼時(shí)設(shè)置的值)

5 文件管理

文件管理模塊主要展示視頻圖片等文件管理相關(guān)的API調(diào)用和代碼示例。包括視頻管理、分類管理、截圖及封面管理等功能。

5.1 獲取視頻文件信息

5.1.1 接口描述

域名：vcloud.163.com

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

獲取單個(gè)視頻文件信息，包括：Id、視頻名稱、各個(gè)視頻格式的播放地址、各個(gè)視頻格式的下載地址、各個(gè)視頻格式的視頻大小、視頻截圖地址、視頻所屬分類Id和名稱、視頻播放時(shí)長(zhǎng)、視頻轉(zhuǎn)碼完成時(shí)間。

5.1.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

5.1.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

videoName

String

視頻的名稱

vid

Long

視頻Id

status

Int

視頻的狀態(tài)，10表示初始，20表示失敗，30表示處理中，40表示成功，50表示屏蔽，70表示加密中，80表示加密失敗

description

String

視頻的描述信息

completeTime

Long

轉(zhuǎn)碼完成時(shí)間

duration

Int

視頻播放時(shí)長(zhǎng)(單位：秒)

durationMsec

Int

視頻播放時(shí)長(zhǎng)(單位：毫秒)

width

String

視頻寬度，默認(rèn)為"0"

height

String

視頻高度，默認(rèn)為"0"

typeId

Int

視頻所屬分類Id

typeName

String

視頻所屬分類名稱

snapshotUrl

String

視頻封面截圖URL地址

origUrl

String

原始視頻的播放地址

downloadOrigUrl

String

原始視頻的下載地址

initialSize

Long

原始視頻文件大小(單位：字節(jié))

sdMp4Url

String

流暢Mp4視頻格式文件播放地址

downloadSdMp4Url

String

流暢Mp4視頻格式文件下載地址

sdMp4Size

Int

流暢Mp4視頻格式文件的大小(單位：字節(jié))

sdMp4Width

String

流暢Mp4視頻寬度，默認(rèn)為"0"

sdMp4Height

String

流暢Mp4視頻高度，默認(rèn)為"0"

hdMp4Url

String

標(biāo)清Mp4視頻格式文件播放地址

downloadHdMp4Url

String

標(biāo)清Mp4視頻格式文件下載地址

hdMp4Size

Int

標(biāo)清Mp4視頻格式文件的大小(單位：字節(jié))

hdMp4Width

String

標(biāo)清Mp4視頻寬度，默認(rèn)為"0"

hdMp4Height

String

標(biāo)清Mp4視頻高度度，默認(rèn)為"0"

shdMp4Url

String

高清Mp4視頻格式文件播放地址

downloadShdMp4Url

String

高清Mp4視頻格式文件下載地址

shdMp4Size

Int

高清Mp4視頻格式文件的大小(單位：字節(jié))

shdMp4Width

String

高清Mp4視頻寬度，默認(rèn)為"0"

shdMp4Height

String

高清Mp4視頻高度，默認(rèn)為"0"

sdFlvUrl

String

流暢Flv視頻格式文件播放地址

downloadSdFlvUrl

String

流暢Flv視頻格式文件下載地址

sdFlvSize

Int

流暢Flv視頻格式文件的大小(單位：字節(jié))

sdFlvWidth

String

流暢Flv視頻寬度，默認(rèn)為"0"

sdFlvHeight

String

流暢Flv視頻高度，默認(rèn)為"0"

hdFlvUrl

String

標(biāo)清Flv視頻格式文件播放地址

downloadHdFlvUrl

String

標(biāo)清Flv視頻格式文件下載地址

hdFlvSize

Int

標(biāo)清Flv視頻格式文件的大小(單位：字節(jié))

hdFlvWidth

String

標(biāo)清Flv視頻寬度，默認(rèn)為"0"

hdFlvHeight

String

標(biāo)清Flv視頻高度，默認(rèn)為"0"

shdFlvUrl

String

高清Flv視頻格式文件播放地址

downloadShdFlvUrl

String

高清Flv視頻格式文件下載地址

shdFlvSize

Int

高清Flv視頻格式文件的大小(單位：字節(jié))

shdFlvWidth

String

高清Flv視頻寬度，默認(rèn)為"0"

shdFlvHeight

String

高清Flv視頻高度，默認(rèn)為"0"

sdHlsUrl

String

流暢Hls視頻格式文件播放地址

downloadSdHlsUrl

String

流暢Hls視頻格式文件下載地址

sdHlsSize

Int

流暢Hls視頻格式文件的大小(單位：字節(jié))

sdHlsWidth

String

流暢Hls視頻寬度，默認(rèn)為"0"

sdHlsHeight

String

流暢Hls視頻高度，默認(rèn)為"0"

hdHlsUrl

String

標(biāo)清Hls視頻格式文件播放地址

downloadHdHlsUrl

String

標(biāo)清Hls視頻格式文件下載地址

hdHlsSize

Int

標(biāo)清Hls視頻格式文件的大小(單位：字節(jié))

hdHlsWidth

String

標(biāo)清Hls視頻寬度，默認(rèn)為"0"

hdHlsHeight

String

標(biāo)清Hls視頻高度，默認(rèn)為"0"

shdHlsUrl

String

高清Hls視頻格式文件播放地址

downloadShdHlsUrl

String

高清Hls視頻格式文件下載地址

shdHlsSize

Int

高清Hls視頻格式文件的大小(單位：字節(jié))

shdHlsWidth

String

高清Hls視頻寬度，默認(rèn)為"0"

shdHlsHeight

String

高清Hls視頻高度，默認(rèn)為"0"

createTime

Long

視頻上傳時(shí)間(單位：毫秒)

updateTime

Long

視頻更新時(shí)間(單位：毫秒)

msg

String

錯(cuò)誤信息

5.1.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.1.5 示例代碼

輸入1

輸出1

{

"ret": {

"createTime": 1466578358729,

"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/44d30332-7402-4b2f-82c8-154dbb6b4e14.mp4",

"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/44d30332-7402-4b2f-82c8-154dbb6b4e14.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558005&download=watermark_test_1.mp4&Signature=%2BGu%2BvgiUP1rL4pbx%2B52GH4QCo%2FOHAtlhgzCzPV9f0vc%3D",

"shdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_shd.mp4",

"sdMp4Size": 17906823,

"videoName": "watermark_test_1",

"downloadSdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_sd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E6%25A0%2587%25E6%25B8%2585_watermark_test_1.mp4&Signature=64FOWYzLciWyTe8hmLMRVCYRCsQLbEOWtNqcB9rUj18%3D",

"description": null,

"hdMp4Size": 25227850,

"downloadSdFlvUrl": "http://vodk32ywxdf.nosdn.127.net/nos%2Fflv%2F2016%2F06%2F22%2Fv32_sd.flv?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E6%25A0%2587%25E6%25B8%2585_watermark_test_1.flv&Signature=pGmKYIjWq%2FZE9Gu8K1MZcuqQYG83cI2bnuiikLO8TCk%3D",

"vid": 32,

"shdMp4Size": 39874022,

"sdFlvUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/flv/2016/06/22/v32_sd.flv",

"sdFlvSize": 18013302,

"hdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_hd.mp4",

"status": 40,

"updateTime": 1466663164342,

"sdMp4Url": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/nos/mp4/2016/06/22/v32_sd.mp4",

"downloadHdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_hd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E9%25AB%2598%25E6%25B8%2585_watermark_test_1.mp4&Signature=kMUKJGcW8aSFauL2836pXA5UrEeowq2hLdpgMpjmr44%3D",

"downloadShdMp4Url": "http://vodk32ywxdf.nosdn.127.net/nos%2Fmp4%2F2016%2F06%2F22%2Fv32_shd.mp4?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558006&download=%25E8%25B6%2585%25E6%25B8%2585_watermark_test_1.mp4&Signature=ch30%2BtX20b54UeskhFZs37r55jkt2WIV87jlaZgKmPY%3D",

"typeName": "默認(rèn)分類",

"duration": 195,

"snapshotUrl": "http://vodk32ywxdf.nosdn.127.net/6c4a9501-ee3c-4e00-9a5f-20f6616f0ad3.jpg",

"initialSize": 15601202,

"typeId": 38,

"completeTime": 1466663164342

"code": 200

}

5.2 獲取視頻文件信息列表

5.2.1 接口描述

域名：vcloud.163.com

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

獲取視頻文件信息列表，并做分頁(yè)返回處理。單個(gè)視頻轉(zhuǎn)碼模板的信息包括：Id、視頻轉(zhuǎn)碼模板名稱、視頻轉(zhuǎn)碼模板對(duì)應(yīng)的格式。

使用時(shí) ，建議先合理設(shè)置好時(shí)間區(qū)段(從beginTime到endTime)，然后再設(shè)置currentPage與pageSize。該接口將在所設(shè)定的時(shí)段內(nèi)，檢索最多5000個(gè)文件。若需要獲取超過(guò)5000個(gè)文件，建議分時(shí)段多次查詢獲取。

5.2.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

currentPage

Int

是

獲取視頻列表分頁(yè)后的索引

pageSize

Int

是

獲取視頻列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]，currentPage * pageSize不能超過(guò)5000

beginTime

Long

否

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endTime

Long

否

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

status

Int

是

根據(jù)視頻狀態(tài)過(guò)濾選擇(0表示獲取所有狀態(tài)視頻，10表示初始，20表示失敗，30表示處理中，40表示成功，50表示屏蔽，70表示加密中，80表示加密失敗)

type

Int

是

根據(jù)視頻分類過(guò)濾選擇(0表示獲取所有分類視頻)

sortStr

String

否

按視頻上傳時(shí)間排序，desc表示按上傳時(shí)間降序，asc表示按上傳時(shí)間升序，默認(rèn)為desc

為避免分頁(yè)過(guò)大，建議您合理選擇sortStr。比如，如果您想刪除時(shí)間久遠(yuǎn)的視頻，可以設(shè)置sortStr=asc，再調(diào)用刪除接口進(jìn)行刪除。

5.2.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取視頻列表的分類數(shù)目

list

List

獲取的視頻列表

list.videoName

String

視頻的名稱

list.status

Int

視頻的狀態(tài)，10表示初始，20表示失敗，30表示處理中，40表示成功，50表示屏蔽

list.description

String

視頻的描述信息

list.completeTime

Long

轉(zhuǎn)碼完成時(shí)間

list.duration

Int

視頻播放時(shí)長(zhǎng)(單位：秒)

list.durationMsec

Int

視頻播放時(shí)長(zhǎng)(單位：毫秒)

list.typeId

Int

視頻所屬分類Id

list.typeName

String

視頻所屬分類名稱

list.snapshotUrl

String

視頻封面截圖URL地址

list.origUrl

String

原始視頻的播放地址

list.downloadOrigUrl

String

原始視頻的下載地址

list.initialSize

Long

原始視頻文件大小(單位：字節(jié))

list.sdMp4Url

String

流暢Mp4視頻格式文件播放地址

list.downloadSdMp4Url

String

流暢Mp4視頻格式文件下載地址

list.sdMp4Size

Int

流暢Mp4視頻格式文件的大小(單位：字節(jié))

list.hdMp4Url

String

標(biāo)清Mp4視頻格式文件播放地址

list.downloadHdMp4Url

String

標(biāo)清Mp4視頻格式文件下載地址

list.hdMp4Size

Int

標(biāo)清Mp4視頻格式文件的大小(單位：字節(jié))

list.shdMp4Url

String

高清Mp4視頻格式文件播放地址

list.downloadShdMp4Url

String

高清Mp4視頻格式文件下載地址

list.shdMp4Size

Int

高清Mp4視頻格式文件的大小(單位：字節(jié))

list.sdFlvUrl

String

流暢Flv視頻格式文件播放地址

list.downloadSdFlvUrl

String

流暢Flv視頻格式文件下載地址

list.sdFlvSize

Int

流暢Flv視頻格式文件的大小(單位：字節(jié))

list.hdFlvUrl

String

標(biāo)清Flv視頻格式文件播放地址

list.downloadHdFlvUrl

String

標(biāo)清Flv視頻格式文件下載地址

list.hdFlvSize

Int

標(biāo)清Flv視頻格式文件的大小(單位：字節(jié))

list.shdFlvUrl

String

高清Flv視頻格式文件播放地址

list.downloadShdFlvUrl

String

高清Flv視頻格式文件下載地址

list.shdFlvSize

Int

高清Flv視頻格式文件的大小(單位：字節(jié))

list.sdHlsUrl

String

流暢Hls視頻格式文件播放地址

list.downloadSdHlsUrl

String

流暢Hls視頻格式文件下載地址

list.sdHlsSize

Int

流暢Hls視頻格式文件的大小(單位：字節(jié))

list.hdHlsUrl

String

標(biāo)清Hls視頻格式文件播放地址

list.downloadHdHlsUrl

String

標(biāo)清Hls視頻格式文件下載地址

list.hdHlsSize

Int

標(biāo)清Hls視頻格式文件的大小(單位：字節(jié))

list.shdHlsUrl

String

高清Hls視頻格式文件播放地址

list.downloadShdHlsUrl

String

高清Hls視頻格式文件下載地址

list.shdHlsSize

Int

高清Hls視頻格式文件的大小(單位：字節(jié))

list.createTime

Long

視頻上傳時(shí)間(單位：毫秒)

list.updateTime

Long

視頻更新時(shí)間(單位：毫秒)

list.vid

Long

視頻Id

5.2.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.2.5 示例代碼

輸入1

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

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 28,

"list": [

{

"typeName": "默認(rèn)分類",

"createTime": 1467007983618,

"duration": 0,

"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/02a32b58-39fa-4d04-aeca-d7defa7e8972.jpg",

"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/02a32b58-39fa-4d04-aeca-d7defa7e8972.jpg?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558273&download=qwqwqw.jpg&Signature=0b5yMclktt%2FpDBQIZU8bLB6suouXLMfGZhqECFDp8%2Bw%3D",

"status": 40,

"updateTime": 1467007983618,

"description": null,

"snapshotUrl": null,

"initialSize": 6354,

"videoName": "qwqwqw",

"typeId": 38,

"completeTime": null,

"vid": 39

{

"typeName": "默認(rèn)分類",

"createTime": 1467007653656,

"duration": 0,

"origUrl": "http://vodk32ywxdf.vod.126.net/vodk32ywxdf/dcffdc0d-0735-41e1-8d30-d1d19450137f.jpg",

"downloadOrigUrl": "http://vodk32ywxdf.nosdn.127.net/dcffdc0d-0735-41e1-8d30-d1d19450137f.jpg?NOSAccessKeyId=ab1856bb39044591939d7b94e1b8e5ee&Expires=1498558273&download=Chrysanthemum.jpg&Signature=oxa5%2F60xl8dmhtLoS21p97J%2BrnsRWFP12c30oA6Sh3o%3D",

"status": 40,

"updateTime": 1467007653656,

"description": null,

"snapshotUrl": null,

"initialSize": 879394,

"videoName": "Chrysanthemum",

"typeId": 38,

"completeTime": null,

"vid": 38

}

"currentPage": 1,

"pageNum": 14

"code": 200

}

5.3 視頻文件信息編輯

5.3.1 接口描述

域名：vcloud.163.com

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

用于視頻文件信息管理，修改視頻文件信息，可修改：視頻文件名稱、視頻分類Id和視頻描述信息。

5.3.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

videoName

String

是

視頻的名稱

typeId

Int

是

視頻分類Id

description

String

否

視頻的描述信息

5.3.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.3.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.3.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":20,"videoName":"for_love.mp4","typeId":20,"description":"編輯視頻"}' https://vcloud.163.com/app/vod/video/edit

輸出1

{

"ret": {},

"code": 200

}

5.4 刪除單個(gè)轉(zhuǎn)碼輸出視頻

5.4.1 接口描述

域名：vcloud.163.com

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

用于視頻管理，刪除單個(gè)轉(zhuǎn)碼輸出視頻(不允許刪除單個(gè)源視頻)。

5.4.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

style

Int

是

視頻轉(zhuǎn)碼格式(1表示流暢mp4，2表示標(biāo)清mp4，3表示高清mp4，

4表示流暢flv，5表示標(biāo)清flv，6表示高清flv，

7表示流暢hls，8表示標(biāo)清hls，9表示高清hls)

5.4.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.4.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.4.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.5 刪除視頻源文件

5.5.1 接口描述

域名：vcloud.163.com

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

用于視頻管理，刪除視頻文件。

5.5.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

5.5.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.5.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.5.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.6 視頻屏蔽

5.6.1 接口描述

域名：vcloud.163.com

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

用于視頻管理，屏蔽視頻文件(只有正常狀態(tài)下的視頻才能做屏蔽操作)。

5.6.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

5.6.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.6.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.6.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.7 視頻恢復(fù)

5.7.1 接口描述

域名：vcloud.163.com

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

用于視頻管理，恢復(fù)視頻文件(只有被屏蔽的視頻才能做恢復(fù)操作)。

5.7.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

5.7.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.7.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.7.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.8 批量刪除視頻

5.8.1 接口描述

域名：vcloud.163.com

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

用于視頻管理，批量刪除視頻文件。

5.8.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vids

List

是

多個(gè)視頻ID組成的列表,最多一次刪除50個(gè)視頻

5.8.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

錯(cuò)誤碼

msg

String

錯(cuò)誤信息

5.8.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

724

部分刪除操作成功

5.8.5 示例代碼

輸入1

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"code" : 200,

"msg" : ""

}

輸入2

輸出2

"Content-Type": "application/json; charset=utf-8"

{

"code" : 724,

"ret" : {

"failedVids" : [23,24]

}

code參考code狀態(tài)表

5.9 創(chuàng)建視頻分類

5.9.1 接口描述

域名：vcloud.163.com

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

用于管理視頻文件，增加分類。

5.9.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

typeName

String

是

視頻分類的名稱

parentTypeId

Int

否

父分類Id

description

String

否

視頻分類的描述信息

5.9.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

typeId

Int

新生成的視頻分類Id

msg

String

錯(cuò)誤信息

5.9.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.9.5 示例代碼

輸入1

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

輸出1

{

"ret" : {

"typeId" : 1

"code" : 200

}

5.10 獲取視頻分類信息

5.10.1 接口描述

域名：vcloud.163.com

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

獲取單個(gè)視頻分類信息，包括：Id、分類描述信息、分類數(shù)目和分類的創(chuàng)建時(shí)間。

5.10.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

typeId

Int

是

視頻分類的Id

5.10.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

typeId

Int

視頻分類Id

typeName

String

視頻分類的名稱

parentTypeId

Int

父分類Id

desc

String

視頻分類的描述信息

number

Int

該類別下的視頻文件數(shù)量

isDel

Int

是否允許被刪除(默認(rèn)分類不允許刪除)，1：允許，0：不允許

createTime

Long

視頻分類的創(chuàng)建時(shí)間(單位：毫秒)

childNum

Int

子分類數(shù)量

msg

String

錯(cuò)誤信息

5.10.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.10.5 示例代碼

輸入1

輸出1

{

"ret": {

"typeName": "movie",

"createTime": 1467006327149,

"isDel": 1,

"desc": "電影",

"number": 0,

"typeId": 227,

"parentTypeId": 0,

"childNum": 2

"code": 200

}

5.11 獲取視頻分類列表信息

5.11.1 接口描述

域名：vcloud.163.com

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

獲取視頻分類列表，并做分頁(yè)返回處理。單個(gè)視頻的分類信息包括：Id、分類描述信息、分類數(shù)目和分類的創(chuàng)建時(shí)間。

5.11.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

currentPage

Int

是

獲取視頻分類列表分頁(yè)后的索引

pageSize

Int

是

獲取視頻分類列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

5.11.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取視頻分類列表的分類數(shù)目

list

List

獲取的視頻分類列表

list.typeId

Int

視頻分類Id

list.typeName

String

視頻分類的名稱

list.parentTypeId

Int

父分類Id

list.desc

String

視頻分類的描述信息

list.number

Int

該類別下的視頻文件數(shù)量

list.isDel

Int

是否允許被刪除(默認(rèn)分類不允許刪除)，1：允許，0：不允許

list.childNum

Int

子分類數(shù)量

list.createTime

Long

視頻分類的創(chuàng)建時(shí)間(單位：毫秒)

5.11.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.11.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 4,

"list": [

{

"typeName": "默認(rèn)分類",

"createTime": 1464229521940,

"isDel": 0,

"desc": "默認(rèn)分類",

"number": 47,

"typeId": 38,

"childNum": 0

{

"typeName": "直播錄制",

"createTime": 1464229521940,

"isDel": 0,

"desc": "直播錄制",

"number": 1,

"typeId": 39,

"childNum": 0

}

"currentPage": 1,

"pageNum": 2

"code": 200

}

5.12 修改視頻分類信息

5.12.1 接口描述

域名：vcloud.163.com

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

用于管理視頻文件，修改分類，可修改：分類名稱、分類描述信息。

5.12.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

typeId

Int

是

視頻分類的Id

typeName

String

是

視頻分類的名稱

description

String

否

視頻分類的描述信息

5.12.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.12.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.12.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"typeId":227, "typeName":"娛樂(lè)","description":"更改分類"}' https://vcloud.163.com/app/vod/type/update

輸出1

{

"ret": {},

"code": 200

}

5.13 刪除視頻分類

5.13.1 接口描述

域名：vcloud.163.com

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

刪除視頻分類。

5.13.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

typeId

Int

是

視頻分類Id

5.13.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.13.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.13.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.14 設(shè)置視頻的分類

5.14.1 接口描述

域名：vcloud.163.com

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

設(shè)置視頻的分類。

5.14.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

typeId

Int

是

視頻分類的Id

5.14.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.14.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.14.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.15 獲取視頻截圖地址

5.15.1 接口描述

域名：vcloud.163.com

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

針對(duì)具體文件，獲取其不同尺寸下的截圖URL地址。支持截圖的文件格式：

mpegts、mov、mp4、m4a、3gp、3g2、mj2、rm、asf、flv、avi、matroska、

webm、mpeg、mpeg、mpegtsraw、mpegvideo、mtv、mv、mvi、nuv、3gp、

avs、avsvideo、adxl、dv、dvd、flic、flac、h261、h263、h264、hls、m4v、

mjpeg、rawvideo、rpl、avcd、truehd、vc-1、vcd。

如有不支持格式視頻，請(qǐng)進(jìn)行轉(zhuǎn)碼，接口會(huì)根據(jù)轉(zhuǎn)碼后的視頻截取圖片。

截取圖片比例如果和視頻尺寸比例不相符合，會(huì)自動(dòng)填充黑邊，保證圖片顯示正常。

5.15.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

size

Int

是

截圖尺寸，包含以下幾種值：

0表示原始視頻比例，1表示640x360，2表示400x300，3表示320x180，

4表示200x150，5表示1280x720，6表示960x720，7表示360x640，

8表示300x400，9表示180x320，10表示150x200，11表示720x1280，

12表示720x960，13表示180x180，14表示360x360，15表示720x720

offset

Int

否

截圖偏移，包含以下幾種值：

0表示視頻第一秒，1表示時(shí)間軸10%位置，2表示時(shí)間軸20%位置，

3表示時(shí)間軸30%位置，4表示時(shí)間軸40%位置，5表示時(shí)間軸50%位置，

6表示時(shí)間軸60%位置，7表示時(shí)間軸70%位置，8表示時(shí)間軸80%位置，

9表示時(shí)間軸90%位置

customWidth

Int

否

自定義截圖寬度，可設(shè)置值為(0,4000]

customHeight

Int

否

自定義截圖高度，可設(shè)置值為(0,4000]

customOffset

Long

否

自定義截圖時(shí)間戳，單位毫秒

style

Int

否

視頻轉(zhuǎn)碼格式(0表示源視頻，1表示流暢mp4，2表示標(biāo)清mp4，3表示高清mp4， 4表示流暢flv，5表示標(biāo)清flv，6表示高清flv， 7表示流暢hls，8表示標(biāo)清hls，9表示高清hls) 如果設(shè)置了style，則會(huì)根據(jù)指定格式的視頻進(jìn)行截圖

重要提示：

如需自定義截圖寬高信息，customWidth和customHeight需同時(shí)不為空。

如果offset和customOffset都填寫，以customOffset為準(zhǔn)。如果offset和customOffset都不填寫，默認(rèn)offset=0。

5.15.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

url

String

截圖地址

width

String

截圖寬度

height

String

截圖高度

msg

String

錯(cuò)誤信息

5.15.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.15.5 示例代碼

輸入1

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"ret" : {

"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg",

"width" : "640",

"height" : "320"

"code" : 200

}

5.16 設(shè)置視頻封面

5.16.1 接口描述

域名：vcloud.163.com

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

為視頻設(shè)置顯示封面。

5.16.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻Id

type

Int

是

封面設(shè)置方法：1表示使用截圖URL，2表示使用本地上傳圖片

path

String

是

type值為1，則代表截圖URL；type值為2，則代表本地圖片路徑

data

String

否

type值為2時(shí)，需填寫，代表本地圖片數(shù)據(jù)的base64編碼字符串?dāng)?shù)據(jù)

重要提示：使用截圖URL設(shè)置視頻封面的URL必需是存儲(chǔ)在網(wǎng)易視頻云點(diǎn)播服務(wù)的URL，暫不支持第三方URL。

5.16.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

url

String

截圖地址

msg

String

錯(cuò)誤信息

5.16.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.16.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":12,"type":1,"path":"http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"}' https://vcloud.163.com/app/vod/snapshot/set

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"ret" : {

"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"

"code" : 200

}

5.17 生成視頻預(yù)覽

5.17.1 接口描述

域名：vcloud.163.com

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

為視頻生成預(yù)覽，包括：動(dòng)圖和視頻。

5.17.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻的標(biāo)識(shí)

format

Int

是

生成的視頻預(yù)覽格式，1表示webp格式,2表示mp4格式，3表示flv格式，4表示hls格式，5表示gif格式

samplings

List

是

采樣的視頻時(shí)間區(qū)間列表，包含一組sampling，

區(qū)間個(gè)數(shù)最多5個(gè)，單位為秒，區(qū)間時(shí)長(zhǎng)小于等于3s區(qū)間，可以有重合，區(qū)間順序有意義

callbackUrl

String

否

處理完成后回調(diào)的URL地址(需標(biāo)準(zhǔn)http格式)，如不設(shè)置，使用默認(rèn)的轉(zhuǎn)碼回調(diào)地址

userDefInfo

String

否

用戶自定義信息，回調(diào)會(huì)返回此信息

keepAspectRatio

Int

否

是否保持輸出文件與原視頻寬高比，0表示不保持，1表示保持，默認(rèn)為1

outputWidth

Int

否

輸出文件的寬度，取值大于等于0且小于等于4096，默認(rèn)為0

outputHeight

Int

否

輸出文件的高度，取值大于等于0且小于等于4096，默認(rèn)為0

frameRate

Int

否

輸出幀率，取值不超過(guò)30且大于0，若等于0，則保持與原視頻一致，默認(rèn)為8

bitRate

Int

否

比特率，取值大于0，不設(shè)置則保持和原視頻相同

enableLoop

Int

否

webp格式的預(yù)覽是否循環(huán)， 0表示不循環(huán)， 1表示循環(huán)，默認(rèn)為0

sampling參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

必須

說(shuō)明

start

Int

是

采樣的視頻時(shí)間區(qū)間開(kāi)始時(shí)間

end

Int

是

采樣的視頻時(shí)間區(qū)間結(jié)束時(shí)間

重要提示：

若outputWidth為0且outputHeight為0,則輸出寬高均取原視頻寬高。

若outputWidth為0且outputHeight>0,則保持寬高比，無(wú)視keepAspectRatio參數(shù)，按照設(shè)置的高度值等比例計(jì)算寬度。

若outputWidth>0且outputHeight為0,則保持寬高比，無(wú)視keepAspectRatio參數(shù)，按照設(shè)置的寬度值等比例計(jì)算高度。

若outputWidth>0且outputHeight>0,且keepAspectRatio為0，則輸出寬高按照參數(shù)設(shè)置；若keepAspectRatio為1，則寬不變，高通過(guò)計(jì)算得到。

對(duì)于format格式為2、3、4的，samplings只允許一組值，表示視頻截取開(kāi)始時(shí)間和結(jié)束時(shí)間，如果有多組值，只取第一組，其余忽略。

5.17.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

url

String

截圖地址

msg

String

錯(cuò)誤信息

5.17.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.17.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32,"format":1,"samplings":[{"start":1,"end":3},{"start":4,"end":6},{"start":8,"end":9},{"start":12,"end":13},{"start":21,"end":23}],"userDefInfo":"userId=123456"}' https://vcloud.163.com/app/vod/video/preview

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"requestId" : "e49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {}

}

5.17.6 結(jié)果回調(diào)

視頻預(yù)覽的生成為異步處理，處理完成回回調(diào)給請(qǐng)求參數(shù)設(shè)置的callbackUrl，如果未設(shè)置，回調(diào)給默認(rèn)的轉(zhuǎn)碼地址。

生成預(yù)覽圖成功回調(diào)內(nèi)容示例

{

"previewAddr" : "vodk32ywxdf.vod.126.net/vodk32ywxdf/abcsdf.mp4",

"type" : "videoPreview",

“originVid” : 32,

"previewVid" : 1243,

q"user_defined" : "userId=123456"

}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，預(yù)覽圖生成回調(diào)固定為“videoPreview”

originVid

Long

原始視頻文件視頻標(biāo)識(shí)

previewVid

String

生成的預(yù)覽視頻標(biāo)識(shí)

previewAddr

String

生成視頻預(yù)覽訪問(wèn)地址

user_defined

String

用戶自定義字段值

生成預(yù)覽圖失敗回調(diào)內(nèi)容示例

{

"error" : {

"msg" : "Failed",

"type" : "videoPreview",

"originVid" : 32,

"user_defined" : "userId=123456"

}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，預(yù)覽圖生成回調(diào)固定為“preview”

originVid

Long

原始視頻文件視頻標(biāo)識(shí)

msg

String

轉(zhuǎn)碼失敗原因

user_defined

String

用戶自定義字段值

5.18 視頻裁剪

5.18.1 接口描述

域名：vcloud.163.com

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

對(duì)視頻進(jìn)行裁剪，針對(duì)每個(gè)采樣區(qū)間生成獨(dú)立的視頻。

5.18.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻的標(biāo)識(shí)

format

Int

是

生成的視頻預(yù)覽格式，1表示mp4格式，2表示flv格式

samplings

List

是

采樣的視頻時(shí)間區(qū)間列表，包含一組sampling，

區(qū)間個(gè)數(shù)最多10個(gè)，單位為秒，可以有重合，區(qū)間順序有意義

callbackUrl

String

否

處理完成后回調(diào)的URL地址(需標(biāo)準(zhǔn)http格式)，如不設(shè)置，使用默認(rèn)的回調(diào)地址

userDefInfo

String

否

用戶自定義信息，回調(diào)會(huì)返回此信息

sampling參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

必須

說(shuō)明

start

Int

是

采樣的視頻時(shí)間區(qū)間開(kāi)始時(shí)間

end

Int

是

采樣的視頻時(shí)間區(qū)間結(jié)束時(shí)間

cropArea

object

否

采樣區(qū)間內(nèi)對(duì)畫面進(jìn)行扣取

cropArea參數(shù)說(shuō)明

參數(shù)

類型

必須

說(shuō)明

width

Int

是

扣取畫面的寬，例如640，50，此值可表示絕對(duì)值也可表示相對(duì)值，取決于whType，當(dāng)whType取值為2時(shí)，不允許大于100

height

Int

是

扣取畫面的高，例如360,50，此值可表示絕對(duì)值也可表示相對(duì)值，取決于whType，當(dāng)whType取值為2時(shí)，不允許大于100

whType

Int

是

取值1或者2。1-表示上面的寬高為絕對(duì)值，傳入為640*360，那么扣取畫面的寬高就是640*360；2-表示相對(duì)值，表示傳入的寬高為相對(duì)原視頻寬高的百分比。例如傳入5050，那么扣取的視頻畫面寬為src_width\59%，同理高為src_height*50%

Int

是

采樣畫面左上角相對(duì)于原視頻的左上角的橫坐標(biāo)

Int

是

采樣畫面左上角相對(duì)于原視頻的左上角的縱坐標(biāo)

xyType

Int

是

用于表示x,y是絕對(duì)值還是百分比，1-絕對(duì)值，例如120,120。2-百分比，表示才用原視頻寬高的百分比

注：callbackUrl如果不設(shè)置，會(huì)采用默認(rèn)的視頻裁剪地址回調(diào)。默認(rèn)視頻裁剪地址回調(diào)設(shè)置接口參考 9.3節(jié) 設(shè)置回調(diào)地址接口

5.18.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

請(qǐng)求標(biāo)識(shí)

code

Int

狀態(tài)碼

taskId

Long

任務(wù)標(biāo)識(shí)

msg

String

錯(cuò)誤信息

注：taskId是媒體處理任務(wù)的唯一標(biāo)識(shí)，用戶可以通過(guò)taskId主動(dòng)查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)。詳情見(jiàn) 5.20節(jié) 任務(wù)查詢接口

5.18.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.18.5 示例代碼

輸入1

curl -X POST \

https://vcloud.163.com/app/vod/video/clip \

-H "Content-Type: application/json;charset=utf-8" \

-H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" \

-H "Nonce: 1" \

-H "CurTime: 1465723418" \

-H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" \

-d '{

"vid":32,

"format":1,

"samplings":[

{

"start":1,

"end":3

"cropArea":{

"width":120,

"height":120,

"whType":1,

"x":0,

"y":0,

"xyType":1

}

{

"start":4,

"end":6,

"cropArea":{

"width":20,

"height":20,

"whType":2,

"x":0,

"y":0,

"xyType":1

}

{

"start":8,

"end":9

{

"start":12,

"end":13

{

"start":21,

"end":23

}

"userDefInfo":"userId=123456"

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {

"taskId": 5

}

5.18.6 結(jié)果回調(diào)

視頻裁剪的生成為異步處理，處理完成會(huì)回調(diào)給請(qǐng)求參數(shù)設(shè)置的callbackUrl，如果未設(shè)置，回調(diào)給默認(rèn)的裁剪地址。

視頻裁剪回調(diào)內(nèi)容示例

{

"videoClipJobResult":[

{

"sampling":{

"start":1,

"end":3,

"cropArea":{

"width":120,

"height":120,

"whType":1,

"x":0,

"y":0,

"xyType":1

}

"status":"SUCCESS",

"vid":111

{

"sampling":{

"start":4,

"end":6,

"cropArea":{

"width":20,

"height":20,

"whType":2,

"x":0,

"y":0,

"xyType":1

}

"status":"SUCCESS",

"vid":112

{

"sampling":{

"start":8,

"end":9

"status":"FAILED",

"msg":"Fail"

}

"type":"VIDEO_CLIP",

"originVid":1021,

"user_defined":"userId=123456",

"requestId":"vode49fdc9a-d59d-480d-b3ef-c91b37f8f664"

}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

type

String

回調(diào)類型，視頻裁剪生成回調(diào)固定為“VIDEO_CLIP”

originVid

Long

原始視頻文件視頻標(biāo)識(shí)

user_defined

String

用戶自定義字段值

requestId

String

用戶調(diào)用視頻裁剪接口時(shí)返回的請(qǐng)求標(biāo)識(shí)

videoClipJobResult

Json對(duì)象

視頻裁剪任務(wù)結(jié)果

videoClipJobResult參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

說(shuō)明

sampling

String

采樣的視頻時(shí)間區(qū)間

status

String

狀態(tài)，FAILED 處理失敗 SUCCESS 處理成功

vid

Long

采樣區(qū)間生成的對(duì)應(yīng)視頻ID

注意：sampling為實(shí)際生成視頻的區(qū)間，例如設(shè)置區(qū)間[1, 11] 但是視頻實(shí)際時(shí)長(zhǎng)只有10,則返回的區(qū)間是[1,10]

5.19 視頻合并

5.19.1 接口描述

域名：vcloud.163.com

接口名：POST /app/vod/nts/merge

1.視頻合并，來(lái)源視頻必須是點(diǎn)播庫(kù)中的視頻，參數(shù)為vid視頻id；

2.僅支持一次性合并20個(gè)視頻；

3.來(lái)源視頻的總時(shí)長(zhǎng)不得超過(guò)8小時(shí)；

4.因?yàn)閬?lái)源視頻的分辨率、bit等都不盡相同，現(xiàn)在默認(rèn)使用時(shí)長(zhǎng)最長(zhǎng)的視頻的分辨率等參數(shù)；

5.分辨率等比例縮放時(shí)，如果高度為最大時(shí)，寬度使用填充黑邊，反之高度使用填充黑邊(具體可以使用widthCutStyle、heightCutStyle指定)；

例如：最大時(shí)長(zhǎng)的分辨率是1000(寬)800(高),比例是1000/800。其中一個(gè)視頻的分辨率是500300，則等比例縮放到1000*800后，高度不夠的使用填充黑邊；

6.提交后的任務(wù)，可以通過(guò)回調(diào)接口接收回調(diào)信息，也可以通過(guò)taskId主動(dòng)查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)。詳情見(jiàn)5.20節(jié) 任務(wù)查詢接口

5.19.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

videos

Array

是

待合并的視頻列表，參見(jiàn) MergeVideo 參數(shù)說(shuō)明

widthCutStyle

Int

否

參見(jiàn) KeepAspectRatioStyle 參數(shù)說(shuō)明, 默認(rèn)填充黑邊

heightCutStyle

Int

否

參見(jiàn) KeepAspectRatioStyle 參數(shù)說(shuō)明, 默認(rèn)填充黑邊

callbackUrl

String

否

處理完成后回調(diào)的URL地址(需標(biāo)準(zhǔn)http格式)

userDefInfo

String

否

用戶自定義信息，回調(diào)會(huì)返回此信息

MergeVideo 參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

必須

說(shuō)明

vid

Long

是

視頻id

KeepAspectRatioStyle 參數(shù)詳細(xì)說(shuō)明

參數(shù)值

類型

說(shuō)明

Int

填充黑邊

Int

平均切割

Int

如果要切寬的時(shí)候只切左邊保留右邊

Int

如果要切寬的時(shí)候只切右邊保留左邊

Int

如果要切高的時(shí)候只切上邊保留下邊

Int

如果要切高的時(shí)候只切下邊保留上邊

注：callbackUrl如果不設(shè)置，會(huì)采用默認(rèn)的視頻合并地址回調(diào)。默認(rèn)視頻合并地址回調(diào)設(shè)置接口參考 9.3節(jié) 設(shè)置回調(diào)地址接口

5.19.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

請(qǐng)求標(biāo)識(shí)

code

Int

狀態(tài)碼

taskId

Long

任務(wù)標(biāo)識(shí)

msg

String

錯(cuò)誤信息

5.19.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.19.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"videos":[{"vid":123}],"widthCutStyle":1,"heightCutStyle":3,"userDefInfo":"job_id:123132"}' https://vcloud.163.com/app/vod/nts/merge

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {

"taskId": 5

}

5.19.6 結(jié)果回調(diào)

視頻合并的生成為異步處理，處理完成會(huì)回調(diào)給請(qǐng)求參數(shù)設(shè)置的callbackUrl，如果未設(shè)置，回調(diào)給默認(rèn)的視頻合并地址。

視頻裁剪回調(diào)內(nèi)容示例

{

"taskId" : 214123123,

"status": "SUCCESS",

"failMsg": "asdasdasd",

"vid": 1010,

"jobRequestId": "vod213asdd12313asd123123" //任務(wù)追蹤用

}

注意：請(qǐng)以實(shí)際收到的body字段為準(zhǔn)，以下僅為body字段示例。

參數(shù)

類型

說(shuō)明

taskId

Long

媒體處理任務(wù)標(biāo)識(shí)

status

String

任務(wù)狀態(tài)，SUCCESS表示成功

vid

Long

合并后的視頻文件標(biāo)識(shí)

failMsg

String

失敗原因

jobRequestId

String

用戶調(diào)用視頻合并接口時(shí)返回的請(qǐng)求標(biāo)識(shí)

5.20 任務(wù)查詢

5.20.1 接口描述

域名：vcloud.163.com

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

通過(guò)任務(wù)ID查詢?nèi)蝿?wù)執(zhí)行狀況。僅支持查詢最近7天的任務(wù)信息。

5.20.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

taskId

Long

是

任務(wù)標(biāo)識(shí)

5.20.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

請(qǐng)求標(biāo)識(shí)

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

ret

JSON對(duì)象

結(jié)果集，JSON對(duì)象

ret.task

JSON對(duì)象

任務(wù)執(zhí)行狀況

input

JSON對(duì)象

任務(wù)輸入

input.vid

Long

任務(wù)輸入視頻標(biāo)識(shí)

result

JSON對(duì)象

任務(wù)輸出結(jié)果

result.videoClipJobResult

JSON對(duì)象

視頻裁剪任務(wù)結(jié)果，參見(jiàn)videoClipJobResultg參數(shù)詳細(xì)說(shuō)明

status

String

任務(wù)狀態(tài)： INIT表示提交中，FAILED表示處理失敗， PROCESSING表示處理中， SUCCESS表示處理成功

taskId

Long

任務(wù)標(biāo)識(shí)

type

String

任務(wù)類型： VIDEO_CLIP表示視頻裁剪任務(wù)， MERGE_VIDEO表示視頻合并任務(wù)

userDefinedInfo

String

用戶自定義信息

failMsg

String

失敗原因

createTime

String

任務(wù)創(chuàng)建時(shí)間 yyyy-MM-dd HH:mm:ss

endTime

String

任務(wù)結(jié)束時(shí)間 yyyy-MM-dd HH:mm:ss

videoClipJobResult參數(shù)詳細(xì)說(shuō)明

參數(shù)

類型

說(shuō)明

sampling

String

采樣的視頻時(shí)間區(qū)間

status

String

狀態(tài)，FAILED表示處理失敗， SUCCESS表示處理成功

vid

Long

采樣區(qū)間生成的對(duì)應(yīng)視頻ID

注意：sampling為實(shí)際生成視頻的區(qū)間，例如設(shè)置區(qū)間[1, 11] 但是視頻實(shí)際時(shí)長(zhǎng)只有10,則返回的區(qū)間是[1,10]

5.20.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.20.5 示例代碼

輸入1

視頻裁剪任務(wù)查詢輸出

"Content-Type": "application/json; charset=utf-8"

{

"ret": {

"task": {

"createTime": "2018-11-22 15:32:55",

"endTime": "2018-11-22 15:33:02",

"failMsg": "",

"input": {

"vid": 24

"result": {

"videoClipJobResult": [

{

"sampling": {

"start": 1,

"end": 3

"status": "SUCCESS",

"vid": 111

{

"sampling": {

"start": 4,

"end": 6

"status": "SUCCESS",

"vid": 112

{

"sampling": {

"start": 8,

"end": 9

"status": "FAILED",

"msg": "Fail"

}

]

"status": "SUCCESS",

"taskId": 1,

"type": "VIDEO_CLIP",

"userDefinedInfo": ""

}

"requestId": "vodc90605aa-24c4-4e17-8b07-0a041a0506d9",

"code": 200

}

視頻合并任務(wù)查詢輸出

"Content-Type": "application/json; charset=utf-8"

{

"ret": {

"task": {

"createTime": "2018-12-06 17:51:34",

"endTime": "2018-12-06 17:52:22",

"failMsg": "",

"result": {

"vid": 1

"status": "SUCCESS",

"taskId": 1,

"type": "MERGE_VIDEO",

"userDefinedInfo": "auto視頻合并"

}

"requestId": "vod8867f143-a5b3-4e11-a234-1e2025af61e3",

"code": 200

}

5.21 圖片查詢接口

查詢上傳的圖片信息

5.21.1 接口描述

用于查詢通過(guò)上傳接口上傳的圖片和水印文件

域名：vcloud.163.com

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

5.21.2 輸入?yún)?shù)

參數(shù)

類型

是否必傳

說(shuō)明

currentPage

int

是

當(dāng)前頁(yè)，大于等于1

pageSize

int

是

取值[1,1000]

5.21.3 輸出參數(shù)

ret返回參數(shù)

參數(shù)

類型

說(shuō)明

totalRecords

Long

所有圖片的數(shù)量

pageSize

Int

一頁(yè)的記錄數(shù)目

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageNum

Int

總頁(yè)數(shù)

list

JsonObject

返回圖片對(duì)象

圖片對(duì)象參數(shù)

參數(shù)

類型

說(shuō)明

imageId

long

objectKey

string

對(duì)象名稱

width

int

圖片寬

height

int

圖片高

5.21.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

724

部分刪除操作成功

5.21.5 示例代碼

請(qǐng)求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: et4b4r" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":100}' https://vcloud.163.com/app/vod/image/list

返回示例

{

"ret": {

"pageSize": 2,

"totalRecords": 8,

"list": [

{

"imageId": 1,

"objectKey": "key1",

"width":1280,

"height":720

{

"imageId": 2,

"objectKey": "key2",

"width":640,

"height":360

}

"currentPage": 1,

"pageNum": 4

"code": 200

}

5.22 截圖查詢接口

查詢視頻的截圖信息

5.22.1 接口描述

查詢某視頻的截圖信息

域名：vcloud.163.com

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

5.22.2 輸入?yún)?shù)

參數(shù)

類型

是否必傳

說(shuō)明

vid

long

是

視頻vid

5.22.3 輸出參數(shù)

ret返回參數(shù)

參數(shù)

類型

說(shuō)明

list

JsonObject

截圖對(duì)象信息

list截圖參數(shù)

參數(shù)

類型

說(shuō)明

snapshotId

long

vid

long

vid

objectKey

string

對(duì)象名稱

width

int

圖片寬

height

int

圖片高

5.22.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

5.22.5 示例代碼

請(qǐng)求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: ert24" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":100003}' https://vcloud.163.com/app/vod/snapshot/get

返回示例

{

"ret": {

"list": [

{

"snapshotId": 1,

"vid":100003,

"objectKey": "key1",

"width":1280,

"height":720

{

"snapshotId": 2,

"vid":100003,

"objectKey": "key2",

"width":640,

"height":360

}

]

"code": 200

}

5.23 刪除圖片或截圖

刪除上傳的圖片或者視頻截圖

5.23.1 接口描述

刪除上傳的圖片，水印或者刪除某視頻下的所有截圖，或者刪除某個(gè)指定id的截圖

域名：vcloud.163.com

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

5.23.2 輸入?yún)?shù)

參數(shù)

類型

是否必填

描述

deleteIdType

string

是

image：表示傳入的id為imageId；

video：表示傳入的id為vid，此時(shí)會(huì)刪除這個(gè)vid下面的所有截圖；

snapshot：表示傳入的id為snapshotId

ids

long array

是

刪除指定id的圖片，最多傳100個(gè)

5.23.3 輸出參數(shù)

無(wú)特殊返回值

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

5.23.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

724

部分刪除操作成功

5.23.5 示例代碼

請(qǐng)求示例

// 刪除視頻截圖

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"video","ids":[10002,10004]}' https://vcloud.163.com/app/vod/picture/delete

// 刪除image

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"image","ids":[345]}' https://vcloud.163.com/app/vod/picture/delete

// 刪除截圖

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"snapshot","ids":[2345,567,8889]}' https://vcloud.163.com/app/vod/picture/delete

返回示例

{

"ret": {},

"code": 200

}

6 數(shù)據(jù)查詢

數(shù)據(jù)查詢模塊主要展示流量、帶寬、存儲(chǔ)統(tǒng)計(jì)的查詢功能。

6.1 流量統(tǒng)計(jì)查詢

6.1.1 接口描述

域名：vcloud.163.com

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

用于查詢點(diǎn)播的流量使用統(tǒng)計(jì)數(shù)據(jù)(查詢的開(kāi)始時(shí)間不能超過(guò)當(dāng)前時(shí)刻90天，且不能查詢當(dāng)天數(shù)據(jù))。

6.1.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

startDate

Long

是

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

是

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

是

獲取流量數(shù)據(jù)列表分頁(yè)后的索引

pageSize

Int

是

獲取流量數(shù)據(jù)列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

6.1.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

totalFlow

Double

查詢時(shí)段的總流量(單位：GB)

startDate

Long

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取流量數(shù)據(jù)的數(shù)目

list

List

流量數(shù)據(jù)列表

list.begintime

Long

起始時(shí)間(單位：毫秒)

list.endtime

Long

結(jié)束時(shí)間(單位：毫秒)

list.flow

Double

流量值(單位：GB)

msg

String

錯(cuò)誤信息

6.1.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

6.1.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/flow

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"totalFlow" : 1234.23,

"type" : 2,

"flowList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062400000,

"flow" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

6.2 帶寬統(tǒng)計(jì)查詢

6.2.1 接口描述

域名：vcloud.163.com

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

用于查詢點(diǎn)播的帶寬使用統(tǒng)計(jì)數(shù)據(jù)。

返回的數(shù)據(jù)粒度根據(jù)查詢的結(jié)束時(shí)間戳與開(kāi)始時(shí)間戳之差的大小不同而有所不同：若時(shí)間差為0~1天，則按每十分鐘一個(gè)打點(diǎn)數(shù)據(jù)返回；若時(shí)間差為2~7天，則按每小時(shí)一個(gè)打點(diǎn)數(shù)據(jù)返回；若時(shí)間差為8~31天，則按每四小時(shí)一個(gè)打點(diǎn)數(shù)據(jù)返回；若時(shí)間差為32~366天，則按每天一個(gè)打點(diǎn)數(shù)據(jù)返回。另外，查詢的開(kāi)始時(shí)間不能超過(guò)當(dāng)前時(shí)刻60天，且不能查詢當(dāng)天數(shù)據(jù)。

6.2.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

startDate

Long

是

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

是

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

是

獲取帶寬數(shù)據(jù)列表分頁(yè)后的索引

pageSize

Int

是

獲取帶寬數(shù)據(jù)列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

6.2.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

maxBand

Double

查詢時(shí)段的最大帶寬值(單位：Mb/s)

startDate

Long

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取帶寬數(shù)據(jù)的數(shù)目

bandList

List

獲取的帶寬列表

bandList.begintime

Long

起始時(shí)間(單位：毫秒)

bandList.endtime

Long

結(jié)束時(shí)間(單位：毫秒)

bandList.band

Double

帶寬值(單位：Mb/s)

msg

String

錯(cuò)誤信息

6.2.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

6.2.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":2,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/band

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"maxBand" : 1234.23,

"type" : 2,

"bandList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062400000,

"band" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

6.3 存儲(chǔ)統(tǒng)計(jì)查詢

6.3.1 接口描述

域名：vcloud.163.com

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

用于查詢點(diǎn)播的存儲(chǔ)使用統(tǒng)計(jì)數(shù)據(jù)(查詢粒度為天，查詢的開(kāi)始時(shí)間不能超過(guò)當(dāng)前時(shí)刻90天，且不能查詢當(dāng)天數(shù)據(jù))。

6.3.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

startDate

Long

是

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

是

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

是

獲取存儲(chǔ)數(shù)據(jù)列表分頁(yè)后的索引

pageSize

Int

是

獲取存儲(chǔ)數(shù)據(jù)列表一頁(yè)的記錄數(shù)，取值范圍：[1,500]

6.3.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

totalStorage

Double

查詢時(shí)段的總存儲(chǔ)量(單位：GB)

startDate

Long

需要查詢的開(kāi)始時(shí)間戳(單位：毫秒)

endDate

Long

需要查詢的結(jié)束時(shí)間戳(單位：毫秒)

currentPage

Int

當(dāng)前取得頁(yè)數(shù)

pageSize

Int

一頁(yè)的記錄數(shù)目

pageNum

Int

總頁(yè)數(shù)

totalRecords

Int

獲取存儲(chǔ)數(shù)據(jù)的數(shù)目

type

Int

統(tǒng)計(jì)粒度(2：每天)

storageList

List

獲取的存儲(chǔ)列表

storageList.begintime

Long

起始時(shí)間(單位：毫秒)

storageList.endtime

Long

結(jié)束時(shí)間(單位：毫秒)

storageList.storage

Double

存儲(chǔ)量(單位：GB)

msg

String

錯(cuò)誤信息

6.3.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足。

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

6.3.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/storage

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"totalStorage" : 1234.23,

"type" : 2,

"storageList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062399999,

"storage" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

7 移動(dòng)端終端用戶管理

7.1 概述

網(wǎng)易視頻云官網(wǎng)API適用于業(yè)務(wù)服務(wù)器調(diào)用，為滿足業(yè)務(wù)服務(wù)器的終端用戶上傳視頻以及點(diǎn)播加密等需求，視頻云提供了移動(dòng)端終端用戶的管理API，方便企業(yè)管理其終端用戶使用視頻云的服務(wù)。

7.2 使用說(shuō)明

8 視頻安全

視頻安全模塊主要展示有關(guān)視頻版權(quán)保護(hù)方面的功能開(kāi)通、API調(diào)用和代碼示例。網(wǎng)易云為開(kāi)發(fā)者提供防盜鏈、回源鑒權(quán)、視頻內(nèi)容加密等多種安全機(jī)制，保障客戶的視頻版權(quán)不被輕易盜用。

8.1 防盜鏈

8.1.1 概述

點(diǎn)播防盜鏈?zhǔn)侵冈邳c(diǎn)播視頻播放地址中通過(guò)添加鑒權(quán)字符串的方式，來(lái)校驗(yàn)地址合法性的一種防止視頻被盜播的方式。開(kāi)通防盜鏈功能后，視頻播放地址中需要包含一段鑒權(quán)字符串，只有合法生成的鑒權(quán)串，才可以通過(guò)校驗(yàn)從而播放，且該地址有時(shí)效性，只在設(shè)定的有效期內(nèi)可播放。這樣即使別人獲取到已失效的地址，也是無(wú)法繼續(xù)使用的，防止別人盜播視頻。如果已經(jīng)使用有效的地址正在播放，不會(huì)因?yàn)榈刂烦瑫r(shí)失效而受影響。

8.1.2 使用說(shuō)明

8.2 回源鑒權(quán)

8.2.1 概述

回源鑒權(quán)是一種保護(hù)用戶視頻內(nèi)容安全的功能。通過(guò)使用回源鑒權(quán)功能，用戶可實(shí)時(shí)自行生成視頻文件播放鏈接，該鏈接在用戶指定時(shí)間內(nèi)可用，從而有效保護(hù)視頻內(nèi)容。如果在使用回源鑒權(quán)功能之前，用戶已經(jīng)發(fā)布了播放地址，則在使用回源鑒權(quán)功能后，之前的播放地址不可用。用戶需要通過(guò)動(dòng)態(tài)生成鏈接以訪問(wèn)視頻文件。

8.2.2 兩種回源鑒權(quán)方式

網(wǎng)易視頻云提供了兩種回源鑒權(quán)方式，二者的區(qū)別僅僅在于生成地址的方法不同，其各自生成的播放地址具有完全相同的保護(hù)效用，用戶可根據(jù)自身需要進(jìn)行選擇。

8.3視頻加密

8.3.1 概述

視頻加密是一種保護(hù)視頻內(nèi)容安全的功能。通過(guò)將視頻的內(nèi)容進(jìn)行加密，用戶必須使用網(wǎng)易視頻云播放SDK才能實(shí)現(xiàn)視頻的觀看，從而有效保護(hù)視頻內(nèi)容。

8.3.2 使用說(shuō)明

9 回調(diào)管理

回調(diào)是網(wǎng)易云提供的一種異步通知方式，用戶可設(shè)置回調(diào)地址，網(wǎng)易云完成某個(gè)特定任務(wù)后會(huì)將運(yùn)行結(jié)果發(fā)送至設(shè)置的回調(diào)地址，用戶可在收到回調(diào)后執(zhí)行相應(yīng)的業(yè)務(wù)邏輯。用戶可參考3.6節(jié)設(shè)置上傳回調(diào)地址，參考4.12節(jié)設(shè)置轉(zhuǎn)碼回調(diào)地址。回調(diào)管理模塊提供了回調(diào)地址的查詢和刪除功能，方便用戶查看或刪除回調(diào)地址。

9.1 回調(diào)地址查詢

9.1.1 接口描述

域名：vcloud.163.com

接口名：/app/vod/callback/getUrl

用于查詢指定類型的回調(diào)地址。

9.1.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

type

Int

是

回調(diào)地址類型：1表示轉(zhuǎn)碼回調(diào)，2表示上傳回調(diào)，5表示視頻合并回調(diào)，6表示視頻裁剪回調(diào)

9.1.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

callbackUrl

String

回調(diào)地址

lastUpdateTime

String

最近更新時(shí)間(yyyy-MM-dd HH:mm:ss)

msg

String

錯(cuò)誤信息

9.1.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

9.1.5 示例代碼

輸入1

輸出1

{

"ret": {

"callbackUrl": "http://123456xxxx",

"lastUpdateTime": "2019-01-15 14:01:14"

"code": 200

}

9.2 刪除回調(diào)地址

9.2.1 接口描述

域名：vcloud.163.com

接口名：/app/vod/callback/delUrl

用于刪除指定類型的回調(diào)地址，調(diào)用本接口后，您不會(huì)再收到相應(yīng)類型的回調(diào)信息。

9.2.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

type

Int

是

回調(diào)地址類型：1表示轉(zhuǎn)碼回調(diào)，2表示上傳回調(diào)，5表示視頻合并回調(diào)，6表示視頻裁剪回調(diào)

9.2.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

9.2.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

711

請(qǐng)求參數(shù)非法，具體信息見(jiàn)msg

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

9.2.5 示例代碼

輸入1

輸出1

{

"code": 200

}

9.3 設(shè)置回調(diào)地址

網(wǎng)易視頻云點(diǎn)播的回調(diào)通知分為單個(gè)級(jí)別和用戶級(jí)別，且處理優(yōu)先級(jí)為：單個(gè)級(jí)別->用戶級(jí)別->無(wú)回調(diào)。當(dāng)用戶設(shè)置了單個(gè)級(jí)別的回調(diào)地址，使用單個(gè)級(jí)別的回調(diào)地址；否則查詢是否設(shè)置用戶級(jí)別的回調(diào)地址，如果設(shè)置，使用用戶級(jí)別的回調(diào)地址；否則不回調(diào)通知。單個(gè)級(jí)別的回調(diào)通知在上傳初始化中指定，用戶級(jí)別的回調(diào)通知可通過(guò)本接口設(shè)置。

9.3.1 接口描述

域名：vcloud.163.com

接口名：POST /app/vod/callback/setUrl

用于設(shè)置指定類型的回調(diào)地址。

9.3.2 輸入?yún)?shù)

參數(shù)

類型

必須

說(shuō)明

type

Int

是

回調(diào)地址類型，1表示轉(zhuǎn)碼回調(diào)，2表示上傳回調(diào)，5表示視頻合并回調(diào)，6表示視頻裁剪回調(diào)

callbackUrl

String

是

處理完成后回調(diào)的URL地址(需標(biāo)準(zhǔn)http格式)

signKey

String

否

媒體處理成功后回調(diào)客戶端的簽名字符串，要求是由字母和數(shù)字組成且不超過(guò)32位

9.3.3 輸出參數(shù)

參數(shù)

類型

說(shuō)明

requestId

String

請(qǐng)求標(biāo)識(shí)

code

Int

狀態(tài)碼

msg

String

錯(cuò)誤信息

9.3.4 響應(yīng)狀態(tài)碼

狀態(tài)碼

含義

200

操作成功

400

請(qǐng)求報(bào)文格式錯(cuò)誤，報(bào)文構(gòu)造不正確或者沒(méi)有完整發(fā)送

700

服務(wù)器內(nèi)部出現(xiàn)錯(cuò)誤，請(qǐng)稍后重試或者將完整錯(cuò)誤信息發(fā)送給客服人員幫忙解決

710

權(quán)限認(rèn)證失敗，請(qǐng)參考文檔中的接口鑒權(quán)部分

720

訪問(wèn)失敗，余額不足

721

服務(wù)未開(kāi)通，請(qǐng)前往開(kāi)通頁(yè)面申請(qǐng)服務(wù)開(kāi)通

722

服務(wù)開(kāi)通審核中，請(qǐng)聯(lián)系客服人員開(kāi)通服務(wù)

723

請(qǐng)求的次數(shù)超過(guò)了配額限制

9.3.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"type":1,"callbackUrl":"http://123456xxxx"}' https://vcloud.163.com/app/vod/callback/setUrl

輸出1

"Content-Type": "application/json; charset=utf-8"

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200

}

本篇文檔內(nèi)容是否對(duì)您有幫助？

有幫助

我要吐槽

如果遇到產(chǎn)品相關(guān)問(wèn)題，您可提交工單或在線客服尋求幫助。

您的改進(jìn)建議

問(wèn)題類型

內(nèi)容錯(cuò)誤

內(nèi)容沒(méi)更新

描述不清

鏈接有誤

步驟不完整

內(nèi)容缺失(缺少代碼/示例)

其他

更多建議

請(qǐng)輸入您的建議或問(wèn)題(至少5個(gè)字符，至多500個(gè)字符)

聯(lián)系方式

標(biāo)記內(nèi)容

同時(shí)提交標(biāo)記內(nèi)容

提交

此文檔對(duì)你是否有幫助

有幫助

我要吐槽

反饋成功

非常感謝您的反饋，我們會(huì)繼續(xù)努力做得更好。

總結(jié)

以上是生活随笔為你收集整理的云信api_服务端API文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇： INC和DEC为什么不影响状态标志位
下一篇：一维最大熵阈值分割法原理及实现