新建文档

... 2022-7-14 大约 3 分钟

# 新建文档

# 接口说明

本接口用于新建一个在线文档。可以创建的文档类型有 doc 、sheet、form、slide、mind、flowchart、smartsheet，在不传 templateID 字段的情况下默认创建一个空白文档。

# 权限说明

本接口需要拥有以下任意一项权限：

scope.drive.creatable

# 请求格式

描述	定义
Path	/openapi/drive/v2/files
Method	POST
Content-Type	application/x-www-form-urlencoded
Accept	application/json

# 请求头部

详见Headers。

# 请求参数

# 路径参数

无

# 查询参数

无

# 请求体

参数名	类型	必选	描述
title	string	是	文档的标题（长度不超过`36`字符）
type	string	是	文档类型，枚举值 `doc`：在线文档，默认值 `sheet`：在线表格 `form`：在线收集表 `slide`：在线幻灯片 `mind`：在线思维导图 `flowchart`：在线流程图表 `addon`：在线插件文档（仅供 `插件` 应用使用） `smartsheet`:在线智能表格
templateID	string	否	文档模板唯一标识，默认创建空白文档。目前仅支持官方模板
templateVersion	string	是	模板的版本号，默认为 0
folderID	string	否	文档所在文件夹唯一标识，默认为 `/`
ext	string	是	`Drive`插件文档缩略图的类型，仅 `type`=`addon`时需要填写

# 响应参数

# 响应体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述
data	json object	业务数据，详见文档信息

# 请求包体

POST /openapi/drive/v2/files HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Type: application/x-www-form-urlencoded
Content-Length: 40

type=sheet&title=test&folderID=FOLDER_ID

1
2
3
4
5
6
7
8
9

# 示例

curl --location --request POST 'https://docs.qq.com/openapi/drive/v2/files' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'type=sheet' \
--data-urlencode 'title=test' \
--data-urlencode 'folderID=FOLDER_ID'

1
2
3
4
5
6
7
8

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 3
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed', 'data': {'ID': '300000000$AAAAAAAAAAAA', 'title': 'test', 'type': 'sheet', 'url': 'https://docs.qq.com/sheet/DAAAAAAAAAAAA', 'status': 'normal', 'isCreator': True, 'isOwner': True, 'createTime': 1599811876, 'ownerName': '张三', 'creatorName': '张三'}}

1
2
3
4
5
6
7

# 错误码

错误码	错误说明	排查建议
10313	Access-Token 为空	HTTP Header 里 `Access-Token` 校验失败，请参考示例中的携带方式，检查相应字段。详情请见Headers。
10303	Open-Id 错误	HTTP Header 里 `Open-Id` 与预期不符，可能的原因有： - `Open-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Open-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和获取 Token 接口回包是否一致。
10302	Client-Id 错误	HTTP Header 里 `Client-Id` 与预期不符，可能的原因有： - `Client-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Client-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和调用获取 Token 接口接口时参数中的 `Client-Id` 是否一致。
37019	Token 校验失败，错误或过期	检查位于 HTTP Header 中的 `Access-Token` 是否正确，获取 Token 的方式请查阅授权流程以及获取 Token 接口

查询更多业务返回码

接口索引查询文档