图片上传

我的收藏

该接口用于上传图片，返回的 image_id 作为建群接口的 avatar_uri 字段传入。

使用限制

•

图片不超过 10 MB

•

仅支持 jpeg, png, bmp, webp 图片格式

接口说明

•

返回的 image_id，可用于创建更新小程序引导卡片模板等接口的图片参数

基本信息

名称	描述
HTTP URL	https://open.douyin.com/tool/imagex/client_upload/
HTTP Method	POST
Scope	tool.image.upload
权限要求	•小程序通过试运营期

请求头

名称	类型	是否必填	描述
Content-Type	string	true	MediaType, 示例： multipart/form-data
access-token	string	true	调用/oauth/client_token/ 生成的 token，示例： clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1

请求参数

Body

名称	类型	是否必填	描述	示例
image	form-data	true	图片	image

请求示例

Shell复制
curl --location 'https://open.douyin.com/tool/imagex/client_upload/' \
--header 'access-token: clt.2.PHIvk97aUgSAUZ_Nn7SgbFLuxNH2dxvZaFkJb6IZuu4v8JDO06YwUNX4QpVeMDFUZx_o6sS7kEUokA0vB4ZDmKNV-KzlBfq4ntVSdmT5_RE9tuZWsTPc-9ZZLVYjheQbu7siGOOe4uA-zVSW0YJDZYwVG6eiNbl9VZQEOTPiTnovxCS_uk8dBmW1VaU=' \
--form 'image=@"/path/to/file"'

响应参数

名称		类型	描述	示例
image_id		string	图片id	@8hxdhauTCMppanGnM4ltGM/V/x1w==
width		int	图片宽度	200
height		int	图片高度	150
md5		string	图片md5	f2cc604967e2206f5f1513a4e31839dc
extra		struct	错误信息
	description	string	错误码描述
	error_code	int	错误码	0
	logid	string	标识请求的唯一 id	202008121419360101980821035705926A
	now	int	毫秒级时间戳	1597213176393
	sub_description	string	子错误码描述
	sub_error_code	int	子错误码	0

响应示例

正常示例

json复制
{
  "extra": {
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "now": 1648797449,
    "logid": "021648797449846fd1b1111000700600000000000000086dfb920",
    "error_code": 0
  },
  "data": {
    "error_code": 0,
    "description": ""
  },
  "image_id":"@baihq==",
  "width":111
  "height":111
  "md5":""
}

异常示例

json复制
{
  "extra": {
    "sub_description": "",
    "sub_error_code": 0,
    "description": "参数不合法",
    "error_code": 2100005,
    "logid": "202203271807199888808121990491456D",
    "now": 1648375639
  },
  "data": {
    "error_code": 2100005,
    "description": "参数不合法"
  }
}