當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

云信api_服务端API文档

發布時間：2024/8/1 编程问答 27 豆豆

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

點播服務端API文檔

1 調用方式

1.1 請求說明

1.1.1 服務地址

網易視頻云點播服務使用的域名訪問地址為：vcloud.163.com。

1.1.2 通信協議

網易視頻云點播服務的所有接口均通過HTTPS進行通信，提供高安全性的通信通道。

重要提示：獲取上傳加速節點和斷點續傳查詢斷點接口除外，只支持HTTP通信。

1.1.3 請求方法

所有接口都只支持POST請求。

重要提示：獲取上傳加速節點和斷點續傳查詢斷點接口除外，為GET請求。

1.1.4 字符編碼

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

1.2 公共參數

所有接口均需要放置以下公共參數在請求頭中，用于標識用戶和接口鑒權。后續的接口說明不再對這些參數進行說明，但每次發起請求均需要攜帶。

參數

類型

必須

說明

AppKey

String

是

開發者平臺分配的AppKey

Nonce

String

是

隨機數(隨機數，最大長度128個字符)

CurTime

String

是

當前UTC時間戳，從1970年1月1日0點0分0秒開始到現在的秒數

CheckSum

String

是

服務器認證需要，SHA1(AppSecret+Nonce+CurTime)，16進制字符小寫

重要提示：獲取上傳加速節點、文件數據上傳、斷點續傳查詢斷點三個接口，不使用上述公共參數。

1.3 接口鑒權

接口通過請求頭中的公共參數進行鑒權。登錄網易云控制臺，點擊應用名稱 > 右側[App Key管理]，即可查看AppKey和AppSecret，通過該安全憑證進行SHA1(AppSecret+Nonce+CurTime)計算。

重要提示: 本文檔中提供的所有接口均面向開發者服務器端調用，用于計算CheckSum的AppSecret開發者應妥善保管,可在應用的服務器端存儲和使用，但不應存儲或傳遞到客戶端，也不應在網頁等前端代碼中嵌入。

計算CheckSum的java代碼舉例如下：

import java.security.MessageDigest;

public class CheckSumBuilder {

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

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

}

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

if (value == null) {

return null;

}

try {

MessageDigest messageDigest = MessageDigest.getInstance(algorithm);

messageDigest.update(value.getBytes());

return getFormattedText(messageDigest.digest());

} catch (Exception e) {

throw new RuntimeException(e);

}

private static String getFormattedText(byte[] bytes){

int len = bytes.length;

StringBuilder buf = new StringBuilder(len * 2);

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

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

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

}

return buf.toString();

}

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

}

1.4 返回說明

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

名稱

類型

說明

code

Int

返回結果的狀態碼

ret

String

返回的結果集

msg

String

當返回結果的狀態碼不為200時，包含的錯誤信息

重要提示：獲取上傳加速節點、文件數據上傳、斷點續傳查詢斷點三個接口除外。

1.5 接口頻率說明

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

2 調用流程

3 文件上傳

文件上傳模塊主要展示通過服務端API進行文件上傳的API調用、回調和代碼示例(含斷點續傳)。除服務端API調用上傳外，也可通過登錄控制臺進行網頁上傳，或接入上傳SDK進行上傳。

3.1 文件上傳初始化

3.1.1 接口描述

域名：vcloud.163.com

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

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

3.1.2 輸入參數

參數

類型

必須

說明

originFileName

String

是

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

userFileName

String

否

用戶命名的上傳文件名稱

typeId

Int

否

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

presetId

Int

否

視頻所需轉碼模板Id(不填寫為默認模板，默認模板不進行轉碼)

uploadCallbackUrl

String

否

上傳成功后回調客戶端的URL地址(需標準http格式)

callbackUrl

String

否

轉碼成功后回調客戶端的URL地址(需標準http格式)

description

String

否

上傳視頻的描述信息

watermarkId

Int

否

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

請務必在水印管理中提前完成水印圖片的上傳和參數的配置；

且必需設置prestId字段，且presetId字段不為默認模板)

userDefInfo

String

否

用戶自定義信息，回調會返回此信息(長度不能超過256字符)

transOffset

Int

否

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

transDuration

Int

否

視頻轉碼處理裁剪視頻的視頻時長(單位：秒)

3.1.3 輸出參數

參數

類型

說明

code

Int

狀態碼

xNosToken

String

上傳憑證

bucket

String

存儲上傳文件的桶名

object

String

存儲上傳文件的對象名

msg

String

錯誤信息

3.1.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

3.1.5 示例代碼

輸入1

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

輸出1

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

{

"code" : 200,

"ret" : {

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

"bucket" : "vodk32ywxdf",

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

}

3.2 獲取上傳加速節點地址

3.2.1 接口描述

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

用于獲取上傳加速節點地址。

3.2.2 輸入參數

參數

類型

必須

說明

version

String

是

API版本號，填寫固定值1.0

bucketname

String

是

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

3.2.3 輸出參數

參數

類型

說明

lbs

String

httpDNS的IP訪問地址，用于避免后續查詢的DNS解析時間、以及域名劫持

upload

List

上傳節點列表(前面的優先級高)

3.2.4 響應狀態碼

參數

類型

說明

Code

String

錯誤代碼

Message

String

錯誤描述信息

3.2.5 示例代碼

輸入1

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

輸出1

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

3.3 文件數據上傳

上傳一塊數據，此接口通過指定offset實現斷點續傳功能。用戶每次上傳要以服務器端返回的offset為準續傳余下數據。

需注意以下事項：

大文件需要自行分片上傳，分片大小不超過4MB，請求相同接口，注意參數的填寫。

如果需要斷點續傳，需保存 context 值，根據 context 值查詢斷點值，然后繼續使用此接口。

包體數據為二進制數據。

3.3.1 接口描述

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

重要提示：{UploadHost}值為獲取的上傳加速節點地址，{bucket}值為存儲對象的桶名，{object}值為生成的唯一對象名。

3.3.2 輸入參數

參數

類型

必須

說明

x-nos-token

String

是

請求頭參數，上傳token

Content-Length

long

否

請求頭參數，當前片的內容長度，

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

否則返回400 httpcode給客戶端，拒絕本次請求

Content-Type

String

否

請求頭參數，標準http頭。表示請求內容的類型，

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

Content-MD5

String

否

請求頭參數，文件內容md5值

bucket

String

是

存儲對象的桶名

object

String

是

生成的唯一對象名

offset

long

是

當前分片在整個對象中的起始偏移量，單位：字節(Byte)

complete

String

是

是否為最后一塊數據。合法值：true/false

version

String

是

http api版本號。這里是固定值1.0

context

String

是

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

上傳端不應修改其內容。

注意：用戶第一次上傳應不帶此參數或置為空字符串，

之后上傳剩余部分數據都需要帶上這個參數。

context對應的桶名或者對象名不匹配返回400 code

3.3.3 輸出參數

3.3.3.1 響應成功輸出參數

參數

類型

必須

說明

requestId

String

是

uuid字符串，服務器端生成的唯一UUID

offset

long

是

下一個上傳片在上傳塊中的偏移。

注意：偏移從0開始，比如：用戶上傳0-128字節后，

服務器返回的offset為128，下一次上傳offset值應置為128

context

String

是

上傳上下文

callbackRetMsg

String

是

上傳回調信息

3.3.3.2 響應失敗輸出參數

參數

類型

說明

requestId

String

uuid字符串，服務器端生成的唯一UUID

errMsg

String

錯誤描述信息

3.3.4 響應狀態碼

狀態碼

含義

200

上傳分片成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

403

上傳憑證無效。token過期服務器會返回此狀態碼，用戶需要重新申請token

500

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

520

回調失敗

3.3.5 示例代碼

輸入1

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

輸出1

{

"requestId":"be82c2a0dffc000000005770a189d831",

"offset":4194304,

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

"callbackRetMsg":""

}

3.4 斷點續傳查詢斷點

根據上傳上下文查詢對應分片上傳當前續傳的offset，上下文要與bucketName/objectName匹配，否則返回400狀態碼。(bucketName和objectName要進行URL編碼,字符編碼格式使用utf-8)。

3.4.1 接口描述

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

重要提示：{UploadHost}值為獲取的上傳加速節點地址，{bucket}值為存儲對象的桶名，{object}值為生成的唯一對象名。

3.4.2 輸入參數

參數

類型

必須

說明

x-nos-token

String

是

上傳token

bucketName

String

是

存儲對象的桶名

objectName

String

是

生成的唯一對象名

context

String

是

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

上傳端不應修改其內容。對應context在服務端不存在則返回404。

context對應的桶名或者對象名不匹配返回400 code。

version

String

是

http api版本號。這里是固定值1.0

3.4.3 輸出參數

3.4.3.1 響應成功輸出參數

參數

類型

必須

說明

requestId

String

是

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

offset

long

是

下一個上傳片在上傳塊中的偏移

3.4.3.2 響應失敗輸出參數

參數

類型

說明

requestId

String

uuid字符串，服務器端生成的唯一UUID

errMsg

String

錯誤描述信息

3.4.4 響應狀態碼

狀態碼

含義

200

上傳分片成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

403

上傳憑證無效。token過期服務器會返回此錯誤碼，用戶需要重新申請token

500

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

404

對應context上傳不存在

3.4.5 示例代碼

輸入1

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

輸出1

{

"requestId":"be82c2a0dffc000000005770a189d832",

"offset":4194304

}

3.5 上傳完成根據對象名查詢視頻或水印圖片主Id

3.5.1 接口描述

域名：vcloud.163.com

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

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

3.5.2 輸入參數

參數

類型

必須

說明

objectNames

List

是

上傳文件的對象名列表

3.5.3 輸出參數

參數

類型

說明

code

Int

狀態碼

list

List

對象名和視頻Id對應的列表

list.vid

Long

視頻主Id

list.imgId

Int

視頻水印圖片Id

list.objectName

String

存儲上傳文件的對象名

msg

String

錯誤信息

3.5.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

3.5.5 示例代碼

輸入1

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

輸出1

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

{

"code" : 200,

"ret" : {

list : [

{

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

"vid" : 1008

}

]

}

3.6 設置上傳回調地址

3.6.1 上傳回調說明

網易視頻云點播的上傳回調通知分為單個級別和用戶級別，且處理優先級為：單個級別->用戶級別->無回調。當用戶設置了單個級別的回調地址，使用單個級別的回調地址；否則查詢是否設置用戶級別的回調地址，如果設置，使用用戶級別的回調地址；否則不回調通知。單個級別的回調通知在上傳初始化中指定，用戶級別的回調通知可通過本接口設置。

回調通知會在請求頭中增加sign字段，其值為拼接回調包體內容的字符串和簽名字符串，然后對拼接后的字符串進行md5加密(32位小寫)。簽名字符串可通過本接口設置，默認為：vcloud。

目前網易視頻云點播支持上傳成功回調通知。

3.6.2 接口描述

域名：vcloud.163.com

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

用于視頻上傳，設置上傳成功后的回調地址。

3.6.3 輸入參數

參數

類型

必須

說明

callbackUrl

String

是

上傳成功后回調客戶端的URL地址

signKey

String

否

上傳成功后回調客戶端的簽名字符串，要求是由字母和數字組成且不超過32位

3.6.4 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

3.6.5 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

3.6.6 示例代碼

輸入1

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

輸出1

{

"msg" : "",

"code" : 200

}

3.6.7 回調內容示例

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

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，上傳回調固定為“upload”

vid

Long

視頻文件標識

name

String

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

origAddr

String

視頻的播放地址

warnning

String

視頻類型檢測結果，比如視頻類型和上傳指定不一致，mp4和flv類型的視頻不適合流媒體播放拖動等

user_defined

String

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

4 視頻轉碼

視頻轉碼模塊主要展示轉碼相關的API調用和代碼示例。包含轉碼模板的管理、水印模板的管理、視頻轉碼及回調等功能。

4.1 創建視頻轉碼模板

4.1.1 接口描述

域名：vcloud.163.com

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

用于視頻文件轉碼，創建模板。可使用視頻云的默認格式模板或自定義格式參數。

4.1.2 輸入參數

參數

類型

必須

說明

presetName

String

是

視頻轉碼模板的名稱

sdMp4

Int

是

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

hdMp4

Int

是

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

shdMp4

Int

是

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

copyMp4

Int

否

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

sdFlv

Int

是

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

hdFlv

Int

是

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

shdFlv

Int

是

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

copyFlv

Int

否

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

sdHls

Int

是

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

hdHls

Int

是

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

shdHls

Int

是

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

copyHls

Int

否

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

aacAudio

Int

否

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

mp3Audio

Int

否

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

transConfig

List

否

自定義模板信息，不設置為系統默認轉碼信息

transConfig參數詳細說明

參數

類型

必須

說明

presetType

Int

是

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

video

String

否

視頻流配置，JSON對象，見參數video詳情，若不設置表示轉碼為純音頻格式，對應presetType為16或17

audio

String

否

音頻流配置，JSON對象，見參數audio詳情

segmentTime

Int

否

hls格式的分片時長，取值范圍：1-60，presetType為7、8、9時有效

textMarks

List

否

文字水印配置信息列表，JSON對象，見參數textMarks詳情

參數video詳情

參數

類型

必須

說明

codec

String

否

輸出文件的視頻編解碼格式，包含：libx264，lib265，默認是libx264。其中lib265僅支持mp4和hls格式

bitRate

String

否

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

frameRate

String

否

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

maxWidth

String

否

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

maxHeight

String

否

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

paddingPolicy

String

否

輸出文件的縮放策略，輸出視頻若不能覆蓋maxWidth*maxHeight區域，是否通過填補黑邊將視頻擴充到目標大小。可設置值為：NoPad、Pad，NoPad表示不填補黑邊，Pad表示填補黑邊

參數audio詳情

參數

類型

必須

說明

codec

String

否

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

bitRate

String

否

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

sampleRate

String

否

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

channel

String

否

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

參數textMarks詳情

參數

類型

必須

說明

content

String

是

文字內容

fontName

String

是

字體名字，目前支持：

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

fontSize

Int

否

字體大小，單位px，默認值是24

fontColor

String

否

文字顏色，取值#000000~#FFFFFF，默認值是#FFFFFF

fontOpacity

Float

否

文字透明度，取值范圍0.0～1.0，0.0透明，1.0不透明，默認值是1.0

coordinate

String

否

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

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

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

默認值是5%_5%

shadowX

Int

否

文字陰影x軸偏移量，單位px，默認是0

shadowY

Int

否

文字陰影y軸偏移量，單位px，默認是0

borderWidth

Int

否

文字邊框寬度，單位px，默認是0

borderColor

String

否

文字邊框顏色，取值#000000~#FFFFFF，默認值是#FFFFFF

borderOpacity

Double

否

文字邊框透明度，取值范圍0.0～1.0，0.0透明，1.0不透明，默認值是1.0

4.1.3 輸出參數

參數

類型

說明

code

Int

狀態碼

presetId

Int

新生成的視頻轉碼模板Id

msg

String

錯誤信息

4.1.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.1.5 示例代碼

使用視頻云默認的格式模板請求示例

輸入1

輸出1

{

"ret": {

"presetId": 184

"code": 200

}

使用自定義的格式參數請求示例

輸入2

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

輸出2

{

"ret": {

"presetId": 185

"code": 200

}

4.2 獲取視頻轉碼模板信息

4.2.1 接口描述

域名：vcloud.163.com

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

獲取單個視頻轉碼模板信息，包括：Id、視頻轉碼模板名稱、視頻轉碼模板對應的格式。

4.2.2 輸入參數

參數

類型

必須

說明

presetId

Int

是

視頻轉碼模板Id

4.2.3 輸出參數

參數

類型

說明

code

Int

狀態碼

presetName

String

視頻轉碼模板的名稱

sdMp4

Int

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

hdMp4

Int

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

shdMp4

Int

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

sdFlv

Int

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

hdFlv

Int

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

shdFlv

Int

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

sdHls

Int

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

hdHls

Int

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

shdHls

Int

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

aacAudio

Int

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

mp3Audio

Int

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

isDel

Int

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

transConfig

List

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

msg

String

錯誤信息

4.2.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.2.5 示例代碼

輸入1

輸出1

{

"ret": {

"sdHls": 0,

"isDel": 1,

"shdHls": 0,

"hdHls": 1,

"presetId": 184,

"sdMp4": 0,

"sdFlv": 0,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "全高清",

"hdFlv": 1,

"hdMp4": 1

"code": 200

}

4.3 獲取視頻轉碼模板列表

4.3.1 接口描述

域名：vcloud.163.com

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

獲取視頻轉碼模板列表，并做分頁返回處理。單個視頻轉碼模板的信息包括：Id、視頻轉碼模板名稱、視頻轉碼模板對應的格式。

4.3.2 輸入參數

參數

類型

必須

說明

currentPage

Int

是

獲取視頻轉碼模板列表分頁后的索引

pageSize

Int

是

獲取視頻轉碼模板列表一頁的記錄數，取值范圍：[1,500]

4.3.3 輸出參數

參數

類型

說明

code

Int

狀態碼

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取視頻轉碼模板列表的數目

list

List

獲取的視頻轉碼模板列表

list.presetId

Int

視頻轉碼模板Id

list.presetName

String

視頻轉碼模板的名稱

list.sdMp4

Int

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

list.hdMp4

Int

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

list.shdMp4

Int

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

list.sdFlv

Int

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

list.hdFlv

Int

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

list.shdFlv

Int

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

list.sdHls

Int

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

list.hdHls

Int

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

list.shdHls

Int

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

list.aacAudio

Int

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

list.mp3Audio

Int

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

list.isDel

Int

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

list.transConfig

List

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

4.3.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.3.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 8,

"list": [

{

"sdHls": 0,

"isDel": 0,

"shdHls": 0,

"hdHls": 0,

"presetId": 39,

"sdMp4": 0,

"sdFlv": 0,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "默認模板",

"hdFlv": 0,

"hdMp4": 0

{

"sdHls": 0,

"isDel": 1,

"shdHls": 0,

"hdHls": 0,

"presetId": 40,

"sdMp4": 1,

"sdFlv": 1,

"shdMp4": 0,

"shdFlv": 0,

"presetName": "dd",

"hdFlv": 0,

"hdMp4": 0

}

"currentPage": 1,

"pageNum": 4

"code": 200

}

4.4 修改視頻轉碼模板信息

4.4.1 接口描述

域名：vcloud.163.com

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

用于視頻文件轉碼，修改轉碼模板，可修改：視頻轉碼模板名稱、視頻轉碼模板對應的格式。

4.4.2 輸入參數

參數

類型

必須

說明

presetId

Int

是

視頻轉碼模板的Id

presetName

String

是

視頻轉碼模板的名稱

sdMp4

Int

是

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

hdMp4

Int

是

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

shdMp4

Int

是

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

sdFlv

Int

是

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

hdFlv

Int

是

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

shdFlv

Int

是

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

sdHls

Int

是

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

hdHls

Int

是

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

shdHls

Int

是

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

aacAudio

Int

否

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

mp3Audio

Int

否

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

transConfig

List

否

自定義模板信息，JSON對象，不設置為系統默認轉碼信息

4.4.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

4.4.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.4.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.5 刪除視頻轉碼模板

4.5.1 接口描述

域名：vcloud.163.com

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

刪除視頻轉碼模板。

4.5.2 輸入參數

參數

類型

必須

說明

presetId

Int

是

視頻轉碼模板Id

4.5.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

4.5.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.5.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.6 創建視頻水印模板

4.6.1 接口描述

域名：vcloud.163.com

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

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

4.6.2 輸入參數

參數

類型

必須

說明

watermarkName

String

是

視頻水印的名稱

imageId

Int

是

視頻水印圖片的Id

description

String

否

視頻水印的描述信息

coordinate

String

否

視頻水印左上角的坐標，其值為相對值，比如：

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

如果不選填，默認設置為5%_5%

scale

String

否

視頻水印的長寬，其值為相對值，比如：

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

如果不選填，默認設置為不縮放或拉伸

重要提示：不建議設置水印的scale參數，縮放或拉伸水印圖片會影響水印圖片的效果，可能會出現模糊現象。

4.6.3 輸出參數

參數

類型

說明

code

Int

狀態碼

watermarkId

Int

視頻水印Id

msg

String

錯誤信息

4.6.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.6.5 示例代碼

輸入1

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

輸出1

{

"ret": {

"watermarkId": 16

"code": 200

}

4.7 獲取視頻水印模板信息

4.7.1 接口描述

域名：vcloud.163.com

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

獲取單個視頻水印模板信息，包括：Id、視頻水印模板名稱、視頻水印模板對應的配置參數。

4.7.2 輸入參數

參數

類型

必須

說明

watermarkId

Int

是

視頻水印模板Id

4.7.3 輸出參數

參數

類型

說明

code

Int

狀態碼

watermarkId

Int

視頻水印模板Id

watermarkName

String

視頻水印模板的名稱

description

String

視頻水印的描述信息

coordinate

String

視頻水印左上角的坐標，其值為相對值，比如：

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

如果不選填，默認設置為5%_5%

scale

String

視頻水印的長寬，其值為相對值，比如：

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

如果不選填，默認設置為不縮放或拉伸

imageId

Int

水印圖片Id

imageUrl

String

水印圖片URL

isDel

Int

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

msg

String

錯誤信息

4.7.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.7.5 示例代碼

輸入1

輸出1

{

"ret": {

"scale": null,

"watermarkName": "梅花水印",

"coordinate": "8%_6%",

"description": "梅花水印",

"watermarkId": 16,

"imageId": 21,

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

"isDel": 1

"code": 200

}

4.8 獲取視頻水印模板列表

4.8.1 接口描述

域名：vcloud.163.com

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

獲取視頻水印模板列表，并做分頁返回處理。單個視頻水印模板的信息包括：Id、視頻水印模板名稱、視頻水印模板對應的配置參數。

4.8.2 輸入參數

參數

類型

必須

說明

currentPage

Int

是

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

pageSize

Int

是

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

4.8.3 輸出參數

參數

類型

說明

code

Int

狀態碼

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取視頻水印轉碼模板列表的分類數目

list

List

獲取的視頻水印模板列表

list.watermarkId

Int

視頻水印模板Id

list.watermarkName

String

視頻水印模板的名稱

list.description

String

視頻水印的描述信息

list.coordinate

String

視頻水印左上角的坐標，其值為相對值，比如：

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

如果不選填，默認設置為5%_5%

list.scale

String

視頻水印的長寬，其值為相對值，比如：

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

如果不選填，默認設置為不縮放或拉伸

list.imageId

Int

水印圖片Id

list.imageUrl

String

水印圖片URL

list.isDel

Int

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

4.8.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.8.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 9,

"list": [

{

"scale": "10%x15%",

"watermarkName": "小熊水印",

"coordinate": "20%_12%",

"description": "ss",

"watermarkId": 6,

"imageId": 21,

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

"isDel": 1

{

"scale": "10%x15%",

"watermarkName": "royen_test",

"coordinate": "5%_5%",

"description": null,

"watermarkId": 7,

"imageId": 21,

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

"isDel": 1

}

"currentPage": 1,

"pageNum": 5

"code": 200

}

4.9 修改視頻水印模板

4.9.1 接口描述

域名：vcloud.163.com

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

用于修改水印模板，可修改：視頻轉碼模板名稱、視頻轉碼模板對應的格式。

4.9.2 輸入參數

參數

類型

必須

說明

watermarkId

Int

是

視頻水印模板Id

watermarkName

String

是

視頻水印的名稱

description

String

否

視頻水印的描述信息

coordinate

String

否

視頻水印左上角的坐標，其值為相對值，比如：

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

如果不選填，默認設置為5%_5%

scale

String

否

視頻水印的長寬，其值為相對值，比如：

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

如果不選填，默認設置為不縮放或拉伸

imageId

Int

否

水印圖片Id

4.9.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

4.9.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.9.5 示例代碼

輸入1

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

輸出1

{

"ret": {},

"code": 200

}

4.10 刪除視頻水印模板

4.10.1 接口描述

域名：vcloud.163.com

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

刪除水印模板。

4.10.2 輸入參數

參數

類型

必須

說明

watermarkId

Int

是

視頻水印模板Id

4.10.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

4.10.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.10.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

4.11 視頻文件轉碼

4.11.1 接口描述

域名：vcloud.163.com

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

用于視頻轉碼，批量進行視頻轉碼(只有處于正常或轉碼失敗狀態的視頻才允許執行此操作)。

4.11.2 輸入參數

參數

類型

必須

說明

vids

List

是

多個視頻Id組成的列表

presetId

Int

是

轉碼模板Id

watermarkId

Int

否

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

userDefInfo

String

否

用戶自定義信息，回調會返回此信息

transOffset

Int

否

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

transDuration

Int

否

視頻轉碼處理裁剪視頻的視頻時長(單位：秒)

dynamicTransConfig

List

否

視頻動態轉碼詳細參數配置列表，不設置則以presetId的配置為準，設置則會覆蓋presetId對應的transConfig中相同presetType的配置。詳見參數dynamicTransConfig

參數dynamicTransConfig詳情

參數

類型

必須

說明

presetType

Int

是

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

textMarks

List

否

文字水印配置信息列表，JSON對象，詳見本文4.1.2小節參數textMarks

4.11.3 輸出參數

參數

類型

說明

code

Int

狀態碼

successCount

Int

轉碼成功的數量

failCount

Int

轉碼失敗的數量

passCount

Int

轉碼忽略的數量，即已經存在該轉碼格式視頻

msg

String

錯誤信息

4.11.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.11.5 示例代碼

輸入1

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

輸出1

{

"ret": {

"passCount": 0,

"failCount": 0,

"successCount": 2

"code": 200

}

4.12 設置轉碼回調地址

4.12.1 轉碼回調說明

網易視頻云點播的轉碼回調通知分為單個級別和用戶級別，且處理優先級為：單個級別->用戶級別->無回調。當用戶設置了單個級別的回調地址，使用單個級別的回調地址；否則查詢是否設置用戶級別的回調地址，如果設置，使用用戶級別的回調地址；否則不回調通知。單個級別的回調通知在上傳初始化中指定，用戶級別的回調通知可通過本接口設置。

目前網易視頻云點播支持轉碼結果回調通知。

4.12.2 接口描述

域名：vcloud.163.com

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

用于視頻轉碼，設置轉碼成功后的回調地址。

4.12.3 輸入參數

參數

類型

必須

說明

callbackUrl

String

否

轉碼成功后回調客戶端的URL地址

signKey

String

否

轉碼成功后回調客戶端的簽名字符串，要求是由字母和數字組成且不超過32位

4.12.4 輸出參數

參數

類型

說明

code

Int

狀態碼

successCount

Int

轉碼成功的數量

failCount

Int

轉碼失敗的數量

passCount

Int

轉碼忽略的數量，即已經存在該轉碼格式視頻

msg

String

錯誤信息

4.12.5 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

4.12.6 示例代碼

輸入1

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

輸出1

{

"msg" : "",

"code" : 200

}

4.12.7 轉碼成功回調內容示例

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

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，上傳回調固定為“transcode”

vid

Long

視頻文件標識

name

String

視頻文件名稱

sdMp4Addr

String

流暢mp4視頻的播放地址

hdMp4Addr

String

標清mp4視頻的播放地址

shdMp4Addr

String

高清mp4視頻的播放地址

sdFlvAddr

String

流暢flv視頻的播放地址

hdFlvAddr

String

標清flv視頻的播放地址

shdFlvAddr

String

高清flv視頻的播放地址

sdHlsAddr

String

流暢hls視頻的播放地址

hdHlsAddr

String

標清hls視頻的播放地址

shdHlsAddr

String

高清hls視頻的播放地址

user_defined

String

用戶自定義字段值(轉碼時設置的值)

4.12.8 轉碼失敗回調內容示例

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

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，上傳回調固定為“transcode”

vid

Long

視頻文件標識

name

String

視頻文件名稱

msg

String

轉碼失敗原因

user_defined

String

用戶自定義字段值(轉碼時設置的值)

5 文件管理

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

5.1 獲取視頻文件信息

5.1.1 接口描述

域名：vcloud.163.com

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

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

5.1.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

5.1.3 輸出參數

參數

類型

說明

code

Int

狀態碼

videoName

String

視頻的名稱

vid

Long

視頻Id

status

Int

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

description

String

視頻的描述信息

completeTime

Long

轉碼完成時間

duration

Int

視頻播放時長(單位：秒)

durationMsec

Int

視頻播放時長(單位：毫秒)

width

String

視頻寬度，默認為"0"

height

String

視頻高度，默認為"0"

typeId

Int

視頻所屬分類Id

typeName

String

視頻所屬分類名稱

snapshotUrl

String

視頻封面截圖URL地址

origUrl

String

原始視頻的播放地址

downloadOrigUrl

String

原始視頻的下載地址

initialSize

Long

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

sdMp4Url

String

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

downloadSdMp4Url

String

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

sdMp4Size

Int

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

sdMp4Width

String

流暢Mp4視頻寬度，默認為"0"

sdMp4Height

String

流暢Mp4視頻高度，默認為"0"

hdMp4Url

String

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

downloadHdMp4Url

String

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

hdMp4Size

Int

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

hdMp4Width

String

標清Mp4視頻寬度，默認為"0"

hdMp4Height

String

標清Mp4視頻高度度，默認為"0"

shdMp4Url

String

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

downloadShdMp4Url

String

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

shdMp4Size

Int

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

shdMp4Width

String

高清Mp4視頻寬度，默認為"0"

shdMp4Height

String

高清Mp4視頻高度，默認為"0"

sdFlvUrl

String

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

downloadSdFlvUrl

String

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

sdFlvSize

Int

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

sdFlvWidth

String

流暢Flv視頻寬度，默認為"0"

sdFlvHeight

String

流暢Flv視頻高度，默認為"0"

hdFlvUrl

String

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

downloadHdFlvUrl

String

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

hdFlvSize

Int

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

hdFlvWidth

String

標清Flv視頻寬度，默認為"0"

hdFlvHeight

String

標清Flv視頻高度，默認為"0"

shdFlvUrl

String

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

downloadShdFlvUrl

String

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

shdFlvSize

Int

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

shdFlvWidth

String

高清Flv視頻寬度，默認為"0"

shdFlvHeight

String

高清Flv視頻高度，默認為"0"

sdHlsUrl

String

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

downloadSdHlsUrl

String

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

sdHlsSize

Int

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

sdHlsWidth

String

流暢Hls視頻寬度，默認為"0"

sdHlsHeight

String

流暢Hls視頻高度，默認為"0"

hdHlsUrl

String

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

downloadHdHlsUrl

String

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

hdHlsSize

Int

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

hdHlsWidth

String

標清Hls視頻寬度，默認為"0"

hdHlsHeight

String

標清Hls視頻高度，默認為"0"

shdHlsUrl

String

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

downloadShdHlsUrl

String

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

shdHlsSize

Int

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

shdHlsWidth

String

高清Hls視頻寬度，默認為"0"

shdHlsHeight

String

高清Hls視頻高度，默認為"0"

createTime

Long

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

updateTime

Long

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

msg

String

錯誤信息

5.1.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.1.5 示例代碼

輸入1

輸出1

{

"ret": {

"createTime": 1466578358729,

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

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

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

"sdMp4Size": 17906823,

"videoName": "watermark_test_1",

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

"description": null,

"hdMp4Size": 25227850,

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

"vid": 32,

"shdMp4Size": 39874022,

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

"sdFlvSize": 18013302,

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

"status": 40,

"updateTime": 1466663164342,

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

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

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

"typeName": "默認分類",

"duration": 195,

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

"initialSize": 15601202,

"typeId": 38,

"completeTime": 1466663164342

"code": 200

}

5.2 獲取視頻文件信息列表

5.2.1 接口描述

域名：vcloud.163.com

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

獲取視頻文件信息列表，并做分頁返回處理。單個視頻轉碼模板的信息包括：Id、視頻轉碼模板名稱、視頻轉碼模板對應的格式。

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

5.2.2 輸入參數

參數

類型

必須

說明

currentPage

Int

是

獲取視頻列表分頁后的索引

pageSize

Int

是

獲取視頻列表一頁的記錄數，取值范圍：[1,500]，currentPage * pageSize不能超過5000

beginTime

Long

否

需要查詢的開始時間戳(單位：毫秒)

endTime

Long

否

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

status

Int

是

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

type

Int

是

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

sortStr

String

否

按視頻上傳時間排序，desc表示按上傳時間降序，asc表示按上傳時間升序，默認為desc

為避免分頁過大，建議您合理選擇sortStr。比如，如果您想刪除時間久遠的視頻，可以設置sortStr=asc，再調用刪除接口進行刪除。

5.2.3 輸出參數

參數

類型

說明

code

Int

狀態碼

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取視頻列表的分類數目

list

List

獲取的視頻列表

list.videoName

String

視頻的名稱

list.status

Int

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

list.description

String

視頻的描述信息

list.completeTime

Long

轉碼完成時間

list.duration

Int

視頻播放時長(單位：秒)

list.durationMsec

Int

視頻播放時長(單位：毫秒)

list.typeId

Int

視頻所屬分類Id

list.typeName

String

視頻所屬分類名稱

list.snapshotUrl

String

視頻封面截圖URL地址

list.origUrl

String

原始視頻的播放地址

list.downloadOrigUrl

String

原始視頻的下載地址

list.initialSize

Long

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

list.sdMp4Url

String

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

list.downloadSdMp4Url

String

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

list.sdMp4Size

Int

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

list.hdMp4Url

String

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

list.downloadHdMp4Url

String

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

list.hdMp4Size

Int

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

list.shdMp4Url

String

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

list.downloadShdMp4Url

String

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

list.shdMp4Size

Int

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

list.sdFlvUrl

String

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

list.downloadSdFlvUrl

String

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

list.sdFlvSize

Int

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

list.hdFlvUrl

String

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

list.downloadHdFlvUrl

String

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

list.hdFlvSize

Int

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

list.shdFlvUrl

String

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

list.downloadShdFlvUrl

String

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

list.shdFlvSize

Int

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

list.sdHlsUrl

String

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

list.downloadSdHlsUrl

String

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

list.sdHlsSize

Int

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

list.hdHlsUrl

String

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

list.downloadHdHlsUrl

String

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

list.hdHlsSize

Int

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

list.shdHlsUrl

String

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

list.downloadShdHlsUrl

String

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

list.shdHlsSize

Int

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

list.createTime

Long

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

list.updateTime

Long

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

list.vid

Long

視頻Id

5.2.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.2.5 示例代碼

輸入1

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

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 28,

"list": [

{

"typeName": "默認分類",

"createTime": 1467007983618,

"duration": 0,

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

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

"status": 40,

"updateTime": 1467007983618,

"description": null,

"snapshotUrl": null,

"initialSize": 6354,

"videoName": "qwqwqw",

"typeId": 38,

"completeTime": null,

"vid": 39

{

"typeName": "默認分類",

"createTime": 1467007653656,

"duration": 0,

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

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

"status": 40,

"updateTime": 1467007653656,

"description": null,

"snapshotUrl": null,

"initialSize": 879394,

"videoName": "Chrysanthemum",

"typeId": 38,

"completeTime": null,

"vid": 38

}

"currentPage": 1,

"pageNum": 14

"code": 200

}

5.3 視頻文件信息編輯

5.3.1 接口描述

域名：vcloud.163.com

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

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

5.3.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

videoName

String

是

視頻的名稱

typeId

Int

是

視頻分類Id

description

String

否

視頻的描述信息

5.3.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.3.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.3.5 示例代碼

輸入1

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

輸出1

{

"ret": {},

"code": 200

}

5.4 刪除單個轉碼輸出視頻

5.4.1 接口描述

域名：vcloud.163.com

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

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

5.4.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

style

Int

是

視頻轉碼格式(1表示流暢mp4，2表示標清mp4，3表示高清mp4，

4表示流暢flv，5表示標清flv，6表示高清flv，

7表示流暢hls，8表示標清hls，9表示高清hls)

5.4.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.4.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.4.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.5 刪除視頻源文件

5.5.1 接口描述

域名：vcloud.163.com

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

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

5.5.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

5.5.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.5.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.5.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.6 視頻屏蔽

5.6.1 接口描述

域名：vcloud.163.com

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

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

5.6.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

5.6.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.6.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.6.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.7 視頻恢復

5.7.1 接口描述

域名：vcloud.163.com

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

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

5.7.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

5.7.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.7.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.7.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.8 批量刪除視頻

5.8.1 接口描述

域名：vcloud.163.com

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

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

5.8.2 輸入參數

參數

類型

必須

說明

vids

List

是

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

5.8.3 輸出參數

參數

類型

說明

code

Int

錯誤碼

msg

String

錯誤信息

5.8.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

724

部分刪除操作成功

5.8.5 示例代碼

輸入1

輸出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狀態表

5.9 創建視頻分類

5.9.1 接口描述

域名：vcloud.163.com

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

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

5.9.2 輸入參數

參數

類型

必須

說明

typeName

String

是

視頻分類的名稱

parentTypeId

Int

否

父分類Id

description

String

否

視頻分類的描述信息

5.9.3 輸出參數

參數

類型

說明

code

Int

狀態碼

typeId

Int

新生成的視頻分類Id

msg

String

錯誤信息

5.9.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.9.5 示例代碼

輸入1

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

輸出1

{

"ret" : {

"typeId" : 1

"code" : 200

}

5.10 獲取視頻分類信息

5.10.1 接口描述

域名：vcloud.163.com

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

獲取單個視頻分類信息，包括：Id、分類描述信息、分類數目和分類的創建時間。

5.10.2 輸入參數

參數

類型

必須

說明

typeId

Int

是

視頻分類的Id

5.10.3 輸出參數

參數

類型

說明

code

Int

狀態碼

typeId

Int

視頻分類Id

typeName

String

視頻分類的名稱

parentTypeId

Int

父分類Id

desc

String

視頻分類的描述信息

number

Int

該類別下的視頻文件數量

isDel

Int

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

createTime

Long

視頻分類的創建時間(單位：毫秒)

childNum

Int

子分類數量

msg

String

錯誤信息

5.10.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.10.5 示例代碼

輸入1

輸出1

{

"ret": {

"typeName": "movie",

"createTime": 1467006327149,

"isDel": 1,

"desc": "電影",

"number": 0,

"typeId": 227,

"parentTypeId": 0,

"childNum": 2

"code": 200

}

5.11 獲取視頻分類列表信息

5.11.1 接口描述

域名：vcloud.163.com

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

獲取視頻分類列表，并做分頁返回處理。單個視頻的分類信息包括：Id、分類描述信息、分類數目和分類的創建時間。

5.11.2 輸入參數

參數

類型

必須

說明

currentPage

Int

是

獲取視頻分類列表分頁后的索引

pageSize

Int

是

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

5.11.3 輸出參數

參數

類型

說明

code

Int

狀態碼

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取視頻分類列表的分類數目

list

List

獲取的視頻分類列表

list.typeId

Int

視頻分類Id

list.typeName

String

視頻分類的名稱

list.parentTypeId

Int

父分類Id

list.desc

String

視頻分類的描述信息

list.number

Int

該類別下的視頻文件數量

list.isDel

Int

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

list.childNum

Int

子分類數量

list.createTime

Long

視頻分類的創建時間(單位：毫秒)

5.11.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.11.5 示例代碼

輸入1

輸出1

{

"ret": {

"pageSize": 2,

"totalRecords": 4,

"list": [

{

"typeName": "默認分類",

"createTime": 1464229521940,

"isDel": 0,

"desc": "默認分類",

"number": 47,

"typeId": 38,

"childNum": 0

{

"typeName": "直播錄制",

"createTime": 1464229521940,

"isDel": 0,

"desc": "直播錄制",

"number": 1,

"typeId": 39,

"childNum": 0

}

"currentPage": 1,

"pageNum": 2

"code": 200

}

5.12 修改視頻分類信息

5.12.1 接口描述

域名：vcloud.163.com

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

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

5.12.2 輸入參數

參數

類型

必須

說明

typeId

Int

是

視頻分類的Id

typeName

String

是

視頻分類的名稱

description

String

否

視頻分類的描述信息

5.12.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.12.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.12.5 示例代碼

輸入1

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

輸出1

{

"ret": {},

"code": 200

}

5.13 刪除視頻分類

5.13.1 接口描述

域名：vcloud.163.com

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

刪除視頻分類。

5.13.2 輸入參數

參數

類型

必須

說明

typeId

Int

是

視頻分類Id

5.13.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.13.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.13.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.14 設置視頻的分類

5.14.1 接口描述

域名：vcloud.163.com

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

設置視頻的分類。

5.14.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

typeId

Int

是

視頻分類的Id

5.14.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.14.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.14.5 示例代碼

輸入1

輸出1

{

"ret": {},

"code": 200

}

5.15 獲取視頻截圖地址

5.15.1 接口描述

域名：vcloud.163.com

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

針對具體文件，獲取其不同尺寸下的截圖URL地址。支持截圖的文件格式：

mpegts、mov、mp4、m4a、3gp、3g2、mj2、rm、asf、flv、avi、matroska、

webm、mpeg、mpeg、mpegtsraw、mpegvideo、mtv、mv、mvi、nuv、3gp、

avs、avsvideo、adxl、dv、dvd、flic、flac、h261、h263、h264、hls、m4v、

mjpeg、rawvideo、rpl、avcd、truehd、vc-1、vcd。

如有不支持格式視頻，請進行轉碼，接口會根據轉碼后的視頻截取圖片。

截取圖片比例如果和視頻尺寸比例不相符合，會自動填充黑邊，保證圖片顯示正常。

5.15.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

size

Int

是

截圖尺寸，包含以下幾種值：

0表示原始視頻比例，1表示640x360，2表示400x300，3表示320x180，

4表示200x150，5表示1280x720，6表示960x720，7表示360x640，

8表示300x400，9表示180x320，10表示150x200，11表示720x1280，

12表示720x960，13表示180x180，14表示360x360，15表示720x720

offset

Int

否

截圖偏移，包含以下幾種值：

0表示視頻第一秒，1表示時間軸10%位置，2表示時間軸20%位置，

3表示時間軸30%位置，4表示時間軸40%位置，5表示時間軸50%位置，

6表示時間軸60%位置，7表示時間軸70%位置，8表示時間軸80%位置，

9表示時間軸90%位置

customWidth

Int

否

自定義截圖寬度，可設置值為(0,4000]

customHeight

Int

否

自定義截圖高度，可設置值為(0,4000]

customOffset

Long

否

自定義截圖時間戳，單位毫秒

style

Int

否

視頻轉碼格式(0表示源視頻，1表示流暢mp4，2表示標清mp4，3表示高清mp4， 4表示流暢flv，5表示標清flv，6表示高清flv， 7表示流暢hls，8表示標清hls，9表示高清hls) 如果設置了style，則會根據指定格式的視頻進行截圖

重要提示：

如需自定義截圖寬高信息，customWidth和customHeight需同時不為空。

如果offset和customOffset都填寫，以customOffset為準。如果offset和customOffset都不填寫，默認offset=0。

5.15.3 輸出參數

參數

類型

說明

code

Int

狀態碼

url

String

截圖地址

width

String

截圖寬度

height

String

截圖高度

msg

String

錯誤信息

5.15.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.15.5 示例代碼

輸入1

輸出1

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

{

"ret" : {

"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg",

"width" : "640",

"height" : "320"

"code" : 200

}

5.16 設置視頻封面

5.16.1 接口描述

域名：vcloud.163.com

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

為視頻設置顯示封面。

5.16.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻Id

type

Int

是

封面設置方法：1表示使用截圖URL，2表示使用本地上傳圖片

path

String

是

type值為1，則代表截圖URL；type值為2，則代表本地圖片路徑

data

String

否

type值為2時，需填寫，代表本地圖片數據的base64編碼字符串數據

重要提示：使用截圖URL設置視頻封面的URL必需是存儲在網易視頻云點播服務的URL，暫不支持第三方URL。

5.16.3 輸出參數

參數

類型

說明

code

Int

狀態碼

url

String

截圖地址

msg

String

錯誤信息

5.16.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.16.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":12,"type":1,"path":"http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"}' https://vcloud.163.com/app/vod/snapshot/set

輸出1

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

{

"ret" : {

"url" : "http://vodk32ywxdf.nosdn.127.net/fsfs-gdgs-gdgd-gdgds_snapshot_0_640.jpg"

"code" : 200

}

5.17 生成視頻預覽

5.17.1 接口描述

域名：vcloud.163.com

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

為視頻生成預覽，包括：動圖和視頻。

5.17.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻的標識

format

Int

是

生成的視頻預覽格式，1表示webp格式,2表示mp4格式，3表示flv格式，4表示hls格式，5表示gif格式

samplings

List

是

采樣的視頻時間區間列表，包含一組sampling，

區間個數最多5個，單位為秒，區間時長小于等于3s區間，可以有重合，區間順序有意義

callbackUrl

String

否

處理完成后回調的URL地址(需標準http格式)，如不設置，使用默認的轉碼回調地址

userDefInfo

String

否

用戶自定義信息，回調會返回此信息

keepAspectRatio

Int

否

是否保持輸出文件與原視頻寬高比，0表示不保持，1表示保持，默認為1

outputWidth

Int

否

輸出文件的寬度，取值大于等于0且小于等于4096，默認為0

outputHeight

Int

否

輸出文件的高度，取值大于等于0且小于等于4096，默認為0

frameRate

Int

否

輸出幀率，取值不超過30且大于0，若等于0，則保持與原視頻一致，默認為8

bitRate

Int

否

比特率，取值大于0，不設置則保持和原視頻相同

enableLoop

Int

否

webp格式的預覽是否循環， 0表示不循環， 1表示循環，默認為0

sampling參數詳細說明

參數

類型

必須

說明

start

Int

是

采樣的視頻時間區間開始時間

end

Int

是

采樣的視頻時間區間結束時間

重要提示：

若outputWidth為0且outputHeight為0,則輸出寬高均取原視頻寬高。

若outputWidth為0且outputHeight>0,則保持寬高比，無視keepAspectRatio參數，按照設置的高度值等比例計算寬度。

若outputWidth>0且outputHeight為0,則保持寬高比，無視keepAspectRatio參數，按照設置的寬度值等比例計算高度。

若outputWidth>0且outputHeight>0,且keepAspectRatio為0，則輸出寬高按照參數設置；若keepAspectRatio為1，則寬不變，高通過計算得到。

對于format格式為2、3、4的，samplings只允許一組值，表示視頻截取開始時間和結束時間，如果有多組值，只取第一組，其余忽略。

5.17.3 輸出參數

參數

類型

說明

code

Int

狀態碼

url

String

截圖地址

msg

String

錯誤信息

5.17.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.17.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":32,"format":1,"samplings":[{"start":1,"end":3},{"start":4,"end":6},{"start":8,"end":9},{"start":12,"end":13},{"start":21,"end":23}],"userDefInfo":"userId=123456"}' https://vcloud.163.com/app/vod/video/preview

輸出1

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

{

"requestId" : "e49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {}

}

5.17.6 結果回調

視頻預覽的生成為異步處理，處理完成回回調給請求參數設置的callbackUrl，如果未設置，回調給默認的轉碼地址。

生成預覽圖成功回調內容示例

{

"previewAddr" : "vodk32ywxdf.vod.126.net/vodk32ywxdf/abcsdf.mp4",

"type" : "videoPreview",

“originVid” : 32,

"previewVid" : 1243,

q"user_defined" : "userId=123456"

}

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，預覽圖生成回調固定為“videoPreview”

originVid

Long

原始視頻文件視頻標識

previewVid

String

生成的預覽視頻標識

previewAddr

String

生成視頻預覽訪問地址

user_defined

String

用戶自定義字段值

生成預覽圖失敗回調內容示例

{

"error" : {

"msg" : "Failed",

"type" : "videoPreview",

"originVid" : 32,

"user_defined" : "userId=123456"

}

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，預覽圖生成回調固定為“preview”

originVid

Long

原始視頻文件視頻標識

msg

String

轉碼失敗原因

user_defined

String

用戶自定義字段值

5.18 視頻裁剪

5.18.1 接口描述

域名：vcloud.163.com

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

對視頻進行裁剪，針對每個采樣區間生成獨立的視頻。

5.18.2 輸入參數

參數

類型

必須

說明

vid

Long

是

視頻的標識

format

Int

是

生成的視頻預覽格式，1表示mp4格式，2表示flv格式

samplings

List

是

采樣的視頻時間區間列表，包含一組sampling，

區間個數最多10個，單位為秒，可以有重合，區間順序有意義

callbackUrl

String

否

處理完成后回調的URL地址(需標準http格式)，如不設置，使用默認的回調地址

userDefInfo

String

否

用戶自定義信息，回調會返回此信息

sampling參數詳細說明

參數

類型

必須

說明

start

Int

是

采樣的視頻時間區間開始時間

end

Int

是

采樣的視頻時間區間結束時間

cropArea

object

否

采樣區間內對畫面進行扣取

cropArea參數說明

參數

類型

必須

說明

width

Int

是

扣取畫面的寬，例如640，50，此值可表示絕對值也可表示相對值，取決于whType，當whType取值為2時，不允許大于100

height

Int

是

扣取畫面的高，例如360,50，此值可表示絕對值也可表示相對值，取決于whType，當whType取值為2時，不允許大于100

whType

Int

是

取值1或者2。1-表示上面的寬高為絕對值，傳入為640*360，那么扣取畫面的寬高就是640*360；2-表示相對值，表示傳入的寬高為相對原視頻寬高的百分比。例如傳入5050，那么扣取的視頻畫面寬為src_width\59%，同理高為src_height*50%

Int

是

采樣畫面左上角相對于原視頻的左上角的橫坐標

Int

是

采樣畫面左上角相對于原視頻的左上角的縱坐標

xyType

Int

是

用于表示x,y是絕對值還是百分比，1-絕對值，例如120,120。2-百分比，表示才用原視頻寬高的百分比

注：callbackUrl如果不設置，會采用默認的視頻裁剪地址回調。默認視頻裁剪地址回調設置接口參考 9.3節設置回調地址接口

5.18.3 輸出參數

參數

類型

說明

requestId

String

請求標識

code

Int

狀態碼

taskId

Long

任務標識

msg

String

錯誤信息

注：taskId是媒體處理任務的唯一標識，用戶可以通過taskId主動查詢任務的執行狀態。詳情見 5.20節任務查詢接口

5.18.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.18.5 示例代碼

輸入1

curl -X POST \

https://vcloud.163.com/app/vod/video/clip \

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

-H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" \

-H "Nonce: 1" \

-H "CurTime: 1465723418" \

-H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" \

-d '{

"vid":32,

"format":1,

"samplings":[

{

"start":1,

"end":3

"cropArea":{

"width":120,

"height":120,

"whType":1,

"x":0,

"y":0,

"xyType":1

}

{

"start":4,

"end":6,

"cropArea":{

"width":20,

"height":20,

"whType":2,

"x":0,

"y":0,

"xyType":1

}

{

"start":8,

"end":9

{

"start":12,

"end":13

{

"start":21,

"end":23

}

"userDefInfo":"userId=123456"

輸出1

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

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {

"taskId": 5

}

5.18.6 結果回調

視頻裁剪的生成為異步處理，處理完成會回調給請求參數設置的callbackUrl，如果未設置，回調給默認的裁剪地址。

視頻裁剪回調內容示例

{

"videoClipJobResult":[

{

"sampling":{

"start":1,

"end":3,

"cropArea":{

"width":120,

"height":120,

"whType":1,

"x":0,

"y":0,

"xyType":1

}

"status":"SUCCESS",

"vid":111

{

"sampling":{

"start":4,

"end":6,

"cropArea":{

"width":20,

"height":20,

"whType":2,

"x":0,

"y":0,

"xyType":1

}

"status":"SUCCESS",

"vid":112

{

"sampling":{

"start":8,

"end":9

"status":"FAILED",

"msg":"Fail"

}

"type":"VIDEO_CLIP",

"originVid":1021,

"user_defined":"userId=123456",

"requestId":"vode49fdc9a-d59d-480d-b3ef-c91b37f8f664"

}

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

type

String

回調類型，視頻裁剪生成回調固定為“VIDEO_CLIP”

originVid

Long

原始視頻文件視頻標識

user_defined

String

用戶自定義字段值

requestId

String

用戶調用視頻裁剪接口時返回的請求標識

videoClipJobResult

Json對象

視頻裁剪任務結果

videoClipJobResult參數詳細說明

參數

類型

說明

sampling

String

采樣的視頻時間區間

status

String

狀態，FAILED 處理失敗 SUCCESS 處理成功

vid

Long

采樣區間生成的對應視頻ID

注意：sampling為實際生成視頻的區間，例如設置區間[1, 11] 但是視頻實際時長只有10,則返回的區間是[1,10]

5.19 視頻合并

5.19.1 接口描述

域名：vcloud.163.com

接口名：POST /app/vod/nts/merge

1.視頻合并，來源視頻必須是點播庫中的視頻，參數為vid視頻id；

2.僅支持一次性合并20個視頻；

3.來源視頻的總時長不得超過8小時；

4.因為來源視頻的分辨率、bit等都不盡相同，現在默認使用時長最長的視頻的分辨率等參數；

5.分辨率等比例縮放時，如果高度為最大時，寬度使用填充黑邊，反之高度使用填充黑邊(具體可以使用widthCutStyle、heightCutStyle指定)；

例如：最大時長的分辨率是1000(寬)800(高),比例是1000/800。其中一個視頻的分辨率是500300，則等比例縮放到1000*800后，高度不夠的使用填充黑邊；

6.提交后的任務，可以通過回調接口接收回調信息，也可以通過taskId主動查詢任務的執行狀態。詳情見5.20節任務查詢接口

5.19.2 輸入參數

參數

類型

必須

說明

videos

Array

是

待合并的視頻列表，參見 MergeVideo 參數說明

widthCutStyle

Int

否

參見 KeepAspectRatioStyle 參數說明, 默認填充黑邊

heightCutStyle

Int

否

參見 KeepAspectRatioStyle 參數說明, 默認填充黑邊

callbackUrl

String

否

處理完成后回調的URL地址(需標準http格式)

userDefInfo

String

否

用戶自定義信息，回調會返回此信息

MergeVideo 參數詳細說明

參數

類型

必須

說明

vid

Long

是

視頻id

KeepAspectRatioStyle 參數詳細說明

參數值

類型

說明

Int

填充黑邊

Int

平均切割

Int

如果要切寬的時候只切左邊保留右邊

Int

如果要切寬的時候只切右邊保留左邊

Int

如果要切高的時候只切上邊保留下邊

Int

如果要切高的時候只切下邊保留上邊

注：callbackUrl如果不設置，會采用默認的視頻合并地址回調。默認視頻合并地址回調設置接口參考 9.3節設置回調地址接口

5.19.3 輸出參數

參數

類型

說明

requestId

String

請求標識

code

Int

狀態碼

taskId

Long

任務標識

msg

String

錯誤信息

5.19.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.19.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"videos":[{"vid":123}],"widthCutStyle":1,"heightCutStyle":3,"userDefInfo":"job_id:123132"}' https://vcloud.163.com/app/vod/nts/merge

輸出1

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

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200,

"ret": {

"taskId": 5

}

5.19.6 結果回調

視頻合并的生成為異步處理，處理完成會回調給請求參數設置的callbackUrl，如果未設置，回調給默認的視頻合并地址。

視頻裁剪回調內容示例

{

"taskId" : 214123123,

"status": "SUCCESS",

"failMsg": "asdasdasd",

"vid": 1010,

"jobRequestId": "vod213asdd12313asd123123" //任務追蹤用

}

注意：請以實際收到的body字段為準，以下僅為body字段示例。

參數

類型

說明

taskId

Long

媒體處理任務標識

status

String

任務狀態，SUCCESS表示成功

vid

Long

合并后的視頻文件標識

failMsg

String

失敗原因

jobRequestId

String

用戶調用視頻合并接口時返回的請求標識

5.20 任務查詢

5.20.1 接口描述

域名：vcloud.163.com

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

通過任務ID查詢任務執行狀況。僅支持查詢最近7天的任務信息。

5.20.2 輸入參數

參數

類型

必須

說明

taskId

Long

是

任務標識

5.20.3 輸出參數

參數

類型

說明

requestId

String

請求標識

code

Int

狀態碼

msg

String

錯誤信息

ret

JSON對象

結果集，JSON對象

ret.task

JSON對象

任務執行狀況

input

JSON對象

任務輸入

input.vid

Long

任務輸入視頻標識

result

JSON對象

任務輸出結果

result.videoClipJobResult

JSON對象

視頻裁剪任務結果，參見videoClipJobResultg參數詳細說明

status

String

任務狀態： INIT表示提交中，FAILED表示處理失敗， PROCESSING表示處理中， SUCCESS表示處理成功

taskId

Long

任務標識

type

String

任務類型： VIDEO_CLIP表示視頻裁剪任務， MERGE_VIDEO表示視頻合并任務

userDefinedInfo

String

用戶自定義信息

failMsg

String

失敗原因

createTime

String

任務創建時間 yyyy-MM-dd HH:mm:ss

endTime

String

任務結束時間 yyyy-MM-dd HH:mm:ss

videoClipJobResult參數詳細說明

參數

類型

說明

sampling

String

采樣的視頻時間區間

status

String

狀態，FAILED表示處理失敗， SUCCESS表示處理成功

vid

Long

采樣區間生成的對應視頻ID

注意：sampling為實際生成視頻的區間，例如設置區間[1, 11] 但是視頻實際時長只有10,則返回的區間是[1,10]

5.20.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.20.5 示例代碼

輸入1

視頻裁剪任務查詢輸出

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

{

"ret": {

"task": {

"createTime": "2018-11-22 15:32:55",

"endTime": "2018-11-22 15:33:02",

"failMsg": "",

"input": {

"vid": 24

"result": {

"videoClipJobResult": [

{

"sampling": {

"start": 1,

"end": 3

"status": "SUCCESS",

"vid": 111

{

"sampling": {

"start": 4,

"end": 6

"status": "SUCCESS",

"vid": 112

{

"sampling": {

"start": 8,

"end": 9

"status": "FAILED",

"msg": "Fail"

}

]

"status": "SUCCESS",

"taskId": 1,

"type": "VIDEO_CLIP",

"userDefinedInfo": ""

}

"requestId": "vodc90605aa-24c4-4e17-8b07-0a041a0506d9",

"code": 200

}

視頻合并任務查詢輸出

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

{

"ret": {

"task": {

"createTime": "2018-12-06 17:51:34",

"endTime": "2018-12-06 17:52:22",

"failMsg": "",

"result": {

"vid": 1

"status": "SUCCESS",

"taskId": 1,

"type": "MERGE_VIDEO",

"userDefinedInfo": "auto視頻合并"

}

"requestId": "vod8867f143-a5b3-4e11-a234-1e2025af61e3",

"code": 200

}

5.21 圖片查詢接口

查詢上傳的圖片信息

5.21.1 接口描述

用于查詢通過上傳接口上傳的圖片和水印文件

域名：vcloud.163.com

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

5.21.2 輸入參數

參數

類型

是否必傳

說明

currentPage

int

是

當前頁，大于等于1

pageSize

int

是

取值[1,1000]

5.21.3 輸出參數

ret返回參數

參數

類型

說明

totalRecords

Long

所有圖片的數量

pageSize

Int

一頁的記錄數目

currentPage

Int

當前取得頁數

pageNum

Int

總頁數

list

JsonObject

返回圖片對象

圖片對象參數

參數

類型

說明

imageId

long

objectKey

string

對象名稱

width

int

圖片寬

height

int

圖片高

5.21.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

724

部分刪除操作成功

5.21.5 示例代碼

請求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: et4b4r" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"currentPage":1,"pageSize":100}' https://vcloud.163.com/app/vod/image/list

返回示例

{

"ret": {

"pageSize": 2,

"totalRecords": 8,

"list": [

{

"imageId": 1,

"objectKey": "key1",

"width":1280,

"height":720

{

"imageId": 2,

"objectKey": "key2",

"width":640,

"height":360

}

"currentPage": 1,

"pageNum": 4

"code": 200

}

5.22 截圖查詢接口

查詢視頻的截圖信息

5.22.1 接口描述

查詢某視頻的截圖信息

域名：vcloud.163.com

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

5.22.2 輸入參數

參數

類型

是否必傳

說明

vid

long

是

視頻vid

5.22.3 輸出參數

ret返回參數

參數

類型

說明

list

JsonObject

截圖對象信息

list截圖參數

參數

類型

說明

snapshotId

long

vid

long

vid

objectKey

string

對象名稱

width

int

圖片寬

height

int

圖片高

5.22.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

5.22.5 示例代碼

請求示例

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxx" -H "Nonce: ert24" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"vid":100003}' https://vcloud.163.com/app/vod/snapshot/get

返回示例

{

"ret": {

"list": [

{

"snapshotId": 1,

"vid":100003,

"objectKey": "key1",

"width":1280,

"height":720

{

"snapshotId": 2,

"vid":100003,

"objectKey": "key2",

"width":640,

"height":360

}

]

"code": 200

}

5.23 刪除圖片或截圖

刪除上傳的圖片或者視頻截圖

5.23.1 接口描述

刪除上傳的圖片，水印或者刪除某視頻下的所有截圖，或者刪除某個指定id的截圖

域名：vcloud.163.com

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

5.23.2 輸入參數

參數

類型

是否必填

描述

deleteIdType

string

是

image：表示傳入的id為imageId；

video：表示傳入的id為vid，此時會刪除這個vid下面的所有截圖；

snapshot：表示傳入的id為snapshotId

ids

long array

是

刪除指定id的圖片，最多傳100個

5.23.3 輸出參數

無特殊返回值

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

5.23.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

724

部分刪除操作成功

5.23.5 示例代碼

請求示例

// 刪除視頻截圖

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"video","ids":[10002,10004]}' https://vcloud.163.com/app/vod/picture/delete

// 刪除image

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"image","ids":[345]}' https://vcloud.163.com/app/vod/picture/delete

// 刪除截圖

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: xxxxxxxxxxxxxxxxxx" -H "Nonce: 1er11" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"sourceType":"snapshot","ids":[2345,567,8889]}' https://vcloud.163.com/app/vod/picture/delete

返回示例

{

"ret": {},

"code": 200

}

6 數據查詢

數據查詢模塊主要展示流量、帶寬、存儲統計的查詢功能。

6.1 流量統計查詢

6.1.1 接口描述

域名：vcloud.163.com

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

用于查詢點播的流量使用統計數據(查詢的開始時間不能超過當前時刻90天，且不能查詢當天數據)。

6.1.2 輸入參數

參數

類型

必須

說明

startDate

Long

是

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

是

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

currentPage

Int

是

獲取流量數據列表分頁后的索引

pageSize

Int

是

獲取流量數據列表一頁的記錄數，取值范圍：[1,500]

6.1.3 輸出參數

參數

類型

說明

code

Int

狀態碼

totalFlow

Double

查詢時段的總流量(單位：GB)

startDate

Long

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

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

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取流量數據的數目

list

List

流量數據列表

list.begintime

Long

起始時間(單位：毫秒)

list.endtime

Long

結束時間(單位：毫秒)

list.flow

Double

流量值(單位：GB)

msg

String

錯誤信息

6.1.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

6.1.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/flow

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"totalFlow" : 1234.23,

"type" : 2,

"flowList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062400000,

"flow" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

6.2 帶寬統計查詢

6.2.1 接口描述

域名：vcloud.163.com

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

用于查詢點播的帶寬使用統計數據。

返回的數據粒度根據查詢的結束時間戳與開始時間戳之差的大小不同而有所不同：若時間差為0~1天，則按每十分鐘一個打點數據返回；若時間差為2~7天，則按每小時一個打點數據返回；若時間差為8~31天，則按每四小時一個打點數據返回；若時間差為32~366天，則按每天一個打點數據返回。另外，查詢的開始時間不能超過當前時刻60天，且不能查詢當天數據。

6.2.2 輸入參數

參數

類型

必須

說明

startDate

Long

是

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

是

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

currentPage

Int

是

獲取帶寬數據列表分頁后的索引

pageSize

Int

是

獲取帶寬數據列表一頁的記錄數，取值范圍：[1,500]

6.2.3 輸出參數

參數

類型

說明

code

Int

狀態碼

maxBand

Double

查詢時段的最大帶寬值(單位：Mb/s)

startDate

Long

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

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

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取帶寬數據的數目

bandList

List

獲取的帶寬列表

bandList.begintime

Long

起始時間(單位：毫秒)

bandList.endtime

Long

結束時間(單位：毫秒)

bandList.band

Double

帶寬值(單位：Mb/s)

msg

String

錯誤信息

6.2.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

6.2.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":2,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/band

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"maxBand" : 1234.23,

"type" : 2,

"bandList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062400000,

"band" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

6.3 存儲統計查詢

6.3.1 接口描述

域名：vcloud.163.com

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

用于查詢點播的存儲使用統計數據(查詢粒度為天，查詢的開始時間不能超過當前時刻90天，且不能查詢當天數據)。

6.3.2 輸入參數

參數

類型

必須

說明

startDate

Long

是

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

是

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

currentPage

Int

是

獲取存儲數據列表分頁后的索引

pageSize

Int

是

獲取存儲數據列表一頁的記錄數，取值范圍：[1,500]

6.3.3 輸出參數

參數

類型

說明

code

Int

狀態碼

totalStorage

Double

查詢時段的總存儲量(單位：GB)

startDate

Long

需要查詢的開始時間戳(單位：毫秒)

endDate

Long

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

currentPage

Int

當前取得頁數

pageSize

Int

一頁的記錄數目

pageNum

Int

總頁數

totalRecords

Int

獲取存儲數據的數目

type

Int

統計粒度(2：每天)

storageList

List

獲取的存儲列表

storageList.begintime

Long

起始時間(單位：毫秒)

storageList.endtime

Long

結束時間(單位：毫秒)

storageList.storage

Double

存儲量(單位：GB)

msg

String

錯誤信息

6.3.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足。

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

6.3.5 示例代碼

輸入1

curl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05cc4a65b5d98bc9d6af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a28b3628584e65a2abe7ae13" -d '{"startDate":1490976000000,"endDate":1491062400000,"type":5,"currentPage":1,"pageSize":10}' https://vcloud.163.com/app/vod/stats/storage

輸出1

{

"ret" : {

"startDate" : 1490976000000,

"endDate" : 1491062400000,

"totalStorage" : 1234.23,

"type" : 2,

"storageList" : [

{

"begintime" : 1490976000000,

"endtime" : 1491062399999,

"storage" : 123.21

...

"currentPage" : 1,

"pageSize" : 10,

"pageNum" : 2,

"totalRecords" : 18

"code" : 200

}

7 移動端終端用戶管理

7.1 概述

網易視頻云官網API適用于業務服務器調用，為滿足業務服務器的終端用戶上傳視頻以及點播加密等需求，視頻云提供了移動端終端用戶的管理API，方便企業管理其終端用戶使用視頻云的服務。

7.2 使用說明

8 視頻安全

視頻安全模塊主要展示有關視頻版權保護方面的功能開通、API調用和代碼示例。網易云為開發者提供防盜鏈、回源鑒權、視頻內容加密等多種安全機制，保障客戶的視頻版權不被輕易盜用。

8.1 防盜鏈

8.1.1 概述

點播防盜鏈是指在點播視頻播放地址中通過添加鑒權字符串的方式，來校驗地址合法性的一種防止視頻被盜播的方式。開通防盜鏈功能后，視頻播放地址中需要包含一段鑒權字符串，只有合法生成的鑒權串，才可以通過校驗從而播放，且該地址有時效性，只在設定的有效期內可播放。這樣即使別人獲取到已失效的地址，也是無法繼續使用的，防止別人盜播視頻。如果已經使用有效的地址正在播放，不會因為地址超時失效而受影響。

8.1.2 使用說明

8.2 回源鑒權

8.2.1 概述

回源鑒權是一種保護用戶視頻內容安全的功能。通過使用回源鑒權功能，用戶可實時自行生成視頻文件播放鏈接，該鏈接在用戶指定時間內可用，從而有效保護視頻內容。如果在使用回源鑒權功能之前，用戶已經發布了播放地址，則在使用回源鑒權功能后，之前的播放地址不可用。用戶需要通過動態生成鏈接以訪問視頻文件。

8.2.2 兩種回源鑒權方式

網易視頻云提供了兩種回源鑒權方式，二者的區別僅僅在于生成地址的方法不同，其各自生成的播放地址具有完全相同的保護效用，用戶可根據自身需要進行選擇。

8.3視頻加密

8.3.1 概述

視頻加密是一種保護視頻內容安全的功能。通過將視頻的內容進行加密，用戶必須使用網易視頻云播放SDK才能實現視頻的觀看，從而有效保護視頻內容。

8.3.2 使用說明

9 回調管理

回調是網易云提供的一種異步通知方式，用戶可設置回調地址，網易云完成某個特定任務后會將運行結果發送至設置的回調地址，用戶可在收到回調后執行相應的業務邏輯。用戶可參考3.6節設置上傳回調地址，參考4.12節設置轉碼回調地址。回調管理模塊提供了回調地址的查詢和刪除功能，方便用戶查看或刪除回調地址。

9.1 回調地址查詢

9.1.1 接口描述

域名：vcloud.163.com

接口名：/app/vod/callback/getUrl

用于查詢指定類型的回調地址。

9.1.2 輸入參數

參數

類型

必須

說明

type

Int

是

回調地址類型：1表示轉碼回調，2表示上傳回調，5表示視頻合并回調，6表示視頻裁剪回調

9.1.3 輸出參數

參數

類型

說明

code

Int

狀態碼

callbackUrl

String

回調地址

lastUpdateTime

String

最近更新時間(yyyy-MM-dd HH:mm:ss)

msg

String

錯誤信息

9.1.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

9.1.5 示例代碼

輸入1

輸出1

{

"ret": {

"callbackUrl": "http://123456xxxx",

"lastUpdateTime": "2019-01-15 14:01:14"

"code": 200

}

9.2 刪除回調地址

9.2.1 接口描述

域名：vcloud.163.com

接口名：/app/vod/callback/delUrl

用于刪除指定類型的回調地址，調用本接口后，您不會再收到相應類型的回調信息。

9.2.2 輸入參數

參數

類型

必須

說明

type

Int

是

回調地址類型：1表示轉碼回調，2表示上傳回調，5表示視頻合并回調，6表示視頻裁剪回調

9.2.3 輸出參數

參數

類型

說明

code

Int

狀態碼

msg

String

錯誤信息

9.2.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

711

請求參數非法，具體信息見msg

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

9.2.5 示例代碼

輸入1

輸出1

{

"code": 200

}

9.3 設置回調地址

網易視頻云點播的回調通知分為單個級別和用戶級別，且處理優先級為：單個級別->用戶級別->無回調。當用戶設置了單個級別的回調地址，使用單個級別的回調地址；否則查詢是否設置用戶級別的回調地址，如果設置，使用用戶級別的回調地址；否則不回調通知。單個級別的回調通知在上傳初始化中指定，用戶級別的回調通知可通過本接口設置。

9.3.1 接口描述

域名：vcloud.163.com

接口名：POST /app/vod/callback/setUrl

用于設置指定類型的回調地址。

9.3.2 輸入參數

參數

類型

必須

說明

type

Int

是

回調地址類型，1表示轉碼回調，2表示上傳回調，5表示視頻合并回調，6表示視頻裁剪回調

callbackUrl

String

是

處理完成后回調的URL地址(需標準http格式)

signKey

String

否

媒體處理成功后回調客戶端的簽名字符串，要求是由字母和數字組成且不超過32位

9.3.3 輸出參數

參數

類型

說明

requestId

String

請求標識

code

Int

狀態碼

msg

String

錯誤信息

9.3.4 響應狀態碼

狀態碼

含義

200

操作成功

400

請求報文格式錯誤，報文構造不正確或者沒有完整發送

700

服務器內部出現錯誤，請稍后重試或者將完整錯誤信息發送給客服人員幫忙解決

710

權限認證失敗，請參考文檔中的接口鑒權部分

720

訪問失敗，余額不足

721

服務未開通，請前往開通頁面申請服務開通

722

服務開通審核中，請聯系客服人員開通服務

723

請求的次數超過了配額限制

9.3.5 示例代碼

輸入1

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

輸出1

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

{

"requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",

"code" : 200

}

本篇文檔內容是否對您有幫助？

有幫助

我要吐槽

如果遇到產品相關問題，您可提交工單或在線客服尋求幫助。

您的改進建議

問題類型

內容錯誤

內容沒更新

描述不清

鏈接有誤

步驟不完整

內容缺失(缺少代碼/示例)

其他

更多建議

請輸入您的建議或問題(至少5個字符，至多500個字符)

聯系方式

標記內容

同時提交標記內容

提交

此文檔對你是否有幫助

有幫助

我要吐槽

反饋成功

非常感謝您的反饋，我們會繼續努力做得更好。

總結

以上是生活随笔為你收集整理的云信api_服务端API文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： INC和DEC为什么不影响状态标志位
下一篇：一维最大熵阈值分割法原理及实现