图片删除

收藏
我的收藏

接口说明

删除图片,释放图片容量。

使用限制

频率限制:单个 appID 调用上限为 50 次/秒。

基本信息

名称描述
HTTP URL
https://webcast.bytedance.com/api/file/card_image/delete
HTTP Method
POST
Scope
live.stamp.card
权限要求
  • 需要申请权限
    • 申请路径:能力-挂载-直播挂载页面配置能力
  • 不需要用户授权

请求参数

请求头
content-type必填String
示例:application/json

必须为:application/json

X-Token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
Body
image_ids必填String
示例:"["123456",123465"]"

图片ID的列表,JSON格式。长度不能超过10个。

注意:图片ID-"default",即默认图片,是不允许删除的

请求示例
curl -v -X POST https://webcast.bytedance.com/api/file/card_image/delete -d "{\"image_ids\":\"[\\\"123456\\\",\\\"654321\\\"]\"}" -H "Content-Type: application/json" -H "X-Token: xxxxxxxxxx"

响应参数

Body展开全部子属性
images_status必填List

图片删除状态的数组。

展开子属性
errcodeInt32
示例:40004
错误码
errmsgString
示例:"access token is expired"
错误描述
响应示例
正常响应示例异常响应示例
{ images_status:[ { "image_id": "123456", "delete_status": 1 }, { "image_id": "654321", "delete_status": 2 } ] }