DotNetCore.SKIT.FlurlHttpCl.../docs/WechatApi/Basic_ModelDefinition.md

198 lines
9.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 如何快速找到需要调用的 API 模型类名 / 方法名?
---
本库提供的请求模型、响应模型和接口方法,三者均保持同名。
例如,发送模板消息的请求是 `CgibinMessageTemplateSendRequest`,响应是 `CgibinMessageTemplateSendResponse`,接口是 `ExecuteCgibinMessageTemplateSendAsync()`。知道其中一个,其余两个就可以快速地推断出了。
再有,每个对象的命名与官方文档的接口地址大体保持一致。例如刚刚提到的发送模板消息,它的接口地址是 `[POST] /cgi-bin/message/template/send`,将其中的反斜杠去掉、并以大驼峰命名法的方式调整它,就可以得到前文提到的几个对象了。
完整的模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.Api/Models_ 目录。
---
### 找不到所需要的接口或字段?
本库会定期随微信官方更新接口或模型,但也会偶有疏漏。如果你在使用中遇到了因接口或模型定义而产生的问题,欢迎提出 Issue。
在 Issue 被处理之前,你也可以选择自行扩展 API。详细方式请参阅本文档[《基础用法 - 如何扩展额外的 API》](./Basic_Extensions.md)。
---
### 微信公众平台 & 微信开放平台 API 支持情况:
#### 1. 公众号
<details>
<summary>[展开查看]</summary>
| | 微信 API | 备注 |
| :-: | :----------------------: | :------------------: |
| √ | 基础功能 | |
| √ | OpenAPI 管理 | |
| √ | 自定义菜单 | |
| √ | 基础消息能力 | |
| √ | 订阅通知 | |
| √ | 客服消息 | |
| √ | 微信网页开发 | |
| √ | 素材管理 | |
| √ | 草稿箱 | |
| √ | 发布能力 | |
| √ | 图文消息留言管理 | |
| √ | 用户管理 | |
| √ | 账号管理 | |
| √ | 数据统计 | |
| √ | 微信卡券 | |
| √ | 微信门店 | |
| √ | 微信小店 | |
| √ | 智能接口 | |
| × | <del>微信设备功能</del> | 异构协议,需独立模块 |
| √ | 微信一物一码 | |
| √ | 微信发票 | |
| √ | 微信非税缴费 | |
| √ | 扫服务号二维码打开小程序 | |
| √ | 微信就医助手 | |
| √ | 微信长辈就医 | |
</details>
#### 2. 小程序
<details>
<summary>[展开查看]</summary>
| | 微信 API | 平台能力 | 备注 |
| :-: | :--------------------: | :------: | :------------------: |
| √ | 基础功能 | | |
| √ | OpenAPI 管理 | | |
| √ | 小程序登录 | | |
| √ | 用户信息 | | |
| √ | 小程序码于与小程序链接 | | |
| √ | 小程序客服 | | |
| √ | 消息相关 | | |
| √ | 小程序安全 | | |
| √ | 数据分析 | | |
| √ | 硬件设备 | | |
| √ | 小程序直播 | 行业能力 | |
| √ | 运维中心 | | |
| √ | 插件管理 | | |
| √ | 云开发 | | |
| √ | 附近小程序 | | |
| √ | 图像处理与文字识别 | | |
| √ | 微信红包封面 | | |
| √ | 即时配送 | 行业能力 | |
| √ | 物流助手 | 行业能力 | |
| √ | 微信服务市场 | | |
| √ | 生物认证 | | |
| × | <del>广告</del> | | 异构协议,需独立模块 |
| √ | 微信客服 | 商业能力 | |
| √ | 购物订单 | 商业能力 | |
| √ | 小程序推广员 | 商业能力 | |
| √ | 交易保障 | 商业能力 | |
| √ | 交易组件 | 商业能力 | |
| √ | 小程序联盟 | 商业能力 | |
| √ | 小程序支付管理服务 | 商业能力 | |
| × | <del>乘车码</del> | 行业能力 | _开发中_ |
| √ | 城市服务 | 城市服务 | |
| √ | 服务市场 | 服务市场 | |
</details>
#### 3. 小游戏
<details>
<summary>[展开查看]</summary>
| | 微信 API | 备注 |
| :-: | :----------: | :--: |
| √ | 基础功能 | |
| √ | OpenAPI 管理 | |
| √ | 登录 | |
| √ | 内容安全 | |
| √ | 开放数据 |
| √ | 动态消息 | |
| √ | 小程序码 | |
| √ | URL Scheme | |
| √ | URL Link | |
| √ | 数据分析 | |
| √ | 用户信息 | |
| √ | 云开发 | |
| √ | 对局匹配 | |
| √ | 硬件设备 | |
| √ | 网络 | |
| √ | 帧同步 | |
| √ | 手机号 | |
| √ | 安全风控 | |
| √ | Short Link | |
| √ | 订阅消息 | |
| √ | 虚拟支付 | |
</details>
#### 4. 小商店
<details>
<summary>[展开查看]</summary>
| | 微信 API | 备注 |
| :-: | :----------------: | :--: |
| √ | 开店接口 | |
| √ | 服务市场接口 | |
| √ | 接入商品前必需接口 | |
| √ | SPU 接口 | |
| √ | SKU 接口 | |
| √ | 订单接口 | |
| √ | 物流接口 | |
| √ | 优惠券接口 | |
| √ | 店铺接口 | |
| √ | 直播接口 | |
| √ | 小程序联盟 | |
</details>
#### 5. 视频号
<details>
<summary>[展开查看]</summary>
| | 微信 API | 备注 |
| :-: | :----------------: | :--: |
| √ | 视频号小店开放接口 | |
| √ | 视频号助手开放接口 | |
| √ | 接口管理 | |
</details>
#### 6. 开放平台
<details>
<summary>[展开查看]</summary>
| | 微信 API | 模块 | 备注 |
| :-: | :-----------------: | :-----------------: | :------------------: |
| √ | 微信登录功能 | 移动应用 & 网站应用 | |
| √ | 一次性订阅消息 | 移动应用 | |
| √ | 第三方平台调用凭证 | 第三方平台 | |
| √ | 授权帐号管理 | 第三方平台 | |
| √ | OpenAPI 管理 | 第三方平台 | |
| √ | 第三方平台管理 | 第三方平台 | |
| √ | 开放平台帐号管理 | 第三方平台 | |
| √ | 代商家注册小程序 | 第三方平台 | |
| √ | 代商家管理小程序 | 第三方平台 | |
| √ | 小程序流量主代运营 | 第三方平台 | |
| √ | 代商家管理公众号 | 第三方平台 | |
| √ | 批量代云开发 | 第三方平台 | |
| √ | 普通代云开发 | 第三方平台 | |
| √ | 微信云托管 | 第三方平台 | |
| √ | 服务平台 | 服务平台 | |
| × | <del>硬件框架</del> | 硬件框架 | 异构协议,需独立模块 |
</details>