创建快捷方式

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

# 创建快捷方式

openID

300

# 接口说明

本接口用于创建文档的快捷方式。

# 权限说明

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

scope.drive.creatable

# 请求格式

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

# 请求头部

详见Headers。

# 请求参数

# 路径参数

参数名	类型	必选	描述
fileID	string	是	文档唯一标识，详见fileID

# 查询参数

无

# 请求体

参数名	类型	必选	描述
targetfolderID	string	否	创建快捷方式的目标 folder id，默认为 `/`
shareKey	string	否	共享文件夹最外层的文件夹唯一标识 , 如果列表类型是共享文件夹，需要传递该值

# 响应参数

# 请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述

# 请求包体

POST /openapi/drive/v2/files/300000000$AAAAAAAAAAAA/shortcut 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

targetFolderID=FOLDER_ID&listType=recent

1
2
3
4
5
6
7
8
9

# 示例

curl --location --request POST 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA/shortcut' \
--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 'targetFolderID=FOLDER_ID' \
--data-urlencode 'listType=recent'

1
2
3
4
5
6
7

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed'}

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 接口
10110	快捷方式已存在	已经存在快捷方式。如果需要重新创建，请删除快捷方式

查询更多业务返回码

设置水印恢复文档