保利威文档中心

幫助中心

刪除影片

更新時間:2024-12-31 18:37:43

介面說明

1、通过视频id删除视频,支持批量删除
2、接口支持https协议

介面URL

http://api.polyv.net/v2/video/del-videos

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數說明

參數名 必填 類型 說明
userid true String 保利威點播帳戶ID,可參考【取得金鑰】取得,取得路徑:官網->登入->點播(API介面)
ptime true Long 目前時間的毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
vids true String 影片ID,多個影片以英文逗號分隔,一次最多提交500個
deleteType false String 刪除方式,預設為1
1:刪除到回收站
2:徹底刪除
ignoreInvalidVids false String 是否忽略錯誤影片ID,值為Y或N。預設為N
Y:忽略錯誤的影片ID,正確的影片ID會正常進行處理;
N:如果存在錯誤影片ID,則不進行任何刪除操作,回傳錯誤資訊;

範例

http://api.polyv.net/v2/video/del-videos

表單參數:

vids=1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1&sign=CDF38C1476AF7578A55D81FB8B4162BD29F9FE53&userid=1b448be323&ptime=1617097496305

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 如果 ignoreInvalidVids 參數值為Y,且參數中包含錯誤的影片ID,則 data 中會包含錯誤的影片ID列表;否則,data 值為空字串。

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

 private static final Logger log = LoggerFactory.getLogger(VodVideoManagementTest.class);
/**
 * 删除视频
 */
@Test
public void testDeleteVideo() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/video/del-videos";
    String vids = "1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userid);
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);

    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试删除视频,{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": ""
}

異常範例

簽名不正確

{
    "code":400,
    "status":"error",
    "message":"the sign is not right",
    "data":""
}

時間戳過期

{
    "code":400,
    "status":"error",
    "message":"ptime is too old.",
    "data":""
}

參數為空

{
    "code":400,
    "status":"error",
    "message":"xxx is empty",
    "data":""
}

刪除影片一次最多只能提交500個

{
    "code":400,
    "status":"error",
    "message":"delete vids size can't greater than 500 once",
    "data":""
}
联系客服,在线咨询