新建文件
该接口用于在云空间指定文件夹中创建电子表格或者多维表格。
使用限制
- 云空间中根目录或文件夹的单层节点上限为 1500 个。超过此限制时,接口将返回 1062507 错误码。可通过将文件新建到不同文件夹中解决。
- 云空间中所有层级的节点总和的上限为 40 万个。
- 该接口不支持并发调用,且调用频率上限为 5QPS 且 10000次/天。否则会返回 1061045 错误码,可通过稍后重试解决。
- 该接口不支持创建文档(文档类型为
docx),如需创建文档,请调用创建文档接口。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/explorer/v2/file/:folderToken |
| HTTP Method | POST |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 docs:doc 查看、评论、编辑和管理文档 sheets:spreadsheet 查看、评论、编辑和管理电子表格 |
Tip: 了解更多权限相关信息,参考云文档常见问题。
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 通过访问凭证(access_token)对调用者身份进行鉴权。可选值: - tenant_access_token: 租户授权凭证。应用代表租户(即企业或团队)执行对应操作。示例值:"Bearer t-7f1bcd13fc57d46bac21793aabcef" - user_access_token:用户授权凭证。应用代表用户执行对应操作。示例值:"Bearer u-7f1bcd13fc57d46bac21793aabcef" 了解更多,参考获取访问凭证。 |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
folderToken | string | 指定新建文件所属的文件夹或云空间根目录的 token。了解如何获取文件夹 token,参考文件夹概述。 |
请求体
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 是 | 创建的文件的标题。 |
| type | string | 是 | 需要创建的文件的类型,可选值: - sheet:电子表格 - bitable:多维表格 |
请求体示例
json
{
"title":"测试表格",
"type":"sheet"
}响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| url | string | 新创建文件的访问链接 |
| token | string | 新创建文件的 token |
| revision | int | 新创建文件的版本号 |
响应体示例
json
{
"code":0,
"msg":"Success",
"data":{
"url":"https://example.feishu.cn/sheets/shtcnOko1Ad0HU48HH8KHabcef",
"token":"shtcnOko1Ad0HU48HH8KHabcef",
"revision":0
}
}错误码
以下为本接口相关错误码。了解更多通用错误码,参考服务端错误码说明。
| 错误码 | 说明 | 排查建议 |
|---|---|---|
| 91201 | FAILED | 处理失败,稍后重试。 |
| 91202 | PARAMERR | 参数错误,检查参数是否正确,如:type、fileToken、dstFolderToken。 |
| 91203 | NOTEXIST | 请检查请求参数是否正确。 |
| 91204 | FORBIDDEN | 检查当前应用对文档、文件夹的权限。参考云文档常见问题。 |
| 91205 | DELETED | 来源文件已被删除,检查是否还存在。 |
| 91206 | OUT_OF_LIMIT | 超过限制。 |
| 91207 | DUPLICATE | 重复记录。 |
| 91208 | REVIEW | 内容审查不通过。 |
| 91210 | doc type is deprecated, please use docx. | 旧版文档创建能力已下线,详情参考 旧版文档(Docs 1.0)创建能力下线说明。 |
| 1062507 | parent node out of sibling num. | 云空间目录下挂载数量超过限制(单层1500限制 )。 |
| 1061045 | resource contention occurred, please retry. | 发生资源争用,请稍后重试。 |
