Skip to content

上传进展记录图片

上传图片,以获取在进展记录富文本中使用的 token。成功调用该接口后,你可继续调用创建 OKR 进展记录更新 OKR 进展记录,将返回的 url参数和file_token 参数传入 imageList 参数中。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/okr/v1/images/upload
HTTP MethodPOST
接口频率限制100 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可okr:okr 更新 OKR 信息 okr:okr.progress.file:upload 上传 OKR 进展图片附件

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring示例值:"multipart/form-data; boundary=---7MA4YWxkTrZu0gW"

请求体

名称类型必填描述
datafile图片二进制文件。目前仅支持上传 JPG、JPEG、PNG、WEBP、GIF、BMP、ICO、TIFF、HEIC 格式的图片。
示例值:file binary
target_idstring插入图片所在的待创建/修改的进展记录对应的目标 ID,可以通过调用“批量获取 OKR”或“获取用户的 OKR 列表”接口获取对应的 Objective 或 KR 的 ID。
示例值:"6974586812998174252"
target_typeint插入图片所在的待创建/修改的进展记录对应的目标类型
示例值:2
可选值有
- 2: okr的O - 3: okr的KR

请求体示例

HTTP
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="data";
Content-Type: application/octet-stream


---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="target_id";

6974586812998174252
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="target_type";

2
---7MA4YWxkTrZu0gW

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
dataimage_info-
  └ file_tokenstring图片token
  └ urlstring图片下载链接

响应体示例

json
{
    "code": 0,
    "data": {
        "file_token": "boxbcc6DmPfgi4rNXIaGfptc9HX",
        "url": "https://internal-****.cn/stream/api/downloadFile/?file_token=boxbcc6DmPfgi4rNXIaGfptc9HX&ticket=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0YXJnZXRfaWQiOiI3MDQxNTA5NTg4MzkwMzQ2NzcyIiwidGFyZ2V0X3R5cGUiOjEsImFjdGlvbiI6MiwiZmlsZV90b2tlbiI6ImJveGJjYzZEbVBmZ2k0ck5YSWFHZnB0YzlIWCIsInVzZXJfaWQiOiI2OTY5ODU1NTAxNzQ0ODM0MDkyIiwidGVuYW50X2lkIjoiNjg3NzUwMjY4NzYwOTQwNjk5MCIsImV4cCI6MTY0MDY4MzI4OX0.VqOLS7kDtCuhyU_WuWeXvxg1XIyJxskBfNGFQP8uGkCBhYh9scwcbWQJ4xubAZs3cmsrPMVm-aho3tz5d7NT5Q"
    },
    "msg": "success"
}

错误码

HTTP状态码错误码描述排查建议
5001009999internal server error内部错误,请联系飞书助手或您的客户成功经理
5001009998system exception系统异常,请联系飞书助手或您的客户成功经理
4001001001invalid parameters无效的参数,请对照文档检查输入的参数
4001001002no permission您无权访问该接口,请确认您的登录凭证
4001001003user not found用户不存在
4001001004okr data not found对应ID的数据不存在

内容来源:飞书开放平台 · 自动爬取整理