获取附件下载链接
获取附件下载链接
Tip: 下载链接仅可使用两次,链接有效期两小时。
Warning: 使用 tenant_access_token 时,需要申请邮件数据资源的数据权限。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/messages/:message_id/attachments/download_url |
| HTTP Method | GET |
| 接口频率限制 | 1 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | mail:user_mailbox.message.body:read 获取邮件正文 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
user_mailbox_id | string | 用户邮箱地址 或 输入me代表当前调用接口用户 示例值:"user@xxx.xx 或 me" |
message_id | string | 用户邮件 id,获取方式见 列出邮件 示例值:"TUlHc1NoWFhJMXgyUi9VZTNVL3h6UnlkRUdzPQ==" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
attachment_ids | string\[\] | 是 | 附件 id 列表 示例值:YQqYbQHoQoDqXjxWKhJbo8Gicjf 数据校验规则: - 长度范围: 1 ~ 20 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ download_urls | attachment_download_url_item\[\] | 下载链接列表 |
└ attachment_id | string | 附件 id |
└ download_url | string | 下载链接 |
└ failed_ids | string\[\] | 获取失败的附件 id 列表 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"download_urls": [
{
"attachment_id": "YQqYbQHoQoDqXjxWKhJbo8Gicjf",
"download_url": "https://api-drive-stream.blmpb.com/space/api/box/stream/download/authcode/?code=YTZiZGViMDg3NzRjMzEwOWRkMGI1MTJlYmQxYTFmYTBfZTA5ZjZiOWU4NDYzMzkxMDUyOTIxMzBmNTVjMjAyZTFfSUQ6NzI4MTE4Nzg1OTE5NTc3Mjk0N18xNjk1ODg4NjQyOjE2OTU4ODg3MDJfVjM"
}
],
"failed_ids": [
"YQqYbQHoQoDqXjxWKhJbo8Gicjf"
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1230001 | param invalid | 修改参数后重试 |
| 500 | 1230003 | no permission | 成为公共邮箱成员或申请相关数据权限后调用该接口 |
| 403 | 1230002 | internal server error | 请稍后重试 |
