保利威文档中心

幫助中心

刪除素材

更新時間:2026-02-27 11:14:52

介面描述

1、删除账号下的素材,支持批量删除,支持删除到回收站或彻底删除。
2、接口支持https协议g't

介面URL

https://api.polyv.net/live/v4/material/delete

請求方式

POST

介面限制

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

請求參數描述

參數名 必填 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則

請求體參數描述

參數名 必填 類型 說明
materialIds true List<String> 素材ID列表,列表長度必須在1~1000之間
deleteCompletely false String 是否徹底刪除,可選值為:
Y: 徹底刪除,請注意,徹底刪除後無法復原,請謹慎操作
N: 刪除到資源回收筒
不傳該參數時預設為N
allowPartialDelete false String 是否允許部分刪除,可選值為:
Y: 允許部分刪除,即,如果有部分素材刪除失敗(例如因為素材ID不存在),此時其他正常的素材還是能刪除成功
N: 不允許部分刪除,即,任一素材刪除失敗,都會整體失敗
不傳該參數時預設為N

範例

https://api.polyv.net/live/v4/material/delete?appId=xxx&sign=A69559D6EBF130B9C0F60807459FC311&timestamp=1642733791590

請求體參數

{
    "materialIds": ["xxx", "yyy"],
    "deleteCompletely": "Y",
    "allowPartialDelete": "Y"
}

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗
status String 回應結果,由業務決定,成功返回success,失敗返回error
success Boolean 是否成功回應
requestId String 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應與業務掛鉤
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位描述
data Object 【詳見data欄位說明

Error參數描述

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

Data參數描述

參數名 類型 說明
failedMaterialIds List<String> 刪除失敗的素材ID列表,空列表則表示沒有失敗的

回應範例

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

成功範例,全部刪除成功

{
    "code": 200,
    "status": "success",
    "requestId": "1472d84d-7221-4221-b604-5c9ed07461ca",
    "data": {
        "failedMaterialIds": []
    },
    "success": true
}

成功範例,部分刪除成功

{
    "code": 200,
    "status": "success",
    "requestId": "1472d84d-7221-4221-b604-5c9ed07461ca",
    "data": {
        "failedMaterialIds": ["xxx", "yyy"]
    },
    "success": true
}

失敗範例,素材ID錯誤

{
    "code": 400,
    "status": "error",
    "requestId": "3b86d4c5-3dc2-472e-8a38-53e2b76502f3",
    "error": {
        "code": 62008,
        "desc": "素材不存在"
    },
    "data": null,
    "success": false
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}
联系客服,在线咨询