WeChat Pad Pro

https://github.com/wechatpadpro/wechatpadpro
Admin
WeChat Pad Pro is a powerful WeChat management tool based on WeChat Pad protocol, providing...
Tokens:26,800
Snippets:222
Trust Score:5.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start WeChat Service (Linux)

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Starts the WeChat service on Linux and redirects output logs to a file. Ensure you have the necessary permissions.

```bash
/opt/wechat/wechat_service >/opt/wechat/run.log 2>&1 &
```

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

### Start the Service

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Command to launch the application containers in detached mode.

```bash
docker-compose up -d
```

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

### Curl Example: Submit Verification Code

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Command-line example using curl to submit a verification code for login, referencing the UUID obtained earlier.

```bash
curl -X POST "http://localhost:8080/api/login/AutoVerificationcode" \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "abc123def456",
    "code": "123456"
  }'
```

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

### Curl Example: Get New QR Code

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Command-line example using curl to request a new WeChat login QR code with specified device information.

```bash
curl -X POST "http://localhost:8080/api/login/qr/newx" \
  -H "Content-Type: application/json" \
  -d '{
    "deviceName": "iPhone",
    "deviceId": "123456789"
  }'
```

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

### Response Example for Login Status Check

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Indicates the current login status, such as 'scanned', and provides user information if available.

```json
{
  "code": 200,
  "success": true,
  "message": "扫码状态",
  "data": {
    "status": "scanned",
    "userInfo": {
      "wxid": "wxid_abc123",
      "nickname": "用户昵称"
    }
  }
}
```

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

### 获取Redis最大内存配置

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

使用`redis-cli config get maxmemory`命令获取当前Redis设置的最大内存限制。用于验证内存限制配置是否正确。

```Shell
redis-cli config get maxmemory
```

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

### 获取Redis内存淘汰策略配置

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

使用`redis-cli config get maxmemory-policy`命令获取当前Redis设置的内存淘汰策略。用于确认淘汰策略是否生效。

```Shell
redis-cli config get maxmemory-policy
```

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

### Error Response Example: Missing Authorization

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Example of an error response when a valid authorization token is missing.

```json
{
  "code": 400,
  "success": false,
  "message": "请提供有效的授权码"
}
```

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

### Response Example for Verification Code Submission

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Confirms successful verification code submission and provides basic user information upon successful login.

```json
{
  "code": 200,
  "success": true,
  "message": "验证码提交成功",
  "data": {
    "loginResult": "success",
    "userInfo": {
      "wxid": "wxid_abc123",
      "nickname": "用户昵称",
      "avatar": "头像URL"
    }
  }
}
```

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

### Response Example for QR Code Generation

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

This JSON response contains the QR code details, including a unique UUID, the QR code image data, its URL, expiration time, and device information.

```json
{
  "code": 200,
  "success": true,
  "message": "获取二维码成功",
  "data": {
    "uuid": "abc123def456",
    "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "qrcodeUrl": "https://login.weixin.qq.com/qrcode/abc123def456",
    "expireTime": 300,
    "deviceId": "123456789",
    "data62": "base64encodeddata..."
  }
}
```

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

### Docker Compose Deployment

Source: https://context7.com/wechatpadpro/wechatpadpro/llms.txt

A Docker Compose configuration for a one-click deployment of the complete WeChatPadPro service, including MySQL and Redis databases. This setup simplifies the deployment process for the entire application stack.

```yaml
#docker-compose.yml
version: '3.8'

services:
  wechatpadpro:
    image: wechatpadpro/wechatpadpro:latest
    container_name: wechatpadpro
    restart: always
    ports:
      - "8080:8080"
      - "1238:1238"
    environment:
      - DB_HOST=mysql
      - REDIS_HOST=redis
      - TZ=Asia/Shanghai
      - ADMIN_KEY=your_admin_key_here
    depends_on:
      - mysql
      - redis

  mysql:
    image: mysql:8.0
    container_name: mysql
    environment:
      MYSQL_ROOT_PASSWORD: root123456
      MYSQL_DATABASE: weixin
      MYSQL_USER: weixin
      MYSQL_PASSWORD: weixin123
    volumes:
      - mysql_data:/var/lib/mysql

  redis:
    image: redis:6
    container_name: redis
    command: redis-server --appendonly yes
    volumes:
      - redis_data:/data

volumes:
  mysql_data:
  redis_data:
```

```bash
#啟動服務
cd deploy
docker-compose up -d
```

```bash
#查看服務狀態
docker-compose ps
```

```bash
#查看日誌
docker-compose logs -f
```

```bash
#停止服務
docker-compose down
```

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

### Initialize MySQL Database

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Use this command to initialize the MySQL 5.7+ database. Replace 'root密碼' with your actual root password.

```bash
./01_InitMySQL -passwd="root密碼"
```

```bash
01_InitMySQL.exe -passwd="root密碼"
```

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

### Clone the Project Repository

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Initial step to download the source code and navigate to the deployment directory.

```bash
git clone https://github.com/WeChatPadPro/WeChatPadPro.git
cd WeChatPadPro/deploy
```

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

### Docker Quick Deployment

Source: https://context7.com/wechatpadpro/wechatpadpro/llms.txt

Instructions for deploying WeChatPadPro using Docker Compose, including MySQL and Redis.

```APIDOC
## Docker Quick Deployment

### Description
Use Docker Compose for a one-click deployment of the complete WeChatPadPro service, including MySQL and Redis.

### `docker-compose.yml` Configuration
```yaml
version: '3.8'

services:
  wechatpadpro:
    image: wechatpadpro/wechatpadpro:latest
    container_name: wechatpadpro
    restart: always
    ports:
      - "8080:8080"
      - "1238:1238"
    environment:
      - DB_HOST=mysql
      - REDIS_HOST=redis
      - TZ=Asia/Shanghai
      - ADMIN_KEY=your_admin_key_here
    depends_on:
      - mysql
      - redis

  mysql:
    image: mysql:8.0
    container_name: mysql
    environment:
      MYSQL_ROOT_PASSWORD: root123456
      MYSQL_DATABASE: weixin
      MYSQL_USER: weixin
      MYSQL_PASSWORD: weixin123
    volumes:
      - mysql_data:/var/lib/mysql

  redis:
    image: redis:6
    container_name: redis
    command: redis-server --appendonly yes
    volumes:
      - redis_data:/data

volumes:
  mysql_data:
  redis_data:
```

### Deployment Commands

- **Start Services**: 
  ```bash
  cd deploy
  docker-compose up -d
  ```

- **Check Service Status**: 
  ```bash
  docker-compose ps
  ```

- **View Logs**: 
  ```bash
  docker-compose logs -f
  ```

- **Stop Services**: 
  ```bash
  docker-compose down
  ```
```

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

### 配置Redis内存淘汰策略

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

直接编辑Redis配置文件（如redis.conf）来设置内存淘汰策略。修改后需要重启Redis服务。

```Redis Configuration
# 设置内存淘汰策略为LRU算法（最近最少使用）
maxmemory-policy allkeys-lru
```

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

### Configure Environment Variables

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Configuration settings for MySQL, Redis, and the WeChat Pad Pro service within the .env file.

```ini
# MySQL配置
MYSQL_ROOT_PASSWORD=root123456
MYSQL_DATABASE=weixin
MYSQL_USER=weixin
MYSQL_PASSWORD=123456
MYSQL_PORT=3306

# Redis配置
REDIS_PASSWORD=123456
REDIS_PORT=6379

# WeChat Pad Pro配置
WECHAT_PORT=8080
DB_HOST=wechatpadpro_mysql
DB_PORT=3306
DB_DATABASE=weixin
DB_USERNAME=weixin
DB_PASSWORD=123456
REDIS_HOST=wechatpadpro_redis
REDIS_DB=0

# 管理員密鑰（建議使用複雜的隨機字符串）
ADMIN_KEY=999222
```

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

### GET /api/login/CheckLoginStatus

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Checks the current status of the login process using the provided UUID key.

```APIDOC
## GET /api/login/CheckLoginStatus

### Description
Checks the current status of the login process using the provided UUID key.

### Method
GET

### Endpoint
/api/login/CheckLoginStatus

### Parameters
#### Query Parameters
- **key** (string) - Required - The UUID key associated with the login session

### Response
#### Success Response (200)
- **code** (integer) - Status code
- **success** (boolean) - Operation success status
- **message** (string) - Response message
- **data** (object) - Contains status and userInfo

#### Response Example
{
  "code": 200,
  "success": true,
  "message": "扫码状态",
  "data": {
    "status": "scanned",
    "userInfo": {
      "wxid": "wxid_abc123",
      "nickname": "用户昵称"
    }
  }
}
```

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

### 使用脚本配置Redis内存（Windows）

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

在Windows系统下使用提供的批处理脚本配置Redis内存。需要指定Redis服务器地址、端口、密码、最大内存限制和淘汰策略。

```Batch
scripts\config_redis_memory.bat [host] [port] [password] [maxmemory] [policy]
```

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

### Request for Checking Login Status

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Use this GET request to check the login status using the provided key (UUID).

```http
GET /api/login/CheckLoginStatus?key=abc123def456
```

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

### 配置 .env 文件

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/usage_guide_for_old_users.md

在 .env 文件中指定本地 webhook 的 URL 和密钥。

```text
WEBHOOK_URL=http://localhost:8000/webhook
WEBHOOK_SECRET=your_secret_key
```

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

### 配置Redis最大内存限制

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

直接编辑Redis配置文件（如redis.conf）来设置最大内存限制。修改后需要重启Redis服务。

```Redis Configuration
# 设置最大内存为1GB
maxmemory 1GB
```

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

### Get Redis Memory Statistics

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_usage_guide.md

Retrieves detailed statistics about Redis memory usage, including current usage, maximum limits, and adaptive mode status.

```APIDOC
## GET /api/v1/other/RedisMemory?action=stats

### Description
Retrieves statistics about Redis memory usage.

### Method
GET

### Endpoint
/api/v1/other/RedisMemory?action=stats

### Query Parameters
- **action** (string) - Required - Specifies the action to perform, should be 'stats'.

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **msg** (string) - Response message.
- **data** (object) - Contains memory statistics.
  - **used_memory** (string) - Current memory used by Redis in bytes.
  - **used_memory_human** (string) - Current memory used by Redis in human-readable format.
  - **used_memory_rss** (string) - Resident Set Size of Redis memory.
  - **used_memory_rss_human** (string) - Resident Set Size of Redis memory in human-readable format.
  - **maxmemory** (string) - Maximum memory limit set for Redis.
  - **maxmemory_human** (string) - Maximum memory limit set for Redis in human-readable format.
  - **maxmemory_policy** (string) - The maxmemory-policy currently in effect.
  - **memory_usage_percent** (string) - Percentage of memory currently used.
  - **adaptive_mode** (string) - Indicates if adaptive memory mode is enabled.
  - **current_check_interval** (string) - The interval for memory checks in nanoseconds.

### Response Example
```json
{
  "code": 0,
  "msg": "获取Redis内存统计信息成功",
  "data": {
    "used_memory": "1073741824",
    "used_memory_human": "1.00G",
    "used_memory_rss": "1181116416",
    "used_memory_rss_human": "1.10G",
    "maxmemory": "2147483648",
    "maxmemory_human": "2.00G",
    "maxmemory_policy": "allkeys-lru",
    "memory_usage_percent": "50.00%",
    "adaptive_mode": "true",
    "current_check_interval": "1800000000000"
  }
}
```
```

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

### GET /api/login/CheckLoginStatus - Check Login Status

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录安全验证码解决流程.md

This endpoint allows you to check the status of the WeChat login process. It can confirm if the login was successful or if a verification code is still required.

```APIDOC
## GET /api/login/CheckLoginStatus

### Description
Checks the status of the QR code scan and login process. It can return success or indicate that a verification code is needed.

### Method
GET

### Endpoint
/api/login/CheckLoginStatus

### Parameters
#### Query Parameters
- **key** (string) - Required - The unique key (UUID) obtained from the `GetLoginQrCodeNewX` endpoint.

### Request Example
```bash
curl -X GET "http://localhost:8080/api/login/CheckLoginStatus?key=abc123def456"
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains login status information:
  - **status** (string) - The current status of the login (e.g., "success").
  - **userInfo** (object) - User details if login is successful:
    - **wxid** (string) - The WeChat ID of the user.
    - **nickname** (string) - The nickname of the user.

#### Response Example (Login Successful)
```json
{
  "code": 200,
  "success": true,
  "message": "登录成功",
  "data": {
    "status": "success",
    "userInfo": {
      "wxid": "wxid_abc123",
      "nickname": "用户昵称"
    }
  }
}
```

#### Response Example (Verification Code Required)
- **code** (integer) - The status code indicating verification is needed.
- **success** (boolean) - Indicates failure to complete login without verification.
- **message** (string) - A message indicating that a verification code is required.
- **data** (string) - The ticket value, which might be needed in some scenarios (though typically handled automatically).

#### Response Example (Verification Code Required)
```json
{
  "code": -3,
  "success": false,
  "message": "请提交验证码后登录",
  "data": "ticket_value_here"
}
```
```

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

### 使用脚本配置Redis内存（Linux/macOS）

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

在Linux/macOS系统下使用提供的Shell脚本配置Redis内存。需要指定Redis服务器地址、端口、密码、最大内存限制和淘汰策略。

```Shell
bash scripts/config_redis_memory.sh [host] [port] [password] [maxmemory] [policy]
```

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

### Generate New QR Code for Login

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Use this endpoint to initiate the login process by generating a new QR code. Requires device name and ID. The response includes a unique UUID, the QR code image data, a URL for the QR code, and expiration time.

```bash
curl -X POST "http://localhost:8080/api/login/qr/newx" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_token_here" \
  -d '{
    "deviceName": "iPhone",
    "deviceId": "123456789"
  }'
```

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

### MySQL 5.7 配置優化

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

針對 MySQL 5.7 版本調整 InnoDB 相關配置以解決潛在的錯誤。

```ini
[mysqld]
innodb_file_format = Barracuda
innodb_file_per_table = 1
innodb_large_prefix = 1
```

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

### 获取微信登录二维码 (Bash)

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录安全验证码解决流程.md

使用此接口获取微信登录二维码，支持绕过验证码流程。可选参数包括代理、设备名称和设备ID。

```bash
curl -X POST "http://localhost:8080/api/login/GetLoginQrCodeNewX" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_auth_key" \
  -d '{
    "proxy": "http://proxy.example.com:8080",  // 可选，代理设置
    "deviceName": "iPhone",                    // 可选，设备名称
    "deviceId": "123456789"                   // 可选，设备ID
  }'
```

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

### Request QR Code Generation

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Example request to generate a new QR code for WeChat login. It specifies the device name and ID, and includes an authorization token. The response contains the QR code details and a unique UUID.

```json
{
    "deviceName": "iPhone",
    "deviceId": "123456789"
  }
```

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

### POST /api/login/GetLoginQrCodeNewX - Get WeChat Login QR Code

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录安全验证码解决流程.md

This endpoint retrieves a WeChat login QR code, supporting a process that bypasses manual verification code steps. It returns a unique UUID and the QR code data, along with other relevant information for the login process.

```APIDOC
## POST /api/login/GetLoginQrCodeNewX

### Description
Gets a WeChat login QR code, supporting the bypass of the verification code flow. It returns a UUID, QR code, and other necessary data for subsequent steps.

### Method
POST

### Endpoint
/api/login/GetLoginQrCodeNewX

### Parameters
#### Request Body
- **proxy** (string) - Optional - Proxy server settings for the request.
- **deviceName** (string) - Optional - The name of the device used for login.
- **deviceId** (string) - Optional - The unique identifier for the device.

### Request Example
```bash
curl -X POST "http://localhost:8080/api/login/GetLoginQrCodeNewX" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_auth_key" \
  -d '{
    "proxy": "http://proxy.example.com:8080",  // Optional, proxy settings
    "deviceName": "iPhone",                    // Optional, device name
    "deviceId": "123456789"                   // Optional, device ID
  }'
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains login-related data:
  - **uuid** (string) - The unique identifier for the device, required for subsequent steps.
  - **qrcode** (string) - The QR code in data URI format (e.g., data:image/png;base64,...).
  - **qrcodeUrl** (string) - The URL of the QR code.
  - **expireTime** (integer) - The expiration time of the QR code in seconds.
  - **deviceId** (string) - The device ID.
  - **data62** (string) - System-generated data62 value, no manual handling needed.

#### Response Example
```json
{
  "code": 200,
  "success": true,
  "message": "获取二维码成功",
  "data": {
    "uuid": "abc123def456",
    "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "qrcodeUrl": "https://login.weixin.qq.com/qrcode/abc123def456",
    "expireTime": 300,
    "deviceId": "123456789",
    "data62": "base64encodeddata..."
  }
}
```
```

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

### Login QR Code and Status Check

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Steps to initiate a login session and monitor its status.

```bash
POST /api/login/qr/new
{
  "proxy": "http://proxy:port",  // 可选：代理设置
  "deviceName": "iPhone",        // 可选：设备名称
  "deviceId": "device_id"        // 可选：设备ID
}
```

```bash
GET /api/login/status?key=your-uuid
```

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

### 配置 webhook-client.py

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/usage_guide_for_old_users.md

修改 webhook-client.py 中的密钥与消息包含设置，确保与 webhook_config.json 同步。

```python
WEBHOOK_SECRET = "your_secret_key"  # 修改為與 webhook_config.json 中相同的密鑰
INCLUDE_SELF_MESSAGE = True  # 是否包含自己發送的消息
```

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

### MySQL 綠色版初始化命令

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

根據 MySQL 版本選擇對應的初始化指令。

```shell
# 隨機生成root密碼初始化
mysqld --initialize --console

# 不設置root密碼初始化
mysqld --initialize-insecure
```

```shell
# 1. 使用mysql_install_db初始化資料目錄
mysql_install_db --datadir="/path/to/your/mysql/data"
# 2. 啟動MySQL服務
mysqld --console
# 3. 設置root密碼
mysqladmin -u root password "你的root密碼"
# 4. 驗證登入
mysql -u root -p
```

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

### 安装 Flask 依赖

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/usage_guide_for_old_users.md

运行 webhook-client.py 前必须安装 Flask 库。

```bash
pip install flask
```

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

### 检测登录状态 (Bash)

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录安全验证码解决流程.md

检测微信扫码登录的状态。如果需要验证码，响应码为-3；如果登录成功，响应码为200。

```bash
curl -X GET "http://localhost:8080/api/login/CheckLoginStatus?key=abc123def456"
```

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

### Software Configuration Files

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Details on the configuration files used by WeChatPadPro, including `setting.json` and `owner.json`, and their respective parameters.

```APIDOC
## Software Configuration Files

### `setting.json`
This file contains general application settings.

- **debug** (boolean) - Whether to enable debug logging.
- **port** (integer) - The service port number.
- **apiVersion** (string) - The API version (e.g., `/v849`).
- **ghWxid** (string) - The public account wxid for traffic diversion.
- **adminKey** (string) - The authorization key for the admin interface.
- **redisConfig** (object) - Redis connection configuration:
  - **Port** (integer) - Redis port.
  - **Db** (integer) - Redis database number.
  - **Pass** (string) - Redis password.
- **mySqlConnectStr** (string) - MySQL connection string.

### `owner.json`
This file is used to set administrator wxids. After setting an administrator's wxid, management commands can be used via the file transfer assistant.

```json
{
  "wxid_xxx": 1
}
```
> Replace `wxid_xxx` with the actual administrator's wxid.
```

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

### 查看Redis内存使用情况

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

使用`redis-cli info memory`命令查看Redis的详细内存信息。适用于排查内存相关问题。

```Shell
redis-cli info memory
```

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

### 查找Redis大体积键

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

使用`redis-cli --bigkeys`命令找出Redis中体积较大的键。有助于定位内存占用过高的原因。

```Shell
redis-cli --bigkeys
```

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

### 自动处理验证码提交 (Bash)

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录安全验证码解决流程.md

自动提交微信安全验证码，后端会自动处理Data62和Ticket参数。只需要提供uuid和用户输入的验证码。

```bash
curl -X POST "http://localhost:8080/api/login/AutoVerificationcode" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_auth_key" \
  -d '{
    "uuid": "abc123def456",
    "code": "123456"
  }'
```

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

### Python WeChatPadPro Client Login Flow

Source: https://context7.com/wechatpadpro/wechatpadpro/llms.txt

Provides a complete client implementation in Python, supporting synchronous and asynchronous operations for login, QR code generation, status checking, and message sending. Requires a base URL and authentication token.

```python
import requests
import time

class WeChatPadProClient:
    def __init__(self, base_url: str, auth_token: str):
        self.base_url = base_url
        self.session = requests.Session()
        self.session.headers.update({
            'Content-Type': 'application/json',
            'Authorization': f'Bearer {auth_token}'
        })

    def get_qr_code(self, device_name: str = 'iPhone', proxy: str = None) -> dict:
        """獲取登入二維碼"""
        data = {'deviceName': device_name}
        if proxy:
            data['proxy'] = proxy

        response = self.session.post(f'{self.base_url}/api/login/qr/newx', json=data)
        return response.json()

    def check_login_status(self, uuid: str) -> dict:
        """檢查登入狀態"""
        response = self.session.get(
            f'{self.base_url}/api/login/CheckLoginStatus',
            params={'key': uuid}
        )
        return response.json()

    def submit_verification_code(self, uuid: str, code: str) -> dict:
        """提交驗證碼"""
        response = self.session.post(
            f'{self.base_url}/api/login/AutoVerificationcode',
            json={'uuid': uuid, 'code': code}
        )
        return response.json()

    def send_message(self, to_user: str, content: str, msg_type: int = 1) -> dict:
        """發送訊息"""
        response = self.session.post(
            f'{self.base_url}/api/v1/message/send',
            json={'toUserName': to_user, 'content': content, 'msgType': msg_type}
        )
        return response.json()

    def login_flow(self, proxy: str = None) -> dict:
        """完整登入流程"""
        # 獲取二維碼
        qr_result = self.get_qr_code(proxy=proxy)
        if not qr_result.get('success'):
            raise Exception(qr_result.get('message', '獲取二維碼失敗'))

        uuid = qr_result['data']['uuid']
        print(f"請掃描二維碼: {qr_result['data']['qrcodeUrl']}")

        # 輪詢狀態
        while True:
            status = self.check_login_status(uuid)

            if status['code'] == -3:
                code = input('請輸入驗證碼: ')
                result = self.submit_verification_code(uuid, code)
                if result.get('success'):
                    return result['data']
            elif status['code'] == 200:
                if status['data'].get('status') == 'success':
                    return status['data']
            elif status['code'] == 300:
                raise Exception('二維碼已過期')

            time.sleep(2)
```

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

### Common Docker Commands

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Standard commands for managing the lifecycle and monitoring of the Docker containers.

```bash
# 查看服務狀態
docker-compose ps

# 查看日誌
docker-compose logs -f

# 停止服務
docker-compose down

# 重啟服務
docker-compose restart
```

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

### Manual Redis Memory Configuration Scripts

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

Scripts for manually configuring Redis memory settings on different operating systems.

```APIDOC
## Windows Configuration Script

### Description
Configures Redis memory settings on Windows systems.

### Command
`scripts\config_redis_memory.bat [host] [port] [password] [maxmemory] [policy]`

### Parameters
- **host** (string) - Optional - Redis server address. Defaults to 'localhost'.
- **port** (integer) - Optional - Redis port. Defaults to 6379.
- **password** (string) - Optional - Redis password. Defaults to empty.
- **maxmemory** (string) - Optional - Maximum memory limit (e.g., '1GB'). Defaults to '1GB'.
- **policy** (string) - Optional - Memory eviction policy (e.g., 'allkeys-lru'). Defaults to 'allkeys-lru'.
```

```APIDOC
## Linux/macOS Configuration Script

### Description
Configures Redis memory settings on Linux or macOS systems.

### Command
`bash scripts/config_redis_memory.sh [host] [port] [password] [maxmemory] [policy]`

### Parameters
- **host** (string) - Optional - Redis server address. Defaults to 'localhost'.
- **port** (integer) - Optional - Redis port. Defaults to 6379.
- **password** (string) - Optional - Redis password. Defaults to empty.
- **maxmemory** (string) - Optional - Maximum memory limit (e.g., '1GB'). Defaults to '1GB'.
- **policy** (string) - Optional - Memory eviction policy (e.g., 'allkeys-lru'). Defaults to 'allkeys-lru'.
```

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

### WeChatPadPro Login API Integration in JavaScript

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/微信登录验证码API使用指南.md

Demonstrates the full login flow including QR code retrieval, status polling, and manual verification code submission.

```javascript
// 获取二维码
async function getQRCode() {
  const response = await fetch('/api/login/qr/newx', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer your_token_here'
    },
    body: JSON.stringify({
      deviceName: 'iPhone',
      deviceId: '123456789'
    })
  });
  
  const result = await response.json();
  return result.data;
}

// 提交验证码
async function submitVerificationCode(uuid, code) {
  const response = await fetch('/api/login/AutoVerificationcode', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer your_token_here'
    },
    body: JSON.stringify({
      uuid: uuid,
      code: code
    })
  });
  
  const result = await response.json();
  return result;
}

// 检查登录状态
async function checkLoginStatus(uuid) {
  const response = await fetch(`/api/login/CheckLoginStatus?key=${uuid}`);
  const result = await response.json();
  return result;
}

// 完整流程示例
async function loginFlow() {
  try {
    // 1. 获取二维码
    const qrData = await getQRCode();
    console.log('二维码获取成功:', qrData);
    
    // 2. 轮询检查状态
    const checkStatus = async () => {
      const status = await checkLoginStatus(qrData.uuid);
      
      if (status.code === -3) {
        // 需要验证码
        const userCode = prompt('请输入验证码:');
        if (userCode) {
          const result = await submitVerificationCode(qrData.uuid, userCode);
          console.log('验证码提交结果:', result);
        }
      } else if (status.code === 200) {
        console.log('登录成功:', status.data);
        return;
      }
      
      // 继续轮询
      setTimeout(checkStatus, 2000);
    };
    
    checkStatus();
    
  } catch (error) {
    console.error('登录流程出错:', error);
  }
}
```

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

### Manage Webhook Configurations

Source: https://context7.com/wechatpadpro/wechatpadpro/llms.txt

Configures and manages webhooks for real-time event notifications, including support for HMAC-SHA256 signatures and retry logic.

```bash
# 創建 Webhook 配置
curl -X POST "http://localhost:8080/v1/webhook/Config" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook/receiver",
    "events": ["message", "login", "logout", "friend_request"],
    "enabled": true,
    "retry_count": 3,
    "retry_interval": 5,
    "timeout": 30,
    "secret_key": "your_hmac_secret_key",
    "receive_self_msg": false
  }'

# 更新 Webhook 配置
curl -X PUT "http://localhost:8080/v1/webhook/Update" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1,
    "enabled": true,
    "retry_count": 5
  }'

# 獲取所有 Webhook 配置
curl -X GET "http://localhost:8080/v1/webhook/List"

# 查看 Webhook 狀態
curl -X GET "http://localhost:8080/v1/webhook/Status"

# 測試 Webhook 連通性
curl -X GET "http://localhost:8080/v1/webhook/Test?id=1"
```

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

### 發送檔案 API 接口

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

用於通過 API 發送圖片、視頻或文檔。filePath 與 fileData 參數二選一即可。

```http
POST /api/v1/message/sendFile
Content-Type: multipart/form-data

{
  "toUserName": "接收者微信ID",
  "filePath": "本地檔案路徑",  // 與fileData二選一
  "fileData": "base64編碼的檔案數據",  // 與filePath二選一
  "fileName": "檔案名稱",
  "fileType": "檔案類型"  // 可選值: image, video, file
}
```

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

### 管理員配置檔案

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

設置管理員 wxid 以便通過檔案傳輸助手執行管理命令。

```json
{
  "wxid_xxx": 1
}
```

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

### Webhook Configuration Management API

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Endpoints for managing Webhook configurations.

```bash
POST   /v1/webhook/Config        # 創建新的Webhook配置
PUT    /v1/webhook/Update        # 更新現有Webhook配置
GET    /v1/webhook/List          # 獲取所有Webhook配置列表
GET    /v1/webhook/Status        # 查看Webhook配置狀態
GET    /v1/webhook/Test          # 測試Webhook連通性
```

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

### Set Environment Variables

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

Setting the ADMIN_KEY environment variable for different operating systems.

```bash
# Linux/macOS
export ADMIN_KEY="您的管理密鑰"

# Windows
$env:ADMIN_KEY="您的管理密鑰"
```

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

### 启用/禁用Redis自适应内存管理

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/static/doc/redis_memory_management.md

通过此API启用或禁用自适应内存管理模式。设置`enabled=true`启用，设置`enabled=false`则使用固定内存限制。

```HTTP
GET /api/v1/other/RedisMemory?action=adaptive&enabled=true
```

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

### Webhook Configuration APIs

Source: https://github.com/wechatpadpro/wechatpadpro/blob/main/README.md

APIs for managing webhook configurations, including creation, updates, listing, and testing.

```APIDOC
## POST /v1/webhook/Config

### Description
Creates a new webhook configuration.

### Method
POST

### Endpoint
/v1/webhook/Config

### Parameters
#### Request Body
- **type** (string) - Required - The type of webhook.
- **url** (string) - Required - The URL to send webhook events to.
- **filter_message_types** (array) - Optional - List of message types to filter.
- **retry_count** (integer) - Optional - Number of retries for failed deliveries.
- **timeout** (integer) - Optional - Timeout in seconds for webhook requests.
- **signature_key** (string) - Optional - Key for message signature verification.
- **enabled** (boolean) - Optional - Whether the webhook is enabled.
- **receive_own_message** (boolean) - Optional - Whether to receive own messages.

### Request Example
```json
{
  "type": "message",
  "url": "https://example.com/webhook",
  "filter_message_types": ["text", "image"],
  "retry_count": 3,
  "timeout": 10,
  "signature_key": "your-secret-key",
  "enabled": true,
  "receive_own_message": false
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the created webhook configuration.
- **message** (string) - Success message.

#### Response Example
```json
{
  "id": "wh_12345",
  "message": "Webhook configuration created successfully"
}
```
```

```APIDOC
## PUT /v1/webhook/Update

### Description
Updates an existing webhook configuration.

### Method
PUT

### Endpoint
/v1/webhook/Update

### Parameters
#### Request Body
- **id** (string) - Required - The ID of the webhook configuration to update.
- **url** (string) - Optional - The URL to send webhook events to.
- **filter_message_types** (array) - Optional - List of message types to filter.
- **retry_count** (integer) - Optional - Number of retries for failed deliveries.
- **timeout** (integer) - Optional - Timeout in seconds for webhook requests.
- **signature_key** (string) - Optional - Key for message signature verification.
- **enabled** (boolean) - Optional - Whether the webhook is enabled.
- **receive_own_message** (boolean) - Optional - Whether to receive own messages.

### Request Example
```json
{
  "id": "wh_12345",
  "enabled": false
}
```

### Response
#### Success Response (200)
- **message** (string) - Success message.

#### Response Example
```json
{
  "message": "Webhook configuration updated successfully"
}
```
```

```APIDOC
## GET /v1/webhook/List

### Description
Retrieves a list of all webhook configurations.

### Method
GET

### Endpoint
/v1/webhook/List

### Response
#### Success Response (200)
- **configurations** (array) - A list of webhook configurations.
  - **id** (string) - The ID of the webhook configuration.
  - **type** (string) - The type of webhook.
  - **url** (string) - The URL of the webhook.
  - **enabled** (boolean) - Whether the webhook is enabled.
  - **last_delivery_status** (string) - Status of the last delivery.
  - **last_delivery_time** (string) - Timestamp of the last delivery.

#### Response Example
```json
{
  "configurations": [
    {
      "id": "wh_12345",
      "type": "message",
      "url": "https://example.com/webhook",
      "enabled": true,
      "last_delivery_status": "success",
      "last_delivery_time": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

```APIDOC
## GET /v1/webhook/Status

### Description
Retrieves the status of a specific webhook configuration.

### Method
GET

### Endpoint
/v1/webhook/Status

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the webhook configuration.

### Response
#### Success Response (200)
- **id** (string) - The ID of the webhook configuration.
- **status** (string) - The current status of the webhook.
- **last_delivery_time** (string) - Timestamp of the last delivery.
- **last_delivery_status** (string) - Status of the last delivery.
- **total_deliveries** (integer) - Total number of deliveries.
- **successful_deliveries** (integer) - Number of successful deliveries.
- **failed_deliveries** (integer) - Number of failed deliveries.

#### Response Example
```json
{
  "id": "wh_12345",
  "status": "active",
  "last_delivery_time": "2023-10-27T10:00:00Z",
  "last_delivery_status": "success",
  "total_deliveries": 100,
  "successful_deliveries": 95,
  "failed_deliveries": 5
}
```
```

```APIDOC
## GET /v1/webhook/Test

### Description
Tests the connectivity of a webhook configuration.

### Method
GET

### Endpoint
/v1/webhook/Test

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the webhook configuration to test.

### Response
#### Success Response (200)
- **message** (string) - Indicates whether the test was successful.

#### Response Example
```json
{
  "message": "Webhook test successful"
}
```
```
Tokens:
Raw