创建电子表格

在云空间指定目录下创建电子表格。可自定义表格标题。不支持带内容创建表格。

Tip: 要基于模板创建电子表格，可先获取模板电子表格的 spreadsheet_token 作为文件 token，再调用复制文件接口创建电子表格。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets
HTTP Method	POST
接口频率限制	20 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:create 创建电子表格

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
title	string	否	表格标题 示例值："Sales sheet" 数据校验规则： - 长度范围：0 ～ 255 字符
folder_token	string	否	文件夹 token。你可通过以下两种方式获取文件夹的 token： - 文件夹的 URL：https://sample.feishu.cn/drive/folder/==fldbcO1UuPz8VwnpPx5a92abcef== - 调用开放平台接口获取： - 调用获取我的空间（root folder）元数据接口获取根目录（即根文件夹）的 token。 - 继续调用获取文件夹中的文件清单接口，获取根目录下文件夹的 token。 提示：要在知识库中创建电子表格，你需调用创建知识空间节点接口，并选择表格（sheet）类型。 示例值："fldbcO1UuPz8VwnpPx5a92abcef"

请求体示例

{
    "title": "Sales sheet",
    "folder_token": "fldbcO1UuPz8VwnpPx5a92abcef"
}

cURL 请求示例

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets' \
--header 'Authorization: Bearer u-3iqkd6KWzRLzNdXfeuCMEb' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"sales sheet",
    "folder_token":"fldbcO1UuPz8VwnpPx5a92abcef"
}'

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ spreadsheet	spreadsheet	电子表格的基础信息
└ title	string	电子表格标题
└ folder_token	string	文件夹 token
└ url	string	电子表格的 URL 链接
└ spreadsheet_token	string	电子表格 token

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "spreadsheet": {
            "title": "Sales sheet",
            "folder_token": "fldbcO1UuPz8VwnpPx5a92abcef",
            "url": "https://example.feishu.cn/sheets/Iow7sNNEphp3WbtnbCscPqabcef",
            "spreadsheet_token": "Iow7sNNEphp3WbtnbCscPqabcef"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1315203	Server Error	服务内部错误，详询客服
400	1310204	Wrong Request Body	检查请求体参数, 参考响应体中的错误提示
400	1310213	Permission Fail	当前调用身份没有电子表格的阅读（获取相关接口）或编辑（创建、更新等相关接口）权限。请参考以下方式解决： - 如果你使用的是 tenant_access_token，意味着当前应用没有电子表格的阅读或编辑权限。你需通过电子表格网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加权限。 说明：在 添加文档应用 前，你需确保目标应用至少开通了一个云文档 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 如果你使用的是 user_access_token，意味着当前用户没有电子表格的阅读或编辑权限。你需通过电子表格网页页面右上方 分享 入口为当前用户添加权限。 了解具体操作步骤或其它添加权限方式，参考云文档常见问题 3。
400	1310235	Retry Later	稍后重试
500	1315201	Server Error	服务内部错误，详询客服
400	1310226	Excess Limit	超出限制，参考响应体中的错误提示