删除自定义背景
1.接口说明
调用该接口删除用户自定义上传的背景,包括图片背景、视频背景等。背景素材一经删除,不可恢复,支持批量删除。
2.请求地址
https://digitbot.bokecc.com/api/background/custom/delete
3.请求方式
POST application/json
4.请求参数
(1).公共参数,参考服务说明。
(2).接口参数
①.Query参数:通过URL参数传递。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| version | String | 是 | 接口版本号,当前支持版本:1.0.0。 |
| projectId | String | 是 | 项目ID。 |
②.Body参数:通过请求Body传递,json格式。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| backgroundId | String | 是 | 自定义背景ID,支持批量删除,多个背景ID使用","连接,最多连接100个ID。 |
5.请求示例
POST https://digitbot.bokecc.com/api/background/custom/delete?accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
{
"backgroundId": "xxxx,xxxx1,xxxx2"
}
6.响应示例
{
"result": "OK"
}
7.响应说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| result | String | 删除成功时的响应结果,字符串"OK"不区分大小写。 |