QQ Open Document App OpenAPI v2

https://docs.qq.com/open/document/app/openapi/v2/
Admin
OpenAPI v2 documentation for Tencent Documents, providing REST API operations for documents,...
Tokens:1,565
Snippets:22
Trust Score:9.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### API Description Template

Source: https://docs.qq.com/open/document/app/openapi/v2

This is a template outlining the expected sections for describing each API endpoint, including request and response examples.

```text
接口说明 :
……
请求格式 :
……
Scope:
……
请求头部 :
……
请求参数 :
……
请求体 :
……
响应体 :
……
请求示例 :
……
响应示例 :
……
```

--------------------------------

### Request Headers

Source: https://docs.qq.com/open/document/app/openapi/v2

All API requests must include the following headers for authentication and authorization.

```APIDOC
## Request Headers

### Description
Requests require `Client ID`, `Open ID`, and `Access Token` for authentication and authorization.

| Parameter Name | Type   | Required | Description              |
|----------------|--------|----------|--------------------------|
| Access-Token   | string | Yes      | User's access token      |
| Client-Id      | string | Yes      | Third-party application ID |
| Open-Id        | string | Yes      | User's unique identifier |
```

--------------------------------

### API Request Specification

Source: https://docs.qq.com/open/document/app/openapi/v2

Details on the network protocol, encoding, request methods, and parameter types supported by the API.

```APIDOC
## API Request Specification

### Network Protocol
HTTPS

### Encoding Format
UTF8

### Request Methods
GET, POST, PUT, PATCH, DELETE (specific method depends on the interface)

### Request Parameters
Supports three types of parameters:
- Path Parameters
- Query Parameters
- Body Parameters
```

--------------------------------

### Basic JSON Response

Source: https://docs.qq.com/open/document/app/openapi/v2

This is a basic JSON response structure indicating a successful operation with a return code of 0.

```json
{
  "ret": 0,
  "msg": "Succeed"
}
```

--------------------------------

### Response Structure

Source: https://docs.qq.com/open/document/app/openapi/v2

API responses are in JSON format and typically include `ret`, `msg`, and `data` fields. `ret` indicates the status, `msg` provides a description, and `data` contains the results.

```APIDOC
## Response Structure

### Description
API responses are in JSON format. Most responses include `ret`, `msg`, and `data`. `ret` is the return code, `msg` is the description, and `data` contains the results. A non-zero `ret` indicates failure.

### Success Response (ret: 0)

**Format 1:**
```json
{
  "ret": 0,
  "msg": "Succeed"
}
```

**Format 2:**
```json
{
  "ret": 0,
  "msg": "Succeed",
  "data": {
    // Response specific data content
  }
}
```

### Error Response (ret != 0)

```json
{
  "ret": 10003,
  "msg": "Background RPC service call failed"
}
```
```

--------------------------------

### JSON Response with Data

Source: https://docs.qq.com/open/document/app/openapi/v2

This JSON response structure indicates a successful operation and includes a 'data' field for the response payload.

```json
{
  "ret": 0,
  "msg": "Succeed",
  "data": {
    // 响应的具体数据内容
  }
}
```

--------------------------------

### Error JSON Response

Source: https://docs.qq.com/open/document/app/openapi/v2

This JSON response structure indicates a failed operation with a specific error code and message.

```json
{
  "ret": 10003,
  "msg": "Background RPC service call failed"
}
```
Tokens:
Raw