介绍
... 2022-12-22 大约 2 分钟
# 介绍
腾讯文档 Open API 目前主要提供 文档操作 API 和 sheet、smartsheet 等品类的内容操作 API。
# 请求规范说明
网络协议：
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数据格式。大多数 API 的响应体结构包含ret、msg、data三个部分，有的只包含ret、msg。ret为返回码，msg为返回码描述，data为调用 API 后返回的结果；如果ret不为0则认为请求失败，失败信息可参考msg。注意，msg仅作为参考，后续可能会有变动，因此不可作为是否调用成功的判断依据。响应体示例分为下面三种：
{
"ret": 0,
"msg": "Succeed"
}
1
2
3
4
2
3
4
1
2
3
4
2
3
4
{
"ret": 0,
"msg": "Succeed",
"data": {
// 响应的具体数据内容
}
}
1
2
3
4
5
6
7
2
3
4
5
6
7
1
2
3
4
5
6
7
2
3
4
5
6
7
{
"ret": 10003,
"msg": "Background RPC service call failed"
}
1
2
3
4
2
3
4
1
2
3
4
2
3
4
# 接口描述说明
每一个接口都将按照以下模板进行描述说明。
接口说明 :
……
请求格式 :
……
Scope:
……
请求头部 :
……
请求参数 :
……
请求体 :
……
响应体 :
……
请求示例 :
……
响应示例 :
……
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Open API 业务返回码定义
用户调用腾讯文档 Open API 获得的业务返回码说明，具体的返回码与描述详见Open API 业务返回码说明