抖音开放平台Logo
控制台

图片删除

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

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

使用限制

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

基本信息

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

请求头

名称字段类型是否必填示例描述
content-typeString是application/json

必须为：application/json

X-TokenString是08011218462b6b4b5054626e426e50685a7554643144644449413d3d
调用https://developer.toutiao.com/api/apps/v2/token生成的token

请求参数

Body

名称字段类型是否必填示例描述
image_idsString是"["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

名称字段类型是否必填示例描述
errcodeInt32否40004
错误码
errmsgString否"access token is expired"
错误描述

响应示例

正常响应示例

{
    images_status:[
        {
            "image_id": "123456",
            "delete_status": 1
        },
        {
            "image_id": "654321",
            "delete_status": 2
        }
    ]
}

异常响应示例

{
  "errcode": -1,
  "errmsg": "system error"
}