WeChatBot 0.1.1

WeChatBot

一个面向 .NET 的微信 Bot SDK，封装了登录、长轮询收消息、文本回复、媒体上传下载、输入中状态等常用能力。

当前项目目标框架为 netstandard2.1，适合被 .NET Core / .NET 5+ / ASP.NET Core 项目引用。

功能特性

• 二维码登录与凭据缓存
• 长轮询接收消息
• 文本消息发送与回复
• 图片、视频、文件消息发送
• CDN 媒体上传与下载
• 输入中状态控制
• 原始消息结构与较友好的消息模型

安装

发布到 NuGet 后可以这样安装：

dotnet add package WeChatBot

如果你还在本地开发，也可以直接以项目引用方式接入。

快速开始

using System;
using System.Threading;
using System.Threading.Tasks;
using WeChatBot;

class Program
{
    static async Task Main()
    {
        var bot = new WeChatBot.WeChatBot(new BotOptions
        {
            LogLevel = "info",
            OnQrUrl = url => Console.WriteLine($"请扫码登录: {url}"),
            OnScanned = () => Console.WriteLine("已扫码，请在微信中确认"),
            OnExpired = () => Console.WriteLine("二维码已过期，正在刷新"),
            OnError = ex => Console.WriteLine(ex.Message)
        });

        await bot.LoginAsync();

        bot.OnMessage(async message =>
        {
            Console.WriteLine($"收到来自 {message.UserId} 的消息: {message.Text}");

            if (!string.IsNullOrWhiteSpace(message.Text))
            {
                await bot.ReplyAsync(message, $"你刚才说的是: {message.Text}");
            }
        });

        await bot.RunAsync(CancellationToken.None);
    }
}

常见用法

发送文本

await bot.SendAsync(userId, "你好");

回复文本

await bot.ReplyAsync(message, "收到");

发送图片

var data = await File.ReadAllBytesAsync("demo.jpg");
await bot.SendMediaAsync(message.UserId, SendContent.FromImage(data, "这是一张图片"));

发送文件

var data = await File.ReadAllBytesAsync("report.pdf");
await bot.SendMediaAsync(message.UserId, SendContent.FromFile(data, "report.pdf", "请查收"));

下载收到的媒体

var media = await bot.DownloadAsync(message);
if (media is not null)
{
    await File.WriteAllBytesAsync(media.FileName ?? "download.bin", media.Data);
}

控制输入中状态

await bot.SendTypingAsync(message.UserId);
await Task.Delay(1500);
await bot.StopTypingAsync(message.UserId);

凭据缓存

默认会把登录凭据保存到当前用户目录下：

~/.wechatbot/credentials.json

你也可以通过 BotOptions.CredPath 指定自定义路径。

主要类型

• WeChatBot：主入口，负责登录、收发消息、媒体处理
• BotOptions：配置项
• IncomingMessage：接收到的消息模型
• SendContent：媒体或文本发送模型
• DownloadedMedia：下载后的媒体内容