介绍
... 2022-12-22 大约 2 分钟
# 介绍
腾讯文档 Open API 目前主要提供 文档操作 API 和 doc、sheet、smartsheet 等品类的内容操作 API。
注意：
文件管理、在线表格、在线智能表格、在线收集表相关接口请查阅OpenAPI V2 介绍
# 请求规范说明
网络协议：
HTTPS协议。编码格式：
UTF8编码。请求方法：
GET、POST、PUT、PATCH、DELETE（具体方法见每个接口的描述）。请求参数：支持
3种，分别为Path Parameters（路径参数）、Query Parameters（查询参数）和Body Parameters（请求体参数）。请求头部：需要携带
Client ID、Open ID和Access Token三元组，后台用来做认证与鉴权。参数定义：
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Access-Token | string | 是 | 用户的访问令牌 |
| Client-Id | string | 是 | 第三方应用唯一标识 |
| Open-Id | string | 是 | 用户唯一标识 |
权限说明：每个接口描述会标注
Access Token需要的scope，而scope则依赖第三方应用的所获得的scope和发起授权时指定的scope。响应结果：
JSON数据格式。 如果接口请求成功，则HTTP Status Code为200, 并且返回对应接口定义的回包结构体；如果接口请求不成功，则HTTP Status Code不为200，并且返回的错误响应结构包含code、message、details三个部分。 其中code为错误码，msg为错误码描述，details为错误详情。详细的错误处理可见Open API 业务返回码说明
# 接口描述说明
每一个接口都将按照以下模板进行描述说明。
接口说明 :
……
权限说明:
……
请求 :
……
响应 :
……
示例 :
……
错误码 :
……
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# Open API 业务返回码定义
用户调用腾讯文档 Open API 获得的业务返回码说明，具体的返回码与描述详见Open API 业务返回码说明