Tencent Documents Open API

https://docs.qq.com/open/document/app/openapi
Admin
Tencent Documents Open API provides document manipulation and content operations for various...
Tokens:1,622
Snippets:9
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### API Endpoint Description Template

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

A template illustrating the structure used to describe each individual API endpoint, including its purpose, permissions, request details, response structure, examples, and error codes.

```APIDOC
## API Endpoint Description Template

### Description
[Brief description of what this endpoint does]

### Permissions
[Details on the required scopes for this endpoint]

### Request
#### Method
[HTTP method: GET, POST, PUT, DELETE, etc.]

#### Endpoint
[Full endpoint path with any path parameters]

#### Path Parameters
- **param1** (type) - Required/Optional - Description

#### Query Parameters
- **param1** (type) - Required/Optional - Description

#### Request Body
- **field1** (type) - Required/Optional - Description

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```

### Error Codes
[Details on possible error codes and their meanings for this endpoint]
```

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

### Open API Business Return Code Definition

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

Information regarding the business return codes provided by the Tencent Docs Open API. Refer to the official documentation for a comprehensive list of codes and their descriptions.

```APIDOC
## Open API Business Return Code Definition

### Description
This section provides information on the business return codes that users may receive when calling the Tencent Docs Open API. For a detailed explanation of specific return codes and their corresponding descriptions, please refer to the official 'Open API Business Return Code Explanation' documentation.
```

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

### API Request Specifications

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

Details on the general request specifications for the Tencent Docs Open API, including network protocol, encoding, HTTP methods, parameter types, and required headers for authentication and authorization.

```APIDOC
## API Request Specifications

### Description
This section outlines the general requirements for making requests to the Tencent Docs Open API, including network protocol, encoding, supported HTTP methods, parameter types, and necessary request headers for authentication and authorization.

### Network Protocol
- HTTPS

### Encoding Format
- UTF8

### Request Methods
- GET, POST, PUT, PATCH, DELETE (Specific method depends on the endpoint)

### Request Parameters
- Path Parameters
- Query Parameters
- Body Parameters

### Request Headers
- **Access-Token** (string) - Required - User's access token.
- **Client-Id** (string) - Required - Third-party application's unique identifier.
- **Open-Id** (string) - Required - User's unique identifier.

### Permissions
- Permissions (scopes) required for each API endpoint are specified in the endpoint descriptions. Scopes depend on the third-party application's granted scopes and those specified during authorization.

### Response Format
- JSON

### Error Handling
- **Success:** HTTP Status Code 200, with a response body conforming to the API definition.
- **Failure:** HTTP Status Code not 200, with an error response containing `code`, `message`, and `details`.
```
Tokens:
Raw