申请临时文件上传
为本地图片或文件申请临时上传,每个文件需要固定的幂等键 idempotency_key。返回 file_key 和上传描述:state=uploading 时向 upload.url 以 PUT 发送文件原始字节并原样带上 upload.headers(不是 multipart 或 base64,也不带本平台凭证),之后用 assets/getUpload 确认。
请求
text
POST https://open.cli.im/api/v2/rpc/assets/requestUpload| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | assets.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
file_name | string | 是 | 文件名(含扩展名),不是路径,如 photo.jpg。最长 255 个字符 |
mime_type | string | 是 | 文件的 MIME 类型,如 image/jpeg;上传时的 Content-Type 必须与它一致。最长 128 个字符 |
size | integer | 是 | 文件的实际字节数,最大 20 MiB;上传的内容长度必须与它一致。最大 20971520 |
idempotency_key | string | 是 | 幂等键,每个文件的一次上传用一个固定的键;结果不明时用原键重试,不会重复申请。格式要求同其他接口的幂等键。最长 128 个字符 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/assets/requestUpload' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"file_name": "compressor.jpg",
"mime_type": "image/jpeg",
"size": 204800,
"idempotency_key": "upload-compressor-001"
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.file_key | string | 是 | 文件引用,建码和修改时填在图片、附件字段里 |
data.state | string | 是 | uploading 等待上传或处理中;temporary_available 已可引用;failed 失败;expired 已过期。可选值:uploading、temporary_available、failed、expired |
data.expires_at | integer | 否 | 临时文件的过期时间(Unix 秒);被建码或修改引用并保存后转为永久文件 |
data.upload_expires_at | integer | 否 | 上传地址的过期时间(Unix 秒) |
data.file_name | string | 否 | 文件名 |
data.mime_type | string | 否 | 文件 MIME 类型 |
data.size | integer | 否 | 文件大小(字节) |
data.error_code | string | 否 | state 为 failed 或 expired 时的原因码 |
data.upload | object | 否 | 上传方式,state 为 uploading 且文件尚未上传时返回 |
data.upload.method | string | 是 | 固定为 PUT |
data.upload.url | string | 是 | 带签名的上传地址。含临时凭证,不要记录或展示 |
data.upload.headers | object | 是 | 上传时必须原样带上的请求头 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"file_key": "free/2026/11/18/3f9a1c7e5b2d4a6c8e0f.jpg",
"state": "uploading",
"file_name": "compressor.jpg",
"mime_type": "image/jpeg",
"size": 204800,
"upload_expires_at": 1795000600,
"upload": {
"method": "PUT",
"url": "https://upload.example.com/free/2026/11/18/3f9a1c7e5b2d4a6c8e0f.jpg?signature=EXAMPLE",
"headers": {
"Content-Type": "image/jpeg",
"Content-Length": "204800"
}
}
}
}常见错误
quota_exceeded。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。