Senparc.Weixin —— WeChat .NET SDK

[中文]

📈 Senparc.Weixin SDK is currently the most widely used WeChat .NET SDK and one of the most popular .NET open-source projects in China. This project has been continuously maintained for over 12 years and has powered a large number of successful systems and applications. We will continue iterating, and are deeply integrating AI scenarios with more samples coming online. Welcome to join our community 👐

With Senparc.Weixin, you can quickly build applications across the entire WeChat ecosystem, including Official Accounts, Mini Programs, Mini Games, Enterprise WeChat, Open Platform, WeChat Pay, JS-SDK, WeChat hardware/Bluetooth, and more. The samples in this repository are also suitable for .NET beginners.

Currently, Senparc.Weixin supports almost all WeChat modules and APIs, and supports multiple frameworks including .NET 3.5 / 4.0 / 4.5 / .NET Standard 2.x / .NET Core 2.x / .NET Core 3.x / .NET 6.0 / .NET 7.0 / .NET 8.0 / .NET 10.0. It is compatible with MVC, Razor, WebApi, Console, desktop apps (.exe), Blazor, MAUI, background services, and more, while remaining fully decoupled from external frameworks.

Since the project started in 2013, we have kept it continuously updated for over 12 years, and have shared complete source code and design ideas without reservation. We hope more developers can benefit from it, spread the open-source spirit, and help advance open source in China. Sincere thanks to everyone who has supported us along the way.

If you like this project and want us to continue improving it, please give us a ★Star :)

🔔 Announcement

[!TIP] 🥇 Senparc Developer Community 2025-2026 Contributor Ranking

⚡ .NET 10 stable is now released. Latest Sample for .NET 10 (backward compatible), online demo: https://sdk.weixin.senparc.com/

🔥 AI chatbot WeChat integration sample is now online! View

🎬 Scott Hanselman interview on AI topics Watch video

[!NOTE] 🔒 WeChat Pay V3 module (V1.0) is online! NuGet

🎠 Fully supports automatic long-text chunking and sending. More: Auto-replying Extra-long Messages for GenAI Applications

🌟 Start: Module-by-Module Docs + Runnable Samples

[!NOTE]

1. Each module page above includes both docs and immediately runnable code templates (you only need to fill WeChat settings, no code changes required).

2. Configuration, registration, and API invocation patterns are consistent across modules. Learn one module and you can quickly apply the same approach to others.

3. The /docs directory provides more complete guidance for advanced development, click here.

4. Senparc.Weixin SDK modules are fully decoupled and independently published. To simplify dependencies, you can directly use Senparc.Weixin.All to reference all modules automatically.

🚀 Hello World: Start Your WeChat Development Journey in 3 Lines

[!NOTE]

1. The sample source code below is in /Samples/MP/Senparc.Weixin.Sample.MP, using Official Account as an example. Once you know this flow, you can apply the same pattern to Mini Program, Enterprise WeChat, WeChat Pay, etc.

2. For other module or integrated demos, see standalone samples under /Samples/ or integrated/advanced samples under /Samples/All/.

Startup code (only 2 lines):

1. <strong>Add configuration above builder.Build() in Program.cs:</strong>

builder.Services.AddSenparcWeixinServices(builder.Configuration);  

If you are using legacy Startup.cs, this line belongs in ConfigureServices().

2. <strong>Enable configuration below builder.Build() in Program.cs:</strong>

var registerService = app.UseSenparcWeixin(app.Environment, null, null, register => { },  
    (register, weixinSetting) =>  
{  
    // Register Official Account information (can be executed multiple times to register multiple Official Accounts)  
    register.RegisterMpAccount(weixinSetting, "Senparc Network Assistant Official Account");  
});  

• If you are using legacy Startup.cs, this block belongs in Configure().
• If you want auto-registration for all configured accounts, append autoRegisterAllPlatforms: true (requires Senparc.Weixin.All):

C#Copy

var registerService = app.UseSenparcWeixin(app.Environment, null, null, register => { },
    (register, weixinSetting) => { /* no manual registration needed */ },
    autoRegisterAllPlatforms: true /* auto-register all platforms */
);

Call advanced APIs (only 1 line):

You can call APIs anywhere in your program (customer service API as an example):

await CustomApi.SendTextAsync("AppId", "OpenId", "Hello World!");  

[!TIP]

1. Senparc.Weixin SDK automatically manages AccessToken through the full lifecycle. During development, you only need AppId and do not need to handle token expiration manually.

2. Registration information such as AppId can be automatically obtained from Senparc.Weixin.Config.SenparcWeixinSetting, and the relevant parameters are configured in appsettings.json.
3. A synchronous version is also available: Senparc.Weixin.MP.AdvancedAPIs.CustomApi.SendText().

4. Namespace and parameter naming follow official API documentation conventions as closely as possible (especially return fields), making code lookup and testing faster while reducing bug risks.

[!TIP] At this point, you can already apply the same pattern to all WeChat modules.

How to use Official Account messaging?

Official Accounts provide a built-in chat window for text, image, voice, and other interactions.

The same pattern also applies to Enterprise WeChat and Mini Program customer service messaging. Only two steps:

Step 1: Create a custom MessageHandler to control message processing logic:

using Senparc.NeuChar.Entities;  
using Senparc.Weixin.MP.Entities;  
using Senparc.Weixin.MP.Entities.Request;  
using Senparc.Weixin.MP.MessageContexts;  
using Senparc.Weixin.MP.MessageHandlers;  
  
namespace Senparc.Weixin.Sample.MP  
{  
    /// <summary>  
    /// Custom MessageHandler  
    /// Inherits from MessageHandler and overrides the corresponding request handling methods  
    /// </summary>  
    public partial class CustomMessageHandler : MessageHandler<DefaultMpMessageContext>  
    {  
        public CustomMessageHandler(Stream inputStream, PostModel postModel, int maxRecordCount = 0,  
            bool onlyAllowEncryptMessage = false, IServiceProvider serviceProvider = null)  
            : base(inputStream, postModel, maxRecordCount, onlyAllowEncryptMessage, null, serviceProvider)  
        {  
        }  
  
        /// <summary>  
        /// Default message for all unhandled types  
        /// </summary>  
        /// <returns></returns>  
        public override IResponseMessageBase DefaultResponseMessage(IRequestMessageBase requestMessage)  
        {  
            //ResponseMessageText can also be News or other types  
            var responseMessage = this.CreateResponseMessage<ResponseMessageText>();  
            responseMessage.Content = $"You sent a message, but the program did not specify a processing procedure";  
            return responseMessage;  
        }  
  
        public override Task<IResponseMessageBase> OnImageRequestAsync(RequestMessageImage requestMessage)  
        {  
            //Handle image requests...  
        }  
  
        public override Task<IResponseMessageBase> OnLocationRequestAsync(RequestMessageLocation requestMessage)  
        {  
            //Handle location requests...  
        }  
    }  
}  

Step 2: Request the CustomMessageHandler:

We provide two ways to request the CustomMessageHandler: Middleware (recommended) and Controller (or WebApi). You can choose either one. Taking Middleware as an example, after enabling the configuration in Program.cs, add the following code to register the MessageHandler:

app.UseMessageHandlerForMp("/WeixinAsync",  
    (stream, postModel, maxRecordCount, serviceProvider)  
        => new CustomMessageHandler(stream, postModel, maxRecordCount, false, serviceProvider),  
    options   
        =>  
    {  
        options.AccountSettingFunc = context => Senparc.Weixin.Config.SenparcWeixinSetting;  
    });  

At this point, you can use https://YourDomain/WeixinAsync to configure your WeChat Official Account backend in [Settings and Development] > [Basic Configuration] > [Server Address (URL)], and set the Token in appsettings.json (also applies to Enterprise WeChat and Mini Program; see the corresponding Samples).

In addition, you can also use the Controller (or WebApi) method to have more precise control over the entire message processing process (or use it in .NET Framework), click here to view.

Now you have mastered the basic skills required for WeChat platform development. Keep reading for more resources:

📇 More Indexes

• 🏹 Libraries by Module
• 💾 Explanation of Source Code Project Folders (under the src folder)
• 🖥️ Explanation of Samples Folder (under the Samples folder)
• 🎨 Resources
• 📖 Senparc Official Book Tutorial
• 💻 Senparc Official Video Tutorial
• 🧪 Follow the test account to experience the functions (SenparcRobot)
• ✋ Contribute Code
• 👩‍🏫 How to develop with .NET Core
• ↕️ Install via NuGet
• 🏬 Deployment
• 🍴 Important Branches
• 🍟 Thanks to Contributors
• 💰 Donate
• ⭐ Star Quantity Statistics
• 📊 Project Operations Statistics
• 📎 License

This repository includes source code for .NET Framework / .NET Standard 2.0+ / .NET Core 3.1 / .NET 6 / .NET 7 / .NET 8 / .NET 10 (same core logic):

• Open demo with Visual Studio 2022 (all versions): .NET 10.0 - Senparc.Weixin.Sample.Net10.sln (recommended, with source references)
• Open demo with Visual Studio 2022 (all versions): .NET 8.0 - Senparc.Weixin.Sample.Net8.sln (with source references)
• Open .NET Framework demo with Visual Studio 2019+ : Senparc.Weixin.MP.Sample.Net45.sln (package references only)
• Open command-line Console demo with Visual Studio 2019+ (.NET Core): Senparc.Weixin.MP.Sample.Consoles.vs2019.sln

🏹 Libraries by Module

Legend

[!WARNING]

1. Since May 1, 2019, .NET Framework 3.5 and 4.0 are no longer updated. The last stable version for .NET Framework 3.5 + 4.0 is available here.

2. Since April 3, 2022, .NET Framework 4.5 has been upgraded to 4.6.2. The last stable version for .NET Framework 4.5 is available here.

3. If you still use .NET Framework, we recommend upgrading to .NET Framework 4.8+ by January 12, 2027. Official support for .NET Framework 4.6.2 ends then (see details).

4. Use Senparc.Weixin.All to reference all modules at once.

Feature Support

• Most of the WeChat 8.x APIs are supported, including WeChat Pay, custom menu/personalized menu, template message interface, material upload interface, mass message interface, customer service interface, payment interface, WeChat store interface, card interface, invoice interface, etc.
• Support for WeChat Official Accounts, Mini Programs, Enterprise Accounts, Open Platforms, WeChat Pay, and other modules.
• Support for user session context (solving the problem of using Session to process user information on the server).
• Full support for the latest APIs of WeChat Official Accounts, Mini Programs, Enterprise Accounts (WeChat Work), WeChat Pay V2/V3, and Open Platforms.
• Support for distributed caching and caching strategy extension (default support: local cache, Redis, Memcached, can be freely extended), no need to worry about the type of cache used during development, can be freely switched in the configuration file or during runtime.

1. The official APIs are perfectly integrated, and all upgrades will try to ensure backward compatibility unless otherwise specified. So you can safely use or directly upgrade (overwrite) the latest DLLs. It is recommended to use NuGet for updates.

2. You can also modify and compile the code yourself. Open the Senparc.Weixin.Sample.Net8.sln solution to see all the source code. When the compilation mode is Release, a local NuGet package will be automatically generated (default generated in the /src/BuildOutPut/ folder).

💾 Explanation of Source Code Project Folders (under the src folder)

Enter Folder

🖥️ Explanation of Samples Folder (under the Samples folder)

The usage of all modules in the Senparc.Weixin SDK is highly consistent, including the configuration process, AccessToken management, message processing, service messages, API calls, etc. You only need to refer to the usage of any module (it is recommended to start with Official Accounts or Mini Programs), and you can apply the same principles to other modules.

From the following samples, you can learn about the configuration and usage of each independent module. Just open the .sln solution file in the corresponding folder to view the source code and run it to see the documentation. The All folder contains more comprehensive and advanced feature demonstrations.

Enter Samples Folder

🎨 Resources

1. Official website: https://weixin.senparc.com/
2. Online demo (for .NET 10.0, backward compatible with .NET 6.0, 7.0, 8.0, and .NET Core): https://sdk.weixin.senparc.com/
3. WeChat development tutorials: https://www.cnblogs.com/szw/p/weixin-course-index.html
4. WeChat technical community: https://weixin.senparc.com/QA
5. Custom menu online editor: https://sdk.weixin.senparc.com/Menu
6. Online message testing tool: https://sdk.weixin.senparc.com/SimulateTool
7. Cache testing tool: https://sdk.weixin.senparc.com/Cache/Test
8. chm help document download: https://sdk.weixin.senparc.com/Document
9. Source code and latest updates: https://github.com/JeffreySu/WeiXinMPSDK
10. WeChat development resource collection: https://github.com/JeffreySu/WeixinResource
11. Auxiliary system for reading "In-depth Analysis of WeChat Development": https://book.weixin.senparc.com
12. Purchase "In-depth Analysis of WeChat Development": https://item.jd.com/12220004.html
13. "Rapid Development of WeChat Official Accounts and Mini Programs" video tutorial: https://github.com/JeffreySu/WechatVideoCourse

• Technical communication QQ groups:

Group 1 (Official Accounts): 300313885

Group 14 (Video Course Students): 588231256

Group 10 (Distributed Cache): 246860933

Group 12 (Mini Programs): 108830388

Group 16 (Open Platform): 860626938

The following groups are full:

Group 2: 293958349 (Full), Group 3: 342319110 (Full)

Group 4: 372212092 (Full), Group 5: 377815480 (Full), Group 6: 425898825 (Full)

Group 7: 482942254 (Full), Group 8: 106230270 (Full), Group 9: 539061281 (Full)

Group 11: 553198593 (Full), Group 13: 183424136 (Open Platform, Full), Group 15: 289181996 (Full)

• Business contact QQ: 498977166

If this project is helpful to you, we welcome any form of donation or participation in code updates and feedback. Thank you!

Donation: Enter

📖 Senparc Official Book Tutorial

The WeChat development book, titled "In-Depth Analysis of WeChat Development: Efficient Development Secrets for Official Accounts and Mini Programs," completed by Jeffrey Su and the Senparc team after 2 years of effort, has been published. The book comes with an auxiliary reading system: BookHelper.

Welcome to purchase the genuine book: 【Buy Genuine】

The code snapshot of the book's publication version is in the branch BookVersion1.

💻 Senparc Official Video Tutorial

In order to help everyone understand WeChat development details more intuitively and learn practical techniques in .NET development, we established the "Senparc Classroom" group and launched WeChat development video courses, covering the following two parts:

1. WeChat development fundamentals

2. Case study of official accounts and mini programs

The total course duration is 60 lessons, with additional episodes.

Currently, the videos are available on NetEase Cloud Classroom, with well-produced content and abundant materials. The course has been selected as an "A" level course. 【Watch Videos】, 【View Course Code and Slides】.

🧪 Follow the test account to experience the functions (SenparcRobot):

✋ Contribute Code

If you need to use or modify the source code of this project, it is recommended to Fork first. You are also welcome to submit a Pull Request for the general version you modified.

1. Fork
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the remote git repository (git push origin my-new-feature)
5. Go to the my-new-feature branch of your git remote repository on the github website and submit a Pull Request
   (Submit to the Developer branch instead of the master branch directly)

👩‍🏫 How to develop with .NET Core

The current branch includes full code for .NET Framework 4.6.2+ and .NET 6.0/7.0/8.0/10.0 (for versions no longer updated, see release snapshots).

The Demo for .NET Framework is located in the /src/Samples/All/net45-mvc directory, and

[Recommended] The Demo for .NET 10.0 (compatible with .NET 5.0, 6.0, 7.0, 8.0, and .NET Core 3.1 and lower versions) is located in /Samples/All/net10-mvc.

Note: In the samples above, net10-mvc directly references each module's source code and can generate Senparc.Weixin SDK packages compatible with multiple versions when built in Release.

↕️ Install via Nuget to the project

The Nuget installation methods for each module: Installing the SDK into the project using Nuget

🏬 Deployment guide

1) Deploy to Azure App Service

App Service is a Web service launched by Microsoft Azure, which has good support for .NET. The deployment steps are detailed in: Deploy the Wechat site to Azure.

2) Deploy to any server via FTP

Install an FTP service on the web server (recommended: FileZilla Server), then upload your locally compiled code directly. The corresponding sample in Samples is Senparc.Weixin.Sample.Net10. It can be used directly after compilation without code changes. If you use Azure App Service or other cloud services, FTP is usually enabled as well.

🍴 Important Branches

2. This branch is compatible with .NET 4.5 / .NET Core / .NET Core 2.0 versions at the same time. It is recommended to submit Pull Requests for code to this branch instead of the master branch.
   | BookVersion1 | This branch is a code snapshot of the book In-Depth Analysis of Wechat Development: Efficient Development Secrets for Official Accounts and Mini Programs publication.
   | DotNET-Core_MySQL | This branch is a demonstration branch for integrating Pomelo.EntityFrameworkCore.MySql framework in .NET Core environment.
   | NET4.0     | Branch that only supports .NET 4.0. This branch was stopped updating in 2017. The latest code for .NET 4.0 is synchronized with the master / Developer branch.
   | NET3.5     | Branch that only supports .NET 3.5. This branch was stopped updating in 2015. The latest code for .NET 3.5 is synchronized with the master / Developer branch.
   | Developer-Senparc.SDK | This branch is only used for internal testing of the Senparc team and can be ignored.

🍟 Thanks To Contributors

Thanks to the developers who contributed to this project. You have not only improved this project, but also made a contribution to the Chinese open source community. Thank you! The list can be found here.

💰 Donations

If this project is useful to you, we welcome any form of donation, including participating in project code updates or providing feedback. Thank you!

Donate:

⭐ Star Quantity Statistics

📊 Project Operations Statistics

Star Growth Trend

Issues Opened and Closed Trend

Total NuGet Downloads

📎 License

Apache License Version 2.0

Copyright 2025 Jeffrey Su & Suzhou Senparc Network Technology Co.,Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the 
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
either express or implied. See the License for the specific language governing permissions 
and limitations under the License.

Detail: https://github.com/JeffreySu/WeiXinMPSDK/blob/master/license.md

[!TIP] 100% open source, commercial use supported.