刪除文件

更新時間：2024-10-21 09:33:43

介面描述

1、删除课节文档接口
2、支持https协议

介面URL

http://api.polyv.net/hi-class-api/open/file/v1/delete

請求方式

POST

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
lessonId	true	Long	課節號
fileId	true	String	檔案ID，(若有多個，可用英文逗號隔開拼接成字串)，該值來源參考【查詢課節已上傳文件列表】介面回傳資料的data.contents[0].fileId

範例

http://api.polyv.net/hi-class-api/open/file/v1/delete

表單參數：

appId=z2gw5icesv&sign=935F4C0CF3EB84A3EFB2BC691DB714A5&lessonId=6707&timestamp=1631780657591&fileId=42ba92e56017f4de261e692630447b662561988animate

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
error	Error	錯誤物件【詳見全域錯誤說明】
data	String	請求成功時，回傳值為空，請求失敗時，回傳值為空

Java請求範例

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

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

/**
 * 删除文档
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testDeleteDocument() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = this.appId;
    String appSecret = this.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/file/v1/delete";
    String lessonId = "6956";
    String fileId = "42ba92e56017f4de261e692630447b662561988animate";
    
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("lessonId", lessonId);
    requestMap.put("fileId", fileId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试删除文档：{}", response);
    
}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "data":null,
    "success":true
}

異常範例

{
  "code": 400,
  "status": "error",
  "data": "",
  "error": {
    "code": xx,
    "desc": "错误描述"
  }
}