wecom-aibot-sdk 1.0.7

企业微信智能机器人 Python SDK —— 基于 WebSocket 长连接通道

wecom-aibot-sdk

企业微信智能机器人 Python SDK —— 基于 WebSocket 长连接通道，提供消息收发、流式回复、模板卡片、事件回调、文件下载解密等核心能力。

本项目为 @wecom/aibot-node-sdk 的 Python 版本，API 和使用方式保持一致。

特性

• WebSocket 长连接 — 基于 wss://openws.work.weixin.qq.com 内置默认地址，开箱即用
• 自动认证 — 连接建立后自动发送认证帧（botId + secret）
• 心跳保活 — 自动维护心跳，连续未收到 ack 时自动判定连接异常
• 断线重连 — 指数退避重连策略（1s → 2s → 4s → ... → 30s 上限），支持自定义最大重连次数
• 消息分发 — 自动解析消息类型并触发对应事件（text / image / mixed / voice / file）
• 流式回复 — 内置流式回复方法，支持 Markdown 和图文混排
• 模板卡片 — 支持回复模板卡片消息、流式+卡片组合回复、更新卡片
• 主动推送 — 支持向指定会话主动发送 Markdown 或模板卡片消息，无需依赖回调帧
• 事件回调 — 支持进入会话、模板卡片按钮点击、用户反馈等事件
• 串行回复队列 — 同一 req_id 的回复消息串行发送，自动等待回执
• 文件下载解密 — 内置 AES-256-CBC 文件解密，每个图片/文件消息自带独立的 aeskey
• 临时素材上传 — 通过 WebSocket 通道分片上传（init → chunk × N → finish），支持 image / file / voice / video 类型
• 媒体消息收发 — 被动回复媒体消息（reply_media）和主动发送媒体消息（send_media_message）
• 断开事件感知 — 自动识别 disconnected_event（新连接顶替旧连接），阻止无效重连
• 连接参数扩展 — 支持 scene（场景标识）和 plug_version（插件版本号）认证参数
• WebSocket 选项透传 — 通过 ws_options 参数传递底层 websockets.connect() 额外配置
• 可插拔日志 — 支持自定义 Logger，内置带时间戳的 DefaultLogger
• 异步架构 — 基于 asyncio + websockets，性能优异

安装

# 使用 uv
uv add wecom-aibot-sdk

# 或 pip
pip install wecom-aibot-sdk

快速开始

import asyncio
from wecom_aibot_sdk import WSClient, generate_req_id

async def main():
    # 1. 创建客户端实例
    ws_client = WSClient(
        bot_id="your-bot-id",       # 企业微信后台获取的机器人 ID
        secret="your-bot-secret",   # 企业微信后台获取的机器人 Secret
    )

    # 2. 监听认证成功
    ws_client.on("authenticated", lambda: print("认证成功"))

    # 3. 监听文本消息并进行流式回复
    async def on_text(frame):
        content = frame["body"]["text"]["content"]
        print(f"收到文本: {content}")

        stream_id = generate_req_id("stream")

        # 发送流式中间内容
        await ws_client.reply_stream(frame, stream_id, "正在思考中...", False)

        # 发送最终结果
        await asyncio.sleep(1)
        await ws_client.reply_stream(frame, stream_id, f'你好！你说的是: "{content}"', True)

    ws_client.on("message.text", on_text)

    # 4. 监听进入会话事件（发送欢迎语）
    async def on_enter(frame):
        await ws_client.reply_welcome(frame, {
            "msgtype": "text",
            "text": {"content": "您好！我是智能助手，有什么可以帮您的吗？"},
        })

    ws_client.on("event.enter_chat", on_enter)

    # 5. 建立连接
    await ws_client.connect()

    # 6. 保持运行
    try:
        await asyncio.Event().wait()
    except KeyboardInterrupt:
        await ws_client.disconnect()

asyncio.run(main())

API 文档

WSClient

核心客户端类，提供连接管理、消息收发等功能。

构造函数

ws_client = WSClient(
    bot_id="your-bot-id",
    secret="your-bot-secret",
    # 以下为可选参数
    scene=1,                     # 场景标识
    plug_version="1.0.0",        # 插件版本号
    reconnect_interval=1000,
    max_reconnect_attempts=10,
    heartbeat_interval=30000,
    request_timeout=10000,
    ws_url="",
    ws_options=None,             # 透传给 websockets.connect() 的额外参数
    logger=None,
)

方法

方法	说明	返回值
await connect()	建立 WebSocket 连接，连接后自动认证	WSClient（支持链式调用）
await disconnect()	主动断开连接	None
on(event, handler)	注册事件监听器（支持同步/异步 handler）	WSClient（支持链式调用）
off(event, handler?)	移除事件监听器	WSClient
await reply(frame, body, cmd?)	通用回复方法	WsFrame
await reply_stream(frame, stream_id, content, finish?, msg_item?, feedback?)	流式文本回复（支持 Markdown）	WsFrame
await reply_welcome(frame, body)	欢迎语回复（5s 内调用）	WsFrame
await reply_template_card(frame, template_card, feedback?)	回复模板卡片消息	WsFrame
await reply_stream_with_card(frame, stream_id, content, finish?, ...)	流式 + 模板卡片组合回复	WsFrame
await update_template_card(frame, template_card, userids?)	更新模板卡片（5s 内调用）	WsFrame
await send_message(chatid, body)	主动发送消息	WsFrame
await upload_media(file_data, *, type, filename)	上传临时素材（分片上传）	UploadMediaFinishResult
await reply_media(frame, media_type, media_id, ...)	被动回复媒体消息	WsFrame
await send_media_message(chatid, media_type, media_id, ...)	主动发送媒体消息	WsFrame
await download_file(url, aes_key?)	下载文件并解密	{"buffer": bytes, "filename": str | None}

属性

属性	说明	类型
is_connected	当前 WebSocket 连接状态	bool
api	内部 API 客户端实例（高级用途）	WeComApiClient

reply_stream 详细说明

await ws_client.reply_stream(
    frame,              # 收到的原始 WebSocket 帧（透传 req_id）
    stream_id,          # 流式消息 ID（使用 generate_req_id("stream") 生成）
    content,            # 回复内容（支持 Markdown）
    finish=False,       # 是否结束流式消息
    msg_item=None,      # 图文混排项（仅 finish=True 时有效）
    feedback=None,      # 反馈信息（仅首次回复时设置）
)

reply_welcome 详细说明

发送欢迎语回复，需在收到 event.enter_chat 事件 5 秒内调用。

# 文本欢迎语
await ws_client.reply_welcome(frame, {
    "msgtype": "text",
    "text": {"content": "欢迎！"},
})

# 模板卡片欢迎语
await ws_client.reply_welcome(frame, {
    "msgtype": "template_card",
    "template_card": {"card_type": "text_notice", "main_title": {"title": "欢迎"}},
})

reply_stream_with_card 详细说明

await ws_client.reply_stream_with_card(
    frame,                          # 收到的原始 WebSocket 帧
    stream_id,                      # 流式消息 ID
    content,                        # 回复内容（支持 Markdown）
    finish=False,                   # 是否结束流式消息
    msg_item=None,                  # 图文混排项（仅 finish=True 时有效）
    stream_feedback=None,           # 流式消息反馈信息（首次回复时设置）
    template_card=None,             # 模板卡片内容（同一消息只能回复一次）
    card_feedback=None,             # 模板卡片反馈信息
)

send_message 详细说明

# 发送 Markdown 消息
await ws_client.send_message("userid_or_chatid", {
    "msgtype": "markdown",
    "markdown": {"content": "这是一条**主动推送**的消息"},
})

# 发送模板卡片消息
await ws_client.send_message("userid_or_chatid", {
    "msgtype": "template_card",
    "template_card": {"card_type": "text_notice", "main_title": {"title": "通知"}},
})

download_file 使用示例

async def on_image(frame):
    body = frame.get("body", {})
    image_url = body.get("image", {}).get("url", "")
    aes_key = body.get("image", {}).get("aeskey")

    result = await ws_client.download_file(image_url, aes_key)
    print(f"文件名: {result['filename']}, 大小: {len(result['buffer'])} bytes")

ws_client.on("message.image", on_image)

upload_media 详细说明

通过 WebSocket 通道分片上传临时素材（三步流程：init → chunk × N → finish），单个分片不超过 512KB，最多 100 个分片。

# 上传图片素材
with open("photo.png", "rb") as f:
    file_data = f.read()

result = await ws_client.upload_media(file_data, type="image", filename="photo.png")
print(f"media_id: {result['media_id']}")
# result: {"type": "image", "media_id": "...", "created_at": "..."}

支持的素材类型：image、file、voice、video。

reply_media / send_media_message 详细说明

# 被动回复媒体消息（在收到消息的 handler 中使用）
async def on_text(frame):
    # 先上传素材
    result = await ws_client.upload_media(image_bytes, type="image", filename="reply.png")
    # 被动回复图片
    await ws_client.reply_media(frame, "image", result["media_id"])

ws_client.on("message.text", on_text)

# 主动发送媒体消息到指定会话
await ws_client.send_media_message("chatid", "image", media_id)

# 视频类型支持额外的标题和描述
await ws_client.send_media_message(
    "chatid", "video", media_id,
    video_title="演示视频",
    video_description="这是一段测试视频",
)

配置选项

参数	类型	必填	默认值	说明
bot_id	str	是	—	机器人 ID（企业微信后台获取）
secret	str	是	—	机器人 Secret（企业微信后台获取）
scene	int	—	None	场景标识，认证时传递给服务端
plug_version	str	—	None	插件版本号，认证时传递给服务端
reconnect_interval	int	—	1000	重连基础延迟（毫秒），指数退避递增（1s → 2s → 4s → ... → 30s 上限）
max_reconnect_attempts	int	—	10	最大重连次数（-1 表示无限重连）
heartbeat_interval	int	—	30000	心跳间隔（毫秒）
request_timeout	int	—	10000	HTTP 请求超时时间（毫秒）
ws_url	str	—	wss://openws.work.weixin.qq.com	自定义 WebSocket 连接地址
ws_options	dict	—	None	透传给 websockets.connect() 的额外参数
logger	Logger	—	DefaultLogger	自定义日志实例

事件列表

所有事件均通过 ws_client.on(event, handler) 监听，handler 支持同步函数和异步函数：

事件	回调参数	说明
connected	—	WebSocket 连接建立
authenticated	—	认证成功
disconnected	reason: str	连接断开
reconnecting	attempt: int	正在重连（第 N 次）
error	error: Exception	发生错误
message	frame: WsFrame	收到消息（所有类型）
message.text	frame: WsFrame	收到文本消息
message.image	frame: WsFrame	收到图片消息
message.mixed	frame: WsFrame	收到图文混排消息
message.voice	frame: WsFrame	收到语音消息
message.file	frame: WsFrame	收到文件消息
event	frame: WsFrame	收到事件回调（所有事件类型）
event.enter_chat	frame: WsFrame	收到进入会话事件
event.template_card_event	frame: WsFrame	收到模板卡片事件
event.feedback_event	frame: WsFrame	收到用户反馈事件
event.disconnected_event	frame: WsFrame	服务端因新连接建立断开当前连接（不会自动重连）

消息类型

SDK 支持以下消息类型（MessageType 枚举）：

类型	值	说明
TEXT	"text"	文本消息
IMAGE	"image"	图片消息（URL 已加密，使用消息中的 image.aeskey 解密）
MIXED	"mixed"	图文混排消息（包含 text / image 子项）
VOICE	"voice"	语音消息（已转文本）
FILE	"file"	文件消息（URL 已加密，使用消息中的 file.aeskey 解密）

SDK 支持以下事件类型（EventType 枚举）：

类型	值	说明
ENTER_CHAT	"enter_chat"	进入会话事件
TEMPLATE_CARD_EVENT	"template_card_event"	模板卡片事件
FEEDBACK_EVENT	"feedback_event"	用户反馈事件
DISCONNECTED	"disconnected_event"	服务端因新连接断开当前连接

自定义日志

实现 Logger 协议即可自定义日志输出：

class Logger:
    def debug(self, message: str, *args) -> None: ...
    def info(self, message: str, *args) -> None: ...
    def warn(self, message: str, *args) -> None: ...
    def error(self, message: str, *args) -> None: ...

使用示例：

import logging

class MyLogger:
    def __init__(self):
        self._logger = logging.getLogger("AiBot")

    def debug(self, message, *args):
        self._logger.debug(f"{message} {' '.join(str(a) for a in args)}")

    def info(self, message, *args):
        self._logger.info(f"{message} {' '.join(str(a) for a in args)}")

    def warn(self, message, *args):
        self._logger.warning(f"{message} {' '.join(str(a) for a in args)}")

    def error(self, message, *args):
        self._logger.error(f"{message} {' '.join(str(a) for a in args)}")

ws_client = WSClient(
    bot_id="your-bot-id",
    secret="your-bot-secret",
    logger=MyLogger(),
)

项目结构

wecom-aibot-python-sdk/
├── src/
│   └── wecom_aibot_sdk/
│       ├── __init__.py          # 入口文件，统一导出
│       ├── client.py            # WSClient 核心客户端
│       ├── ws.py                # WebSocket 长连接管理器
│       ├── message_handler.py   # 消息解析与事件分发
│       ├── api.py               # HTTP API 客户端（文件下载）
│       ├── crypto.py            # AES-256-CBC 文件解密
│       ├── logger.py            # 默认日志实现
│       ├── utils.py             # 工具方法（generate_req_id 等）
│       └── types.py             # 类型定义
├── examples/
│   └── basic.py                 # 基础使用示例
├── .env.example                 # 环境变量示例
├── pyproject.toml               # 项目配置
└── README.md

开发

# 安装依赖
uv sync

# 安装含示例依赖
uv sync --extra examples

# 运行示例
uv run --extra examples python examples/basic.py

发布到 PyPI

仓库已提供 GitHub Actions 发布流程，工作流文件为 .github/workflows/release.yml。

推荐流程：

1. 在 main 分支完成代码合并，并把 pyproject.toml 里的版本号更新到要发布的版本。
2. 推送 main 后，在对应提交上创建并推送版本标签，例如 v1.0.6。
3. GitHub Actions 会在 tag push 后执行测试、构建 sdist / wheel，然后通过 PyPI Trusted Publisher 自动发布。

注意：

• 推送的 tag 必须和 pyproject.toml 中的版本一致，例如版本是 1.0.6 时，tag 必须是 v1.0.6
• workflow 已内置这个校验，不一致会直接失败，避免错误版本被发布到 PyPI

示例命令：

git switch main
git pull
git tag v1.0.6
git push origin v1.0.6

为什么使用 tag 触发，而不是“main 分支版本号一变就自动发布”：

• tag 发布更明确，避免普通版本改动或预备提交误触发正式发布。
• 可以配合 GitHub 的 protected tags 和 environment 审批，安全性更高。
• 这也是 PyPI Trusted Publishing 官方文档中更常见、风险更低的模式。

PyPI Trusted Publisher 配置

在 PyPI 项目页面进入 Manage -> Publishing -> Add a new publisher，选择 GitHub Actions，填写：

• Owner: xiaowangzhixiao
• Repository name: wecom-aibot-python-sdk
• Workflow name: release.yml
• Environment name: pypi

其中 Environment name 不是强制项，但官方强烈建议配置。建议同时在 GitHub 仓库里创建 pypi environment，并开启以下保护：

• 只允许 main 分支和 v* 标签使用这个 environment
• 为 environment 配置 required reviewers
• 为 v* 配置 protected tags

工作流结构

当前发布 workflow 分成两个 job：

• build: 安装依赖、运行测试、构建 dist/ 产物，并上传为 artifact
• publish: 下载 dist/ 产物，用 pypa/gh-action-pypi-publish 通过 OIDC 发布到 PyPI

这样可以把 id-token: write 权限只留给真正执行发布的 job，符合 PyPI 和 PyPA 的最佳实践。

与 Node.js SDK 的对应关系

Node.js	Python	说明
new WSClient(options)	WSClient(bot_id=..., secret=...)	构造方式改为关键字参数
wsClient.connect()	await ws_client.connect()	异步方法
wsClient.on('event', handler)	ws_client.on("event", handler)	handler 支持 sync/async
wsClient.replyStream(...)	await ws_client.reply_stream(...)	snake_case 命名
wsClient.replyWelcome(...)	await ws_client.reply_welcome(...)	snake_case 命名
wsClient.replyTemplateCard(...)	await ws_client.reply_template_card(...)	snake_case 命名
wsClient.replyStreamWithCard(...)	await ws_client.reply_stream_with_card(...)	可选参数改为 keyword-only
wsClient.updateTemplateCard(...)	await ws_client.update_template_card(...)	snake_case 命名
wsClient.sendMessage(...)	await ws_client.send_message(...)	snake_case 命名
wsClient.uploadMedia(...)	await ws_client.upload_media(...)	分片上传临时素材
wsClient.replyMedia(...)	await ws_client.reply_media(...)	被动回复媒体消息
wsClient.sendMediaMessage(...)	await ws_client.send_media_message(...)	主动发送媒体消息
wsClient.downloadFile(...)	await ws_client.download_file(...)	返回 dict 而非 object
generateReqId(prefix)	generate_req_id(prefix)	snake_case 命名

License

MIT