weixin-bot — WeChat (微信) iLink Bot SDK

Library

概要

weixin-bot は、WeChat iLink プラットフォーム向けのボット SDK で、エージェント(外部アプリ)を 5 分で WeChat メッセージに接続できることを目標に設計されています。特徴は「ゼロ設定」で動作する点で、QR コードでのログインと認証情報の自動保存、長輪詢による受信処理、HTTP API によるメッセージ送信、context_token の自動管理、入力中(typing)ステータスの送出、セッション切れ時の自動再ログインなどを備えます。ローカルで完結するため、Webhook サーバーを用意せずに開発・運用が可能です。

GitHub

リポジトリの統計情報

  • スター数: 90
  • フォーク数: 7
  • ウォッチャー数: 90
  • コミット数: 18
  • ファイル数: 9
  • メインの言語: Python

主な特徴

  • QR コードによる簡単ログインと認証情報の自動保存(ローカルストア)
  • 長輪詢でのメッセージ受信と HTTP 経由での送信(Webhook 不要)
  • context_token とセッションの自動管理、切断時の自動再ログイン対応
  • Typing ステータス対応やシンプルなイベント API による拡張性

技術的なポイント

weixin-bot の設計上の核は「ローカル完結」と「エージェント抽象化」です。まずクライアント側は QR コード認証でセッションを確立し、認証情報をローカルに保存して次回以降を自動復元します。受信は長輪詢(ロングポーリング)で実装されており、恒常的な接続や Webhook を不要にします。送信は HTTP API 呼び出しで行うため、Bot の返信処理はシンプルな非同期呼び出しで済みます。

context_token(コンテキスト識別子)は SDK が管理し、エージェントはトークンの更新や有効期限を意識する必要がありません。セッションの有効期限切れや通信エラー時には自動的に再ログインやリトライを行う仕組みが用意されているため、運用中の安定性が高くなっています。さらに Typing 状態の送出やセッション単位のメッセージ管理など、ユーザ体験に関わる細かなプロトコルもラップされている点が便利です。

リポジトリには AGENTS.md や PROTOCOL.md が含まれ、Agent(外部統合)の設計や通信プロトコルのドキュメントが整備されています。Node.js / Python のクロスランゲージサポートを想定した API 設計で、イベント駆動モデル(onMessage など)によりエコー返信やカスタムハンドラを簡単に実装できます。セキュリティ面では認証情報をローカル保存することで外部サーバに公開するリスクを低減しますが、ローカル保存の暗号化や適切な権限制御は利用者の実装に委ねられる点に注意が必要です。

(上記は約700字の技術解説)

プロジェクトの構成

主要なファイルとディレクトリ:

  • .DS_Store: file
  • .gitignore: file
  • AGENTS.md: file
  • PROTOCOL.md: file
  • README.md: file

…他 4 ファイル

まとめ

簡潔に導入でき、ローカル運用に向く軽量な WeChat iLink ボット SDK。

リポジトリ情報:

READMEの抜粋:

weixin-bot

微信 iLink Bot SDK — 让任何 Agent 5 分钟接入微信消息。

特性

  • 扫码登录,凭证自动保存
  • 长轮询收消息,HTTP 发消息
  • context_token 自动管理,开发者无需关心
  • Typing 状态(“对方正在输入中”)
  • Session 过期自动重登录
  • 零配置,零 Webhook,纯本地运行

快速开始

Node.js

npm install @pinixai/weixin-bot
import { WeixinBot } from '@pinixai/weixin-bot'

const bot = new WeixinBot()
await bot.login()

bot.onMessage(async (msg) => {
  await bot.sendTyping(msg.userId)
  await bot.reply(msg, `Echo: ${msg.text}`)
})

await bot.run()