图片上传

更新时间 2024-07-24 02:58:49
收藏
我的收藏
在讲解卡中上传图片。​

使用限制​

频率限制:单个 appID 调用上限为 50 次/秒。​
容量限制:单个 appID 图片容量为 10000 张。(如果需要更大容量,请跟我们联系)
注意⚠️:单次上传仅支持上传单张图片。​

请求地址

HTTP
复制
POST https://webcast.bytedance.com/api/file/card_image/upload

请求参数

请求Headers​

属性​
数据类型​
必填​
说明​
X-Token​
string​
是​
通过接口获取的 access_token。详情可参考:getAccessToken
Content-Type​
string​
是​
必须为:multipart/form-data​

请求 Multipart part​

name属性​
数据类型​
必填​
说明​
image_id​
string​
是​
图片 ID,需保证唯一性。​
当图片 ID 内容在审核中或者审核失败时,可以复用该ID重新上传;​
当图片 ID 内容审核通过后,即使删除了该ID的图片,该ID也不能够再次用于上传图片。​
特别地,我们将使用 ID 为"default"的图片作为默认图片。默认图片将会替换讲解卡中的无效图片(如已删除的图片)作为显示。​
image_file​
file​
是​
大小限制不要超过 5M。​
其中 part 的 header 细节:​
    image_id的 part header 如 Content-Disposition: form-data;name="image_id"。​
    image_file的 part header 如下:​
    Content-Disposition: form-data; name="image_file"; filename="xxxxx"​
    Content-Type: image/jpeg​
    图片类型支持:jpg、jpeg、 png。​

返回值

正确返回的 JSON 数据包​

属性​
数据类型​
说明​
status​
number​
图片状态。可选值如下:​
1-上传成功,2-审核中,3-审核通过,4-审核失败,5-异常错误,6-已删除​

异常返回的JSON数据包​

属性​
数据类型​
说明​
errcode​
number​
错误码​
errmsg​
string​
错误信息​

请求示例

Shell
复制
curl -v -X POST https://webcast.bytedance.com/api/file/card_image/upload -F "image_file=@/Users/bytedance/images/123456.png" -F "image_id=123456" -H "Content-Type: multipart/form-data" -H "X-Token: xxxxxxxxxx"

返回示例​

正常返回:​
JSON
复制
{
"status": 1
}
错误返回:​
JSON
复制
{
"errcode": -1,
"errmsg": "system error"
}