Skip to content

上传附件

为特定资源上传附件。本接口可以支持一次上传多个附件,最多5个。每个附件尺寸不超过50MB,格式不限。

上传请求体的格式为"form-data"。若希望上传多个附件,则提供多个"file"字段即可。返回的附件顺序将会与输入的file顺序保持一致。

目前资源类型仅支持"task", resource_id需要填写任务的GUID。

Tip: 为任务上传附件需要任务的可编辑权限

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v2/attachments/upload
HTTP MethodPOST
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:attachment:write 查看、创建、删除任务附件
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
resource_typestring附件归属资源的类型
示例值:"task"
默认值task
resource_idstring附件要归属资源的id。例如,要给任务添加附件,这里要填入任务GUID。任务GUID可以通过任务相关接口获得。
示例值:"fe96108d-b004-4a47-b2f8-6886e758b3a5"
数据校验规则
- 最大长度:100 字符
filefile要上传的文件,单请求支持最多5个文件。上传结果的顺序将和请求中文件的顺序保持一致。
示例值:file binary

请求体示例

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

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

fe96108d-b004-4a47-b2f8-6886e758b3a5
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file";
Content-Type: application/octet-stream


---7MA4YWxkTrZu0gW

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsattachment\[\]上传的附件列表
    └ guidstring附件GUID
    └ file_tokenstring附件在云文档系统中的token
    └ namestring附件名
    └ sizeint附件的字节大小
    └ resourceresource附件归属的资源
      └ typestring资源类型
      └ idstring资源ID
    └ uploadermember附件上传者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ is_coverboolean是否是封面图
    └ uploaded_atstring上传时间戳(ms)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "guid": "f860de3e-6881-4ddd-9321-070f36d1af0b",
                "file_token": "boxcnTDqPaRA6JbYnzQsZ2doB2b",
                "name": "foo.jpg",
                "size": 62232,
                "resource": {
                    "type": "task",
                    "id": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
                },
                "uploader": {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "creator"
                },
                "is_cover": false,
                "uploaded_at": "1675742789470"
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数有误。查看返回中的msg 确定具体原因。
4031470403资源不存在或已删除。确认资源是否还存在。
4041470404缺少上传附件的权限。确认调用身份拥有上传的权限。
5001470500服务器错误。使用同样请求重试调用接口。如果持续返回错误,可以联系技术支持排查问题。

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