Basic_ModelDefinition.md

August 13, 2026 · View on GitHub

如何快速找到需要调用的 API 模型类名 / 方法名?


本库提供的请求模型、响应模型和接口方法,三者均保持同名。

例如,发送模板消息的请求是 CgibinMessageTemplateSendRequest,响应是 CgibinMessageTemplateSendResponse,接口是 ExecuteCgibinMessageTemplateSendAsync()。知道其中一个,其余两个就可以快速地推断出了。

再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的发送模板消息,它的接口地址是 [POST] /cgi-bin/message/template/send,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。

完整的模型定义可以参考项目目录下的 src/SKIT.FlurlHttpClient.Wechat.Api/Models 目录。


找不到所需要的接口或字段?

本库会定期随微信官方更新接口或模型,但也会偶有疏漏。如果你在使用中遇到了因接口或模型定义而产生的问题,欢迎提出 Issue。

在 Issue 被处理之前,你也可以选择自行扩展 API。详细方式请参阅本文档《基础用法 - 如何扩展额外的 API?》


微信公众平台 & 微信开放平台 API 支持情况:

1. 公众号

[展开查看]
微信 API备注
基础功能
OpenAPI 管理
自定义菜单
基础消息能力
订阅通知
客服消息
微信网页开发
素材管理
草稿箱
发布能力
图文消息留言管理
用户管理
账号管理
数据统计
微信卡券
微信门店
微信小店
智能接口
×微信设备功能异构协议,需独立模块
微信一物一码
微信发票
微信非税缴费
扫服务号二维码打开小程序
微信就医助手
微信长辈就医

2. 小程序

[展开查看]
微信 API平台能力备注
接口调用凭证
OpenAPI 管理
用户信息
小程序登录
小程序码与小程序链接
小程序客服
微信客服
消息相关
用工关系
小程序安全
数据分析
硬件设备
运维中心
插件管理
云开发
物流助手
即时配送
小程序交易管理服务
附近小程序
图像处理与文字识别
微信红包封面
微信服务市场
生物认证
微信人脸核身
微信搜一搜
虚拟支付
×广告异构协议,需独立模块
小程序评价行业能力
小程序直播行业能力
微信学生身份快速验证行业能力
微信物流服务行业能力
B2B 门店助手行业能力
×乘车码行业能力开发中
短剧小程序行业能力
小说小程序行业能力
交易保障商业能力
小程序发货信息管理服务商业能力
卡券商业能力
交易组件商业能力
多端能力多端能力
服务市场服务市场
城市服务城市服务
付费能力付费能力

3. 小游戏

[展开查看]
微信 API备注
虚拟支付
接口调用凭证
登录
游戏内容安全
开放数据
动态消息
小程序码
URL Scheme
URL Link
数据分析
用户信息
云开发
对局匹配
硬件设备
网络
帧同步
安全风控
Short Link
订阅消息

4. 小商店

[展开查看]
微信 API备注
开店接口
服务市场接口
接入商品前必需接口
SPU 接口
SKU 接口
订单接口
物流接口
优惠券接口
店铺接口
直播接口
小程序联盟

5. 视频号

[展开查看]
微信 API备注
视频号小店
视频号助手
联盟带货
本地生活

6. 微信小店

[展开查看]
微信 API备注
微信小店
联盟带货机构
带货助手
供货商

7. 开放平台

[展开查看]
微信 API模块备注
微信登录功能移动应用 & 网站应用
一次性订阅消息移动应用
第三方平台调用凭证第三方平台
授权帐号管理第三方平台
OpenAPI 管理第三方平台
第三方平台管理第三方平台
开放平台帐号管理第三方平台
代商家注册小程序第三方平台
代商家管理小程序第三方平台
小程序流量主代运营第三方平台
代商家管理公众号第三方平台
批量代云开发第三方平台
普通代云开发第三方平台
微信云托管第三方平台
服务平台服务平台
×硬件框架硬件框架异构协议,需独立模块