保利威文档中心

帮助中心

删除素材

更新时间: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
}
联系客服,在线咨询