wx-channel

中文文档

wx-channel is an async Python SDK for the WeChat iLink bot channel. It lets you log in via QR code, send/receive messages (text, image, file, video, voice), and build WeChat bots with just a few lines of code.

Features

• QR code login with account persistence
• Receive real-time messages via long-polling (text, image, file, video, voice)
• Send text, image, file messages
• CDN upload/download with AES-ECB encryption
• Multi-handler subscription and async message iterator
• Session management (connect/disconnect with auto-reconnect)

Installation

pip install wx-channel

Or from source:

pip install git+https://github.com/manymore13/wx_channel.git

Quick Start

Login

import asyncio
from wx_channel import WxChannel

async def login():
    # Generates a QR code in terminal. Scan with WeChat.
    channel = await WxChannel.from_login(timeout_sec=300)
    print(f"Logged in as: {channel.bot_id}")
    print(f"Wx user: {channel.wx_user_id}")

asyncio.run(login())

Receive messages

import asyncio
from wx_channel import WxChannel, WeixinMessage

async def listen():
    channel = await WxChannel.from_saved("your_bot_id")
    await channel.connect()

    async for msg in channel.messages():
        if msg.is_user and msg.is_finished:
            print(f"[{msg.from_user_id}] {msg.text}")

asyncio.run(listen())

Send messages

await channel.send_text(to_user_id="wx_user_id", text="Hello from bot!")
await channel.send_image(to_user_id="wx_user_id", file_path="./cat.jpg")
await channel.send_file(to_user_id="wx_user_id", file_path="./doc.pdf")

Handler mode

def on_msg(msg: WeixinMessage):
    if msg.is_user and msg.is_finished:
        print(f"[{msg.from_user_id}] {msg.text}")

channel.on_message(on_msg)
await channel.connect()
# Messages arrive in real-time via the callback

API Overview

WxChannel

Message Types

• TextItem — text content
• ImageItem — image with CDN media
• FileItem — file with CDN media
• VoiceItem — voice recording
• VideoItem — video with CDN media

Error Types

• LoginFailed — QR login failed
• LoginTimeout — QR login timed out
• SessionTimeout — session expired, re-login needed
• NetworkError — HTTP or CDN error
• ApiError — iLink API returned an error

Requirements

• Python >= 3.10
• aiohttp >= 3.9.0
• qrcode >= 7.4.0
• Pillow >= 10.0.0
• cryptography >= 41.0.0

License

MIT © manymore13