diff --git a/.github/agents/my-agent.agent.md b/.github/agents/my-agent.agent.md
new file mode 100644
index 0000000000..0c8481288a
--- /dev/null
+++ b/.github/agents/my-agent.agent.md
@@ -0,0 +1,14 @@
+---
+# Fill in the fields below to create a basic custom agent for your repository.
+# The Copilot CLI can be used for local testing: https://gh.io/customagents/cli
+# To make this agent available, merge this file into the default repository branch.
+# For format details, see: https://gh.io/customagents/config
+
+name: 全部用中文
+description: 需要用中文,包括PR标题和分析总结过程
+---
+
+# My Agent
+
+1、请使用中文输出思考过程和总结,包括PR标题,提交commit信息也要使用中文;
+2、生成代码时需要提供必要的单元测试代码。
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index cec0d76c6b..cad29d96d9 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -1,198 +1,202 @@
-# WxJava - WeChat Java SDK Development Instructions
+# Copilot Instruction
+请始终使用中文生成 Pull Request 的标题、描述和提交信息
-WxJava is a comprehensive WeChat Java SDK supporting multiple WeChat platforms including Official Accounts (公众号), Mini Programs (小程序), WeChat Pay (微信支付), Enterprise WeChat (企业微信), Open Platform (开放平台), and Channel/Video (视频号). This is a Maven multi-module project with Spring Boot and Solon framework integrations.
-**ALWAYS reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the information here.**
+# WxJava - 微信 Java SDK 开发说明
-## Working Effectively
+WxJava 是一个支持多种微信平台的完整 Java SDK,包含公众号、小程序、微信支付、企业微信、开放平台、视频号、企点等多种功能模块。
-### Prerequisites and Environment Setup
-- **Java Requirements**: JDK 8+ required (project uses Java 8 as minimum target)
-- **Maven**: Maven 3.6+ recommended (Maven 3.9.11 validated)
-- **IDE**: IntelliJ IDEA recommended (project optimized for IDEA)
+**请始终优先参考本说明,只有在遇到与此内容不一致的意外信息时,才退而使用搜索或 bash 命令。**
-### Bootstrap, Build, and Validate
-Execute these commands in sequence after cloning:
+## 高效开发指南
+
+### 前置条件与环境准备
+- **Java 要求**:JDK 8+(项目最低目标为 Java 8)
+- **Maven**:推荐 Maven 3.6+(已验证 Maven 3.9.11)
+- **IDE**:推荐使用 IntelliJ IDEA(项目针对 IDEA 优化)
+
+### 引导、构建与校验
+克隆仓库后按顺序执行以下命令:
```bash
-# 1. Basic compilation (NEVER CANCEL - takes 4-5 minutes)
+# 1. 基础编译(请勿中断 - 约需 4-5 分钟)
mvn clean compile -DskipTests=true --no-transfer-progress
-# Timeout: Set 8+ minutes. Actual time: ~4 minutes
+# 超时时间:建议设置 8 分钟以上。实际时间:约 4 分钟
-# 2. Full package build (NEVER CANCEL - takes 2-3 minutes)
+# 2. 完整打包(请勿中断 - 约需 2-3 分钟)
mvn clean package -DskipTests=true --no-transfer-progress
-# Timeout: Set 5+ minutes. Actual time: ~2 minutes
+# 超时时间:建议设置 5 分钟以上。实际时间:约 2 分钟
-# 3. Code quality validation (NEVER CANCEL - takes 45-60 seconds)
+# 3. 代码质量校验(请勿中断 - 约需 45-60 秒)
mvn checkstyle:check --no-transfer-progress
-# Timeout: Set 3+ minutes. Actual time: ~50 seconds
+# 超时时间:建议设置 3 分钟以上。实际时间:约 50 秒
```
-**CRITICAL TIMING NOTES:**
-- **NEVER CANCEL** any Maven build command
-- Compilation phase takes longest (~4 minutes) due to 34 modules
-- Full builds are faster on subsequent runs due to incremental compilation
-- Always use `--no-transfer-progress` to reduce log noise
-
-### Testing Structure
-- **Test Framework**: TestNG (not JUnit)
-- **Test Files**: 298 test files across all modules
-- **Default Behavior**: Tests are DISABLED by default in pom.xml (`
+ * 注意:configKey 是配置文件中定义的 key(如 wx.pay.configs.<configKey>.xxx),
+ * 而不是 appId。如果使用 appId 作为配置 key,则可以直接传入 appId。
+ *
+ * 注意:configKey 是配置文件中定义的 key(如 wx.pay.configs.<configKey>.xxx),
+ * 而不是 appId。如果使用 appId 作为配置 key,则可以直接传入 appId。
+ *
+ * 本示例展示了如何使用 wx-java-pay-multi-spring-boot-starter 来管理多个公众号的支付配置。
+ *
+ * 适用场景:系统需要支持多个公众号,根据用户所在的公众号动态选择支付配置
+ *
+ * 适用场景:服务商为多个子商户提供支付服务
+ *
+ * 适用场景:查询不同公众号的订单支付状态
+ *
+ * 适用场景:为不同公众号的订单申请退款
+ *
+ * 适用场景:需要在运行时更新配置(如证书更新后需要重新加载)
+ *
+ * 参考:{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842}
+ *
+ * 参考:{@code https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11513156443eZYea&version=&lang=zh_CN}
+ *
* 请阅读:
* 公众平台:全局返回码说明
* 企业微信:全局错误码
+ *
+ * 对应操作:{@code uploadTempMedia}
* 对应地址:
- * POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
+ * {@code POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/uploadTempMedia.html
- *
+ * {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setMaxRetryTimes(int)}
+ * {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setMaxRetryTimes(int)}
+ *
+ */
+ private int maxRetryTimes = 5;
+
+ /**
+ * http 请求重试间隔
+ *
+ * {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setRetrySleepMillis(int)}
+ * {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setRetrySleepMillis(int)}
+ *
+ */
+ private int retrySleepMillis = 1000;
+
+ /**
+ * 连接超时时间,单位毫秒
+ */
+ private int connectionTimeout = 5000;
+
+ /**
+ * 读数据超时时间,即socketTimeout,单位毫秒
+ */
+ private int soTimeout = 5000;
+
+ /**
+ * 从连接池获取链接的超时时间,单位毫秒
+ */
+ private int connectionRequestTimeout = 5000;
+ }
+
+ public enum StorageType {
+ /**
+ * 内存
+ */
+ memory,
+ /**
+ * jedis
+ */
+ jedis,
+ /**
+ * redisson
+ */
+ redisson,
+ /**
+ * redisTemplate
+ */
+ redistemplate
+ }
+
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java
new file mode 100644
index 0000000000..ae6d5368d7
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenMultiRedisProperties.java
@@ -0,0 +1,57 @@
+package com.binarywang.spring.starter.wxjava.open.properties;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 微信开放平台多账号Redis配置.
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class WxOpenMultiRedisProperties implements Serializable {
+ private static final long serialVersionUID = -5924815351660074401L;
+
+ /**
+ * 主机地址.
+ */
+ private String host = "127.0.0.1";
+
+ /**
+ * 端口号.
+ */
+ private int port = 6379;
+
+ /**
+ * 密码.
+ */
+ private String password;
+
+ /**
+ * 超时.
+ */
+ private int timeout = 2000;
+
+ /**
+ * 数据库.
+ */
+ private int database = 0;
+
+ /**
+ * sentinel ips
+ */
+ private String sentinelIps;
+
+ /**
+ * sentinel name
+ */
+ private String sentinelName;
+
+ private Integer maxActive;
+ private Integer maxIdle;
+ private Integer maxWaitMillis;
+ private Integer minIdle;
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java
new file mode 100644
index 0000000000..116da323dc
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/properties/WxOpenSingleProperties.java
@@ -0,0 +1,49 @@
+package com.binarywang.spring.starter.wxjava.open.properties;
+
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 微信开放平台单个应用配置.
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class WxOpenSingleProperties implements Serializable {
+ private static final long serialVersionUID = 1980986361098922525L;
+
+ /**
+ * 设置微信开放平台的appid.
+ */
+ private String appId;
+
+ /**
+ * 设置微信开放平台的app secret.
+ */
+ private String secret;
+
+ /**
+ * 设置微信开放平台的token.
+ */
+ private String token;
+
+ /**
+ * 设置微信开放平台的EncodingAESKey.
+ */
+ private String aesKey;
+
+ /**
+ * 自定义API主机地址,用于替换默认的 https://api.weixin.qq.com
+ * 例如:http://proxy.company.com:8080
+ */
+ private String apiHostUrl;
+
+ /**
+ * 自定义获取AccessToken地址,用于向自定义统一服务获取AccessToken
+ * 例如:http://proxy.company.com:8080/oauth/token
+ */
+ private String accessTokenUrl;
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java
new file mode 100644
index 0000000000..9228071a10
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServices.java
@@ -0,0 +1,26 @@
+package com.binarywang.spring.starter.wxjava.open.service;
+
+
+import me.chanjar.weixin.open.api.WxOpenService;
+
+/**
+ * 微信开放平台 {@link WxOpenService} 所有实例存放类.
+ *
+ * @author binarywang
+ */
+public interface WxOpenMultiServices {
+ /**
+ * 通过租户 Id 获取 WxOpenService
+ *
+ * @param tenantId 租户 Id
+ * @return WxOpenService
+ */
+ WxOpenService getWxOpenService(String tenantId);
+
+ /**
+ * 根据租户 Id,从列表中移除一个 WxOpenService 实例
+ *
+ * @param tenantId 租户 Id
+ */
+ void removeWxOpenService(String tenantId);
+}
diff --git a/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java
new file mode 100644
index 0000000000..76fb139e6c
--- /dev/null
+++ b/spring-boot-starters/wx-java-open-multi-spring-boot-starter/src/main/java/com/binarywang/spring/starter/wxjava/open/service/WxOpenMultiServicesImpl.java
@@ -0,0 +1,35 @@
+package com.binarywang.spring.starter.wxjava.open.service;
+
+import me.chanjar.weixin.open.api.WxOpenService;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * 微信开放平台 {@link WxOpenMultiServices} 默认实现
+ *
+ * @author Binary Wang
+ */
+public class WxOpenMultiServicesImpl implements WxOpenMultiServices {
+ private final Map
* 无效媒体文件类型
- * 对应操作:
+ * uploadTempMedia
+ *
* 无效媒体文件 ID.
- * 对应操作:getTempMedia
+ *
+ * 对应操作:{@code getTempMedia}
* 对应地址:
- * GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
+ * {@code GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/getTempMedia.html
- *
+ *
*/
CODE_40007(40007, "无效媒体文件 ID"),
/**
@@ -99,29 +99,29 @@ public enum WxMaErrorMsgEnum {
*/
CODE_41028(41028, "form_id 不正确,或者过期"),
/**
- *
* code 或 template_id 不正确.
- * 对应操作:code2Session, sendUniformMessage, sendTemplateMessage
+ *
+ * 对应操作:{@code code2Session}, {@code sendUniformMessage}, {@code sendTemplateMessage}
* 对应地址:
- * GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
+ * {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/send?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/sendTemplateMessage.html
- *
+ *
*/
CODE_41029(41029, "请求的参数不正确"),
/**
- *
* form_id 已被使用,或者所传page页面不存在,或者小程序没有发布
- * 对应操作:sendUniformMessage, getWXACodeUnlimit
+ *
+ * 对应操作:{@code sendUniformMessage}, {@code getWXACodeUnlimit}
* 对应地址:
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
* POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
- * https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
- *
+ * https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
+ *
*/
CODE_41030(41030, "请求的参数不正确"),
/**
@@ -138,13 +138,13 @@ public enum WxMaErrorMsgEnum {
*/
CODE_45009(45009, "调用分钟频率受限"),
/**
- *
* 频率限制,每个用户每分钟100次.
- * 对应操作:code2Session
+ *
+ * 对应操作:{@code code2Session}
* 对应地址:
- * GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
+ * {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
- *
+ *
*/
CODE_45011(45011, "频率限制,每个用户每分钟100次"),
/**
@@ -190,12 +190,13 @@ public enum WxMaErrorMsgEnum {
*/
CODE_45072(45072, "command字段取值不对"),
/**
- *
* 下发输入状态,需要之前30秒内跟用户有过消息交互.
- * 对应操作:customerTyping
+ *
+ * 对应操作:{@code customerTyping}
* 对应地址:
* POST https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
* 参考文档地址: https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/customerTyping.html
+ *
*/
CODE_45080(45080, "下发输入状态,需要之前30秒内跟用户有过消息交互"),
/**
@@ -686,7 +687,7 @@ public enum WxMaErrorMsgEnum {
/**
* 89252
- * 法人&企业信息一致性校验中 front checking
+ * {@code 法人&企业信息一致性校验中 front checking}
*/
CODE_89252(89252, "法人&企业信息一致性校验中"),
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
index 28fb5de8ad..ba910e988b 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java
@@ -527,7 +527,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40099(40099, "invalid code, this code has consumed."),
/**
- * invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime
+ * {@code invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime}
*/
CODE_40100(40100, "invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime"),
@@ -572,7 +572,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40108(40108, "invalid client version"),
/**
- * too many code size, must <= 100
+ * {@code too many code size, must <= 100}
*/
CODE_40109(40109, "too many code size, must <= 100"),
@@ -702,7 +702,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40135(40135, "invalid not supply bonus, can not change card_id which supply bonus to be not supply"),
/**
- * invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity
+ * {@code invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity}
*/
CODE_40136(40136, "invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity"),
@@ -1082,7 +1082,7 @@ public enum WxOpenErrorMsgEnum {
CODE_40211(40211, "invalid scope_data"),
/**
- * paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 invalid query
+ * {@code paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2 invalid query}
*/
CODE_40212(40212, "paegs 当中存在不合法的query,query格式遵循URL标准,即k1=v1&k2=v2"),
@@ -4242,7 +4242,7 @@ public enum WxOpenErrorMsgEnum {
CODE_71005(71005, "limit exe count"),
/**
- * limit coin count, 1 <= coin_count <= 100000
+ * {@code limit coin count, 1 <= coin_count <= 100000}
*/
CODE_71006(71006, "limit coin count, 1 <= coin_count <= 100000"),
@@ -4347,7 +4347,7 @@ public enum WxOpenErrorMsgEnum {
CODE_72018(72018, "duplicate order id, invoice had inserted to user"),
/**
- * limit msg operation card list size, must <= 5
+ * {@code limit msg operation card list size, must <= 5}
*/
CODE_72019(72019, "limit msg operation card list size, must <= 5"),
@@ -6432,7 +6432,7 @@ public enum WxOpenErrorMsgEnum {
CODE_88009(88009, "reply is not exists"),
/**
- * count range error. cout <= 0 or count > 50
+ * {@code count range error. cout <= 0 or count > 50}
*/
CODE_88010(88010, "count range error. cout <= 0 or count > 50"),
@@ -6682,7 +6682,7 @@ public enum WxOpenErrorMsgEnum {
CODE_89251(89251, "模板消息已下发,待法人人脸核身校验"),
/**
- * 法人&企业信息一致性校验中 front checking
+ * {@code 法人&企业信息一致性校验中 front checking}
*/
CODE_89253(89253, "法人&企业信息一致性校验中"),
@@ -7257,7 +7257,7 @@ public enum WxOpenErrorMsgEnum {
CODE_200021(200021, "场景描述 sceneDesc 参数错误"),
/**
- * 禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间
+ * {@code 禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间}
*/
CODE_300001(300001, "禁止创建/更新商品(如商品创建功能被封禁) 或 禁止编辑&更新房间"),
@@ -8382,7 +8382,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300003(9300003, "begin_time must less than end_time"),
/**
- * end_time - begin_time > 1year
+ * {@code end_time - begin_time > 1year}
*/
CODE_9300004(9300004, "end_time - begin_time > 1year"),
@@ -8397,7 +8397,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300006(9300006, "invalid activity status"),
/**
- * gift_num must >0 and <=15
+ * {@code gift_num must >0 and <=15}
*/
CODE_9300007(9300007, "gift_num must >0 and <=15"),
@@ -8412,7 +8412,7 @@ public enum WxOpenErrorMsgEnum {
CODE_9300009(9300009, "activity can not finish"),
/**
- * card_info_list must >= 2
+ * {@code card_info_list must >= 2}
*/
CODE_9300010(9300010, "card_info_list must >= 2"),
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/redis/RedisTemplateWxRedisOps.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/redis/RedisTemplateWxRedisOps.java
index 19d4046c92..d531a2a307 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/redis/RedisTemplateWxRedisOps.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/redis/RedisTemplateWxRedisOps.java
@@ -29,7 +29,7 @@ public void setValue(String key, String value, int expire, TimeUnit timeUnit) {
@Override
public Long getExpire(String key) {
- return redisTemplate.getExpire(key);
+ return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
@Override
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
index 39a8a93754..d0aeef8491 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java
@@ -12,7 +12,9 @@
/**
* 基于小程序或 H5 的身份证、银行卡、行驶证 OCR 识别.
- * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX
+ *
+ * 参考:{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX}
+ *
*
* @author Binary Wang
* created on 2019-06-22
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
index e3d9ab8351..24ea58ef38 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java
@@ -7,13 +7,12 @@ public interface InternalSessionManager {
/**
* Return the active Session, associated with this Manager, with the
- * specified session id (if any); otherwise return null.
+ * specified session id (if any); otherwise return {@code null}.
*
* @param id The session id for the session to be returned
+ * @return the session or null
* @throws IllegalStateException if a new session cannot be
* instantiated for any reason
- * @throws java.io.IOException if an input/output error occurs while
- * processing this request
*/
InternalSession findSession(String id);
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/RandomUtils.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/RandomUtils.java
index bbb11992bc..a9017c0d16 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/RandomUtils.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/RandomUtils.java
@@ -4,12 +4,24 @@ public class RandomUtils {
private static final String RANDOM_STR = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
- private static final java.util.Random RANDOM = new java.util.Random();
+ private static volatile java.util.Random random;
+
+ private static java.util.Random getRandom() {
+ if (random == null) {
+ synchronized (RandomUtils.class) {
+ if (random == null) {
+ random = new java.util.Random();
+ }
+ }
+ }
+ return random;
+ }
public static String getRandomStr() {
StringBuilder sb = new StringBuilder();
+ java.util.Random r = getRandom();
for (int i = 0; i < 16; i++) {
- sb.append(RANDOM_STR.charAt(RANDOM.nextInt(RANDOM_STR.length())));
+ sb.append(RANDOM_STR.charAt(r.nextInt(RANDOM_STR.length())));
}
return sb.toString();
}
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
index fc3579d45c..1886209f98 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java
@@ -25,6 +25,7 @@ public class SignUtils {
*
* @param message 签名数据
* @param key 签名密钥
+ * @return 签名结果
*/
public static String createHmacSha256Sign(String message, String key) {
try {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
index 9b9f776768..43cc54b43d 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java
@@ -29,7 +29,10 @@ public static String gen(String... arr) {
}
/**
- * 用&串接arr参数,生成sha1 digest.
+ * {@code 用&串接arr参数,生成sha1 digest.}
+ *
+ * @param arr 参数数组
+ * @return sha1摘要
*/
public static String genWithAmple(String... arr) {
if (StringUtils.isAnyEmpty(arr)) {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
index 0a40d0e93c..50362636fc 100755
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/WxCryptUtil.java
@@ -37,6 +37,19 @@ public class WxCryptUtil {
private static final Base64 BASE64 = new Base64();
private static final Charset CHARSET = StandardCharsets.UTF_8;
+ private static volatile Random random;
+
+ private static Random getRandom() {
+ if (random == null) {
+ synchronized (WxCryptUtil.class) {
+ if (random == null) {
+ random = new Random();
+ }
+ }
+ }
+ return random;
+ }
+
private static final ThreadLocal BUILDER_LOCAL = ThreadLocal.withInitial(() -> {
try {
final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
@@ -109,10 +122,10 @@ private static int bytesNetworkOrder2Number(byte[] bytesInNetworkOrder) {
*/
private static String genRandomStr() {
String base = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
- Random random = new Random();
+ Random r = getRandom();
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 16; i++) {
- int number = random.nextInt(base.length());
+ int number = r.nextInt(base.length());
sb.append(base.charAt(number));
}
return sb.toString();
@@ -184,6 +197,7 @@ public EncryptContext encryptContext(String plainText) {
/**
* 对明文进行加密.
*
+ * @param randomStr 随机字符串
* @param plainText 需要加密的明文
* @return 加密后base64编码的字符串
*/
@@ -320,14 +334,28 @@ public String decrypt(String cipherText) {
byte[] bytes = PKCS7Encoder.decode(original);
// 分离16位随机字符串,网络字节序和AppId
+ if (bytes == null || bytes.length < 20) {
+ throw new WxRuntimeException("解密后数据长度异常,可能为错误的密文或EncodingAESKey");
+ }
byte[] networkOrder = Arrays.copyOfRange(bytes, 16, 20);
int xmlLength = bytesNetworkOrder2Number(networkOrder);
- xmlContent = new String(Arrays.copyOfRange(bytes, 20, 20 + xmlLength), CHARSET);
- fromAppid = new String(Arrays.copyOfRange(bytes, 20 + xmlLength, bytes.length), CHARSET);
+ // 长度边界校验,避免非法长度导致的越界/参数异常
+ int startIndex = 20;
+ int endIndex = startIndex + xmlLength;
+ if (xmlLength < 0 || endIndex > bytes.length) {
+ throw new WxRuntimeException("解密后数据格式非法:消息长度不正确,可能为错误的密文或EncodingAESKey");
+ }
+
+ xmlContent = new String(Arrays.copyOfRange(bytes, startIndex, endIndex), CHARSET);
+ fromAppid = new String(Arrays.copyOfRange(bytes, endIndex, bytes.length), CHARSET);
} catch (Exception e) {
- throw new WxRuntimeException(e);
+ if (e instanceof WxRuntimeException) {
+ throw (WxRuntimeException) e;
+ } else {
+ throw new WxRuntimeException(e);
+ }
}
// appid不相同的情况 暂时忽略这段判断
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
index d07873f3c4..f03932984f 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/InputStreamData.java
@@ -10,8 +10,9 @@
/**
* 输入流数据.
- *
+ *
* InputStreamData
+ *
*
* @author zichuan.zhou91@gmail.com
* created on 2022/2/15
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
index de34ca5bd1..5b13e7cc17 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/apache/ApacheHttpClientBuilder.java
@@ -21,42 +21,66 @@ public interface ApacheHttpClientBuilder {
/**
* 代理服务器地址.
+ *
+ * @param httpProxyHost 代理服务器地址
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyHost(String httpProxyHost);
/**
* 代理服务器端口.
+ *
+ * @param httpProxyPort 代理服务器端口
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyPort(int httpProxyPort);
/**
* 代理服务器用户名.
+ *
+ * @param httpProxyUsername 代理服务器用户名
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyUsername(String httpProxyUsername);
/**
* 代理服务器密码.
+ *
+ * @param httpProxyPassword 代理服务器密码
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder httpProxyPassword(String httpProxyPassword);
/**
* 重试策略.
+ *
+ * @param httpRequestRetryHandler 重试处理器
+ * @return ApacheHttpClientBuilder
*/
- ApacheHttpClientBuilder httpRequestRetryHandler(HttpRequestRetryHandler httpRequestRetryHandler );
+ ApacheHttpClientBuilder httpRequestRetryHandler(HttpRequestRetryHandler httpRequestRetryHandler);
/**
* 超时时间.
+ *
+ * @param keepAliveStrategy 保持连接策略
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder keepAliveStrategy(ConnectionKeepAliveStrategy keepAliveStrategy);
/**
* ssl连接socket工厂.
+ *
+ * @param sslConnectionSocketFactory SSL连接Socket工厂
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder sslConnectionSocketFactory(SSLConnectionSocketFactory sslConnectionSocketFactory);
/**
* 支持的TLS协议版本.
* Supported TLS protocol versions.
+ *
+ * @param supportedProtocols 支持的协议版本数组
+ * @return ApacheHttpClientBuilder
*/
ApacheHttpClientBuilder supportedProtocols(String[] supportedProtocols);
}
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/GsonParser.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/GsonParser.java
index f2646436c0..caa07d0eaf 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/GsonParser.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/GsonParser.java
@@ -12,14 +12,14 @@
public class GsonParser {
public static JsonObject parse(String json) {
- return JsonParser.parseString(json).getAsJsonObject();
+ return new JsonParser().parse(json).getAsJsonObject();
}
public static JsonObject parse(Reader json) {
- return JsonParser.parseReader(json).getAsJsonObject();
+ return new JsonParser().parse(json).getAsJsonObject();
}
public static JsonObject parse(JsonReader json) {
- return JsonParser.parseReader(json).getAsJsonObject();
+ return new JsonParser().parse(json).getAsJsonObject();
}
}
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
index ff260c16fb..8f3dafe48a 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/json/WxGsonBuilder.java
@@ -1,5 +1,7 @@
package me.chanjar.weixin.common.util.json;
+import com.google.gson.ExclusionStrategy;
+import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import me.chanjar.weixin.common.bean.WxAccessToken;
@@ -7,6 +9,9 @@
import me.chanjar.weixin.common.bean.menu.WxMenu;
import me.chanjar.weixin.common.error.WxError;
import me.chanjar.weixin.common.bean.result.WxMediaUploadResult;
+import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
+
+import java.io.File;
import java.util.Objects;
/**
@@ -25,8 +30,24 @@ public class WxGsonBuilder {
INSTANCE.registerTypeAdapter(WxMediaUploadResult.class, new WxMediaUploadResultAdapter());
INSTANCE.registerTypeAdapter(WxNetCheckResult.class, new WxNetCheckResultGsonAdapter());
+ INSTANCE.setExclusionStrategies(new ExclusionStrategy() {
+ @Override
+ public boolean shouldSkipField(FieldAttributes fieldAttributes) {
+ return false;
+ }
+
+ @Override
+ public boolean shouldSkipClass(Class> aClass) {
+ return aClass == File.class || aClass == ApacheHttpClientBuilder.class;
+ }
+ });
}
+ /**
+ * 创建Gson实例
+ *
+ * @return Gson实例
+ */
public static Gson create() {
if (Objects.isNull(GSON_INSTANCE)) {
synchronized (INSTANCE) {
diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
index 3fa91fa70e..51cd1e980c 100644
--- a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
+++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/xml/XStreamInitializer.java
@@ -22,6 +22,11 @@ public class XStreamInitializer {
public static ClassLoader classLoader;
+ /**
+ * 设置类加载器
+ *
+ * @param classLoaderInfo 类加载器
+ */
public static void setClassLoader(ClassLoader classLoaderInfo) {
classLoader = classLoaderInfo;
}
diff --git a/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/native-image.properties b/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/native-image.properties
new file mode 100644
index 0000000000..e1e601713f
--- /dev/null
+++ b/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/native-image.properties
@@ -0,0 +1,4 @@
+Args = --initialize-at-run-time=org.apache.http.impl.auth.NTLMEngineImpl \
+ --initialize-at-run-time=org.apache.http.impl.auth.NTLMEngine \
+ --initialize-at-run-time=org.apache.http.impl.auth.KerberosScheme \
+ --initialize-at-run-time=org.apache.http.impl.auth.SPNegoScheme
diff --git a/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/reflect-config.json b/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/reflect-config.json
new file mode 100644
index 0000000000..3bf76c8dab
--- /dev/null
+++ b/weixin-java-common/src/main/resources/META-INF/native-image/com.github.binarywang/weixin-java-common/reflect-config.json
@@ -0,0 +1,14 @@
+[
+ {
+ "name": "me.chanjar.weixin.common.util.RandomUtils",
+ "methods": [
+ {"name": "getRandomStr", "parameterTypes": []}
+ ]
+ },
+ {
+ "name": "me.chanjar.weixin.common.util.crypto.WxCryptUtil",
+ "allDeclaredConstructors": true,
+ "allDeclaredMethods": true,
+ "allDeclaredFields": true
+ }
+]
diff --git a/weixin-java-common/src/test/java/me/chanjar/weixin/common/redis/CommonWxRedisOpsTest.java b/weixin-java-common/src/test/java/me/chanjar/weixin/common/redis/CommonWxRedisOpsTest.java
index 96ba20ba2b..fb53c8c4b6 100644
--- a/weixin-java-common/src/test/java/me/chanjar/weixin/common/redis/CommonWxRedisOpsTest.java
+++ b/weixin-java-common/src/test/java/me/chanjar/weixin/common/redis/CommonWxRedisOpsTest.java
@@ -35,6 +35,17 @@ public void testGetExpire() {
Assert.assertTrue(expireSeconds <= 4 && expireSeconds >= 0);
}
+ @Test
+ public void testGetExpireForNonExistentKey() {
+ String nonExistentKey = "non_existent_key_" + System.currentTimeMillis();
+ Long expire = wxRedisOps.getExpire(nonExistentKey);
+ // 对于不存在的 key,底层使用 getExpire(key, TimeUnit.SECONDS) 时应返回负值
+ // Spring Data Redis 2.x 和 3.x 约定:-2 表示 key 不存在,-1 表示 key 没有过期时间
+ // 因此这里不应返回 null,而应返回一个小于 0 的值
+ Assert.assertNotNull(expire, "Non-existent key should not have null expiration");
+ Assert.assertTrue(expire < 0, "Non-existent key should have negative expiration");
+ }
+
@Test
public void testExpire() {
String key = "access_token", value = String.valueOf(System.currentTimeMillis());
diff --git a/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/json/GsonParserTest.java b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/json/GsonParserTest.java
new file mode 100644
index 0000000000..ea069d4155
--- /dev/null
+++ b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/json/GsonParserTest.java
@@ -0,0 +1,47 @@
+package me.chanjar.weixin.common.util.json;
+
+import com.google.gson.JsonObject;
+import com.google.gson.stream.JsonReader;
+import org.testng.annotations.Test;
+
+import java.io.StringReader;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
+
+/**
+ * GsonParser 测试类
+ *
+ * @author Binary Wang
+ */
+public class GsonParserTest {
+
+ @Test
+ public void testParseString() {
+ String json = "{\"code\":\"ALREADY_EXISTS\",\"message\":\"当前订单已关闭,可查询订单了解关闭原因\"}";
+ JsonObject jsonObject = GsonParser.parse(json);
+ assertNotNull(jsonObject);
+ assertEquals(jsonObject.get("code").getAsString(), "ALREADY_EXISTS");
+ assertEquals(jsonObject.get("message").getAsString(), "当前订单已关闭,可查询订单了解关闭原因");
+ }
+
+ @Test
+ public void testParseReader() {
+ String json = "{\"code\":\"SUCCESS\",\"message\":\"处理成功\"}";
+ StringReader reader = new StringReader(json);
+ JsonObject jsonObject = GsonParser.parse(reader);
+ assertNotNull(jsonObject);
+ assertEquals(jsonObject.get("code").getAsString(), "SUCCESS");
+ assertEquals(jsonObject.get("message").getAsString(), "处理成功");
+ }
+
+ @Test
+ public void testParseJsonReader() {
+ String json = "{\"errcode\":0,\"errmsg\":\"ok\"}";
+ JsonReader jsonReader = new JsonReader(new StringReader(json));
+ JsonObject jsonObject = GsonParser.parse(jsonReader);
+ assertNotNull(jsonObject);
+ assertEquals(jsonObject.get("errcode").getAsInt(), 0);
+ assertEquals(jsonObject.get("errmsg").getAsString(), "ok");
+ }
+}
diff --git a/weixin-java-cp/APPROVAL_WORKFLOW_GUIDE.md b/weixin-java-cp/APPROVAL_WORKFLOW_GUIDE.md
new file mode 100644
index 0000000000..d2c533b5e5
--- /dev/null
+++ b/weixin-java-cp/APPROVAL_WORKFLOW_GUIDE.md
@@ -0,0 +1,141 @@
+# WeChat Enterprise Workflow Approval Guide
+# 企业微信流程审批功能使用指南
+
+## Overview / 概述
+
+WxJava SDK provides comprehensive support for WeChat Enterprise workflow approval (企业微信流程审批), including both traditional OA approval and the approval process engine.
+
+WxJava SDK 提供全面的企业微信流程审批支持,包括传统OA审批和审批流程引擎。
+
+## Current Implementation Status / 当前实现状态
+
+### ✅ Fully Implemented APIs / 已完整实现的API
+
+1. **Submit Approval Application / 提交审批申请**
+ - Endpoint: `/cgi-bin/oa/applyevent`
+ - Documentation: [91853](https://work.weixin.qq.com/api/doc/90000/90135/91853)
+ - Implementation: `WxCpOaService.apply(WxCpOaApplyEventRequest)`
+
+2. **Get Approval Details / 获取审批申请详情**
+ - Endpoint: `/cgi-bin/oa/getapprovaldetail`
+ - Implementation: `WxCpOaService.getApprovalDetail(String spNo)`
+
+3. **Batch Get Approval Numbers / 批量获取审批单号**
+ - Endpoint: `/cgi-bin/oa/getapprovalinfo`
+ - Implementation: `WxCpOaService.getApprovalInfo(...)`
+
+4. **Approval Process Engine / 审批流程引擎**
+ - Endpoint: `/cgi-bin/corp/getopenapprovaldata`
+ - Implementation: `WxCpOaAgentService.getOpenApprovalData(String thirdNo)`
+
+5. **Template Management / 模板管理**
+ - Create: `WxCpOaService.createOaApprovalTemplate(...)`
+ - Update: `WxCpOaService.updateOaApprovalTemplate(...)`
+ - Get Details: `WxCpOaService.getTemplateDetail(...)`
+
+## Usage Examples / 使用示例
+
+### 1. Submit Approval Application / 提交审批申请
+
+```java
+// Create approval request
+WxCpOaApplyEventRequest request = new WxCpOaApplyEventRequest()
+ .setCreatorUserId("userId")
+ .setTemplateId("templateId")
+ .setUseTemplateApprover(0)
+ .setApprovers(Arrays.asList(
+ new WxCpOaApplyEventRequest.Approver()
+ .setAttr(2)
+ .setUserIds(new String[]{"approver1", "approver2"})
+ ))
+ .setNotifiers(new String[]{"notifier1", "notifier2"})
+ .setNotifyType(1)
+ .setApplyData(new WxCpOaApplyEventRequest.ApplyData()
+ .setContents(Arrays.asList(
+ new ApplyDataContent()
+ .setControl("Text")
+ .setId("Text-1234567890")
+ .setValue(new ContentValue().setText("Approval content"))
+ ))
+ );
+
+// Submit approval
+String spNo = wxCpService.getOaService().apply(request);
+```
+
+### 2. Get Approval Details / 获取审批详情
+
+```java
+// Get approval details by approval number
+WxCpApprovalDetailResult result = wxCpService.getOaService()
+ .getApprovalDetail("approval_number");
+
+WxCpApprovalDetailResult.WxCpApprovalDetail detail = result.getInfo();
+System.out.println("Approval Status: " + detail.getSpStatus());
+System.out.println("Approval Name: " + detail.getSpName());
+```
+
+### 3. Batch Get Approval Information / 批量获取审批信息
+
+```java
+// Get approval info with filters
+Date startTime = new Date(System.currentTimeMillis() - 7 * 24 * 60 * 60 * 1000);
+Date endTime = new Date();
+
+WxCpApprovalInfo approvalInfo = wxCpService.getOaService()
+ .getApprovalInfo(startTime, endTime, "0", 100, null);
+
+List spNumbers = approvalInfo.getSpNoList();
+```
+
+### 4. Third-Party Application Support / 第三方应用支持
+
+```java
+// For third-party applications
+WxCpTpOAService tpOaService = wxCpTpService.getOaService();
+
+// Submit approval for specific corp
+String spNo = tpOaService.apply(request, "corpId");
+
+// Get approval details for specific corp
+WxCpApprovalDetailResult detail = tpOaService.getApprovalDetail("spNo", "corpId");
+```
+
+## Multi-Account Configuration / 多账号配置支持
+
+WxJava supports multi-account configurations for enterprise scenarios:
+
+```java
+// Spring Boot configuration example
+@Autowired
+private WxCpMultiServices wxCpMultiServices;
+
+// Get service for specific corp
+WxCpService wxCpService = wxCpMultiServices.getWxCpService("corpId");
+WxCpOaService oaService = wxCpService.getOaService();
+```
+
+## Available Data Models / 可用数据模型
+
+- `WxCpOaApplyEventRequest` - Approval application request
+- `WxCpApprovalDetailResult` - Approval details response
+- `WxCpApprovalInfo` - Batch approval information
+- `WxCpXmlApprovalInfo` - XML approval message handling
+- `WxCpOaApprovalTemplate` - Approval template management
+
+## Documentation References / 文档参考
+
+- [Submit Approval Application (91853)](https://work.weixin.qq.com/api/doc/90000/90135/91853)
+- [Get Approval Details (91983)](https://work.weixin.qq.com/api/doc/90000/90135/91983)
+- [Batch Get Approval Numbers (91816)](https://work.weixin.qq.com/api/doc/90000/90135/91816)
+- [Approval Process Engine (90269)](https://developer.work.weixin.qq.com/document/path/90269)
+
+## Conclusion / 结论
+
+WxJava already provides comprehensive support for WeChat Enterprise workflow approval. The "new version" (新版) approval functionality referenced in issue requests is **already fully implemented** and available for use.
+
+WxJava 已经提供了企业微信流程审批的全面支持。问题中提到的"新版"流程审批功能**已经完全实现**并可使用。
+
+For questions about specific usage, please refer to the test cases in `WxCpOaServiceImplTest` and the comprehensive API documentation.
+
+有关具体使用问题,请参考 `WxCpOaServiceImplTest` 中的测试用例和全面的API文档。
\ No newline at end of file
diff --git a/weixin-java-cp/INTELLIGENT_ROBOT.md b/weixin-java-cp/INTELLIGENT_ROBOT.md
new file mode 100644
index 0000000000..dcd90e1a1a
--- /dev/null
+++ b/weixin-java-cp/INTELLIGENT_ROBOT.md
@@ -0,0 +1,149 @@
+# 企业微信智能机器人接口
+
+本模块提供企业微信智能机器人相关的API接口实现。
+
+## 官方文档
+
+- [企业微信智能机器人接口](https://developer.work.weixin.qq.com/document/path/101039)
+
+## 接口说明
+
+### 获取服务实例
+
+```java
+WxCpService wxCpService = ...; // 初始化企业微信服务
+WxCpIntelligentRobotService robotService = wxCpService.getIntelligentRobotService();
+```
+
+### 创建智能机器人
+
+```java
+WxCpIntelligentRobotCreateRequest request = new WxCpIntelligentRobotCreateRequest();
+request.setName("我的智能机器人");
+request.setDescription("这是一个智能客服机器人");
+request.setAvatar("http://example.com/avatar.jpg");
+
+WxCpIntelligentRobotCreateResponse response = robotService.createRobot(request);
+String robotId = response.getRobotId();
+```
+
+### 更新智能机器人
+
+```java
+WxCpIntelligentRobotUpdateRequest request = new WxCpIntelligentRobotUpdateRequest();
+request.setRobotId("robot_id_here");
+request.setName("更新后的机器人名称");
+request.setDescription("更新后的描述");
+request.setStatus(1); // 1:启用, 0:停用
+
+robotService.updateRobot(request);
+```
+
+### 查询智能机器人
+
+```java
+String robotId = "robot_id_here";
+WxCpIntelligentRobot robot = robotService.getRobot(robotId);
+
+System.out.println("机器人名称: " + robot.getName());
+System.out.println("机器人状态: " + robot.getStatus());
+```
+
+### 智能对话
+
+```java
+WxCpIntelligentRobotChatRequest request = new WxCpIntelligentRobotChatRequest();
+request.setRobotId("robot_id_here");
+request.setUserid("user123");
+request.setMessage("你好,请问如何使用这个功能?");
+request.setSessionId("session123"); // 可选,用于保持会话连续性
+
+WxCpIntelligentRobotChatResponse response = robotService.chat(request);
+String reply = response.getReply();
+String sessionId = response.getSessionId();
+```
+
+### 重置会话
+
+```java
+String robotId = "robot_id_here";
+String userid = "user123";
+String sessionId = "session123";
+
+robotService.resetSession(robotId, userid, sessionId);
+```
+
+### 主动发送消息
+
+智能机器人可以主动向用户发送消息,用于推送通知或提醒。
+
+```java
+WxCpIntelligentRobotSendMessageRequest request = new WxCpIntelligentRobotSendMessageRequest();
+request.setRobotId("robot_id_here");
+request.setUserid("user123");
+request.setMessage("您好,这是来自智能机器人的主动消息");
+request.setSessionId("session123"); // 可选,用于保持会话连续性
+
+WxCpIntelligentRobotSendMessageResponse response = robotService.sendMessage(request);
+String msgId = response.getMsgId();
+String sessionId = response.getSessionId();
+```
+
+### 接收用户消息
+
+当用户向智能机器人发送消息时,企业微信会通过回调接口推送消息。可以使用 `WxCpXmlMessage` 接收和解析这些消息:
+
+```java
+// 在接收回调消息的接口中
+WxCpXmlMessage message = WxCpXmlMessage.fromEncryptedXml(
+ requestBody, wxCpConfigStorage, timestamp, nonce, msgSignature
+);
+
+// 获取智能机器人相关字段
+String robotId = message.getRobotId(); // 机器人ID
+String sessionId = message.getSessionId(); // 会话ID
+String content = message.getContent(); // 消息内容
+String fromUser = message.getFromUserName(); // 发送用户
+
+// 处理消息并回复
+// ...
+```
+
+### 删除智能机器人
+
+```java
+String robotId = "robot_id_here";
+robotService.deleteRobot(robotId);
+```
+
+## 主要类说明
+
+### 请求类
+
+- `WxCpIntelligentRobotCreateRequest`: 创建机器人请求
+- `WxCpIntelligentRobotUpdateRequest`: 更新机器人请求
+- `WxCpIntelligentRobotChatRequest`: 智能对话请求
+- `WxCpIntelligentRobotSendMessageRequest`: 主动发送消息请求
+
+### 响应类
+
+- `WxCpIntelligentRobotCreateResponse`: 创建机器人响应
+- `WxCpIntelligentRobotChatResponse`: 智能对话响应
+- `WxCpIntelligentRobotSendMessageResponse`: 主动发送消息响应
+- `WxCpIntelligentRobot`: 机器人信息实体
+
+### 消息接收
+
+- `WxCpXmlMessage`: 支持接收智能机器人回调消息,包含 `robotId` 和 `sessionId` 字段
+
+### 服务接口
+
+- `WxCpIntelligentRobotService`: 智能机器人服务接口
+- `WxCpIntelligentRobotServiceImpl`: 智能机器人服务实现
+
+## 注意事项
+
+1. 需要确保企业微信应用具有智能机器人相关权限
+2. 智能机器人功能可能需要特定的企业微信版本支持
+3. 会话ID可以用于保持对话的连续性,提升用户体验
+4. 机器人状态: 0表示停用,1表示启用
\ No newline at end of file
diff --git a/weixin-java-cp/pom.xml b/weixin-java-cp/pom.xml
index 6ee31e759b..9294b62d20 100644
--- a/weixin-java-cp/pom.xml
+++ b/weixin-java-cp/pom.xml
@@ -7,7 +7,7 @@
com.github.binarywang
wx-java
- 4.7.8.B
+ 4.8.0
weixin-java-cp
@@ -30,6 +30,11 @@
okhttp
provided
+
+ org.apache.httpcomponents
+ httpclient
+ provided
+
org.apache.httpcomponents.client5
httpclient5
@@ -52,6 +57,7 @@
org.springframework.data
spring-data-redis
+
org.testng
testng
@@ -59,9 +65,10 @@
org.mockito
- mockito-all
+ mockito-core
test
+
com.google.inject
guice
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
index 9eddc0f507..05f06f1da9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpAgentService.java
@@ -2,6 +2,7 @@
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.cp.bean.WxCpAgent;
+import me.chanjar.weixin.cp.bean.WxCpTpAdmin;
import java.util.List;
@@ -52,4 +53,18 @@ public interface WxCpAgentService {
*/
List list() throws WxErrorException;
+ /**
+ *
+ * 获取应用管理员列表
+ * 第三方服务商可以用此接口获取授权企业中某个第三方应用或者代开发应用的管理员列表(不包括外部管理员),
+ * 以便服务商在用户进入应用主页之后根据是否管理员身份做权限的区分。
+ * 详情请见: 文档
+ *
+ *
+ * @param agentId 应用id
+ * @return admin list
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpTpAdmin getAdminList(Integer agentId) throws WxErrorException;
+
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
index 4da13d3fde..69aea4bca7 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpCorpGroupService.java
@@ -9,7 +9,7 @@
* 企业互联相关接口
*
* @author libo <422423229@qq.com>
- * Created on 27/2/2023 9:57 PM
+ * @since 2023-02-27 9:57 PM
*/
public interface WxCpCorpGroupService {
/**
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
index 24c6ea9dc1..a2c7adabea 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExportService.java
@@ -85,7 +85,7 @@ public interface WxCpExportService {
* 获取导出结果
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx}
*
* 文档地址:https://developer.work.weixin.qq.com/document/path/94854
* 返回的url文件下载解密可参考 CSDN
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
index 7f3cdeab7c..6de9f9226d 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpExternalContactService.java
@@ -146,7 +146,7 @@ public interface WxCpExternalContactService {
* 企业可通过此接口,根据外部联系人的userid(如何获取?),拉取客户详情。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* 权限说明:
*
@@ -252,9 +252,9 @@ public interface WxCpExternalContactService {
*
* 权限说明:
*
- * 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限
+ * {@code 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限}
* 该客户的跟进人必须在应用的可见范围之内
- * 应用需具备“企业客户权限->客户基础信息”权限
+ * {@code 应用需具备“企业客户权限->客户基础信息”权限}
*
*
* @param externalUserid 代开发自建应用获取到的外部联系人ID
@@ -276,8 +276,8 @@ public interface WxCpExternalContactService {
*
* @param externalUserid 服务商主体的external_userid,必须是source_agentid对应的应用所获取
* @param sourceAgentId 企业授权的代开发自建应用或第三方应用的agentid
- * @return
- * @throws WxErrorException
+ * @return 企业的external_userid
+ * @throws WxErrorException 微信错误异常
*/
String fromServiceExternalUserid(String externalUserid, String sourceAgentId) throws WxErrorException;
@@ -362,7 +362,7 @@ public interface WxCpExternalContactService {
* 权限说明:
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)
- * 第三方应用需具有“企业客户权限->客户基础信息”权限
+ * {@code 第三方应用需具有“企业客户权限->客户基础信息”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围
* 仅支持企业服务人员创建的客户群
* 仅可转换出自己企业下的客户群chat_id
@@ -410,11 +410,12 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
* 文档地址: https://developer.work.weixin.qq.com/document/path/99434
*
*
+ * 注意:企业可通过外部联系人临时ID排除重复数据,外部联系人临时ID有效期为4小时。
+ *
* @param cursor the cursor
* @param limit the limit
* @return 已服务的外部联系人列表
* @throws WxErrorException .
- * @apiNote 企业可通过外部联系人临时ID排除重复数据,外部联系人临时ID有效期为4小时。
*/
WxCpExternalContactListInfo getContactList(String cursor, Integer limit) throws WxErrorException;
@@ -438,7 +439,7 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
* 企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员,所添加的外部联系人将不会作为客户返回。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID}
*
* 权限说明:
*
@@ -469,7 +470,8 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
/**
* 获取待分配的离职成员列表
* 企业和第三方可通过此接口,获取所有离职成员的客户列表,并可进一步调用分配离职成员的客户接口将这些客户重新分配给其他企业成员。
- *
+
+ *
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_unassigned_list?access_token=ACCESS_TOKEN
*
@@ -496,17 +498,17 @@ WxCpExternalContactBatchInfo getContactDetailBatch(String[] userIdList, String c
/**
* 企业可通过此接口,转接在职成员的客户给其他成员。
- *
+ *
* 权限说明:
- * * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
- *
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
- *
+
+ *
* 权限说明:
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
- *
+
+ *
* 群主离职了的客户群,才可继承
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
* 继承给的新群主,必须有激活企业微信
* 同一个人的群,限制每天最多分配300个给新群主
- *
+
+ *
* 权限说明:
- *
+
+ *
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
- * 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限
+ * {@code 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围。
- *
+
+ *
* 请求方式: POST(HTTP)
- *
+
+ *
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_msg_template?access_token=ACCESS_TOKEN
- *
+
+ *
* 文档地址
*
* @param wxCpMsgTemplate the wx cp msg template
@@ -733,15 +744,18 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
/**
* 提醒成员群发
* 企业和第三方应用可调用此接口,重新触发群发通知,提醒成员完成群发任务,24小时内每个群发最多触发三次提醒。
- *
+
+ *
* 请求方式: POST(HTTPS)
- *
+
+ *
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remind_groupmsg_send?access_token=ACCESS_TOKEN
- *
+ *
* 文档地址
*
* @param msgId 群发消息的id,通过获取群发记录列表接口返回
* @return the wx cp msg template add result
+ * @throws WxErrorException 微信错误异常
*/
WxCpBaseResp remindGroupMsgSend(String msgId) throws WxErrorException;
@@ -753,11 +767,12 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
* 请求方式: POST(HTTPS)
*
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/cancel_groupmsg_send?access_token=ACCESS_TOKEN
- *
+ *
* 文档地址
*
* @param msgId 群发消息的id,通过获取群发记录列表接口返回
* @return the wx cp msg template add result
+ * @throws WxErrorException 微信错误异常
*/
WxCpBaseResp cancelGroupMsgSend(String msgId) throws WxErrorException;
@@ -1002,7 +1017,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
+ * 注意:
+ * 根据上面返回的文件类型,拼接好存放文件的绝对路径即可。此时绝对路径写入文件流,来达到获取媒体文件的目的。
+ * 详情可以看官方文档,亦可阅读此接口源码。
+ *
+ * @param sdkfileid 消息体内容中的sdkfileid信息
+ * @param proxy 使用代理的请求,需要传入代理的链接。如:socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081,如果没有传null
+ * @param passwd 代理账号密码,需要传入代理的账号密码。如 user_name:passwd_123,如果没有传null
+ * @param timeout 超时时间,分片数据需累加到文件存储。单次最大返回512K字节,如果文件比较大,自行设置长一点,比如timeout=10000
+ * @param targetFilePath 目标文件绝对路径+实际文件名,比如:/usr/local/file/20220114/474f866b39d10718810d55262af82662.gif
+ * @throws WxErrorException the wx error exception
+ */
+ void downloadMediaFile(@NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout,
+ @NonNull String targetFilePath) throws WxErrorException;
+
/**
* 获取媒体文件 传入一个lambda,each所有的数据分片byte[],更加灵活
* 针对图片、文件等媒体数据,提供sdk接口拉取数据内容。
@@ -85,10 +152,29 @@ void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, St
* @param timeout 超时时间,分片数据需累加到文件存储。单次最大返回512K字节,如果文件比较大,自行设置长一点,比如timeout=10000
* @param action 传入一个lambda,each所有的数据分片
* @throws WxErrorException the wx error exception
+ * @deprecated 请使用 {@link #downloadMediaFile(String, String, String, long, Consumer)} 代替,
+ * 该方法需要传入SDK,容易导致SDK生命周期管理混乱,引发JVM崩溃
*/
+ @Deprecated
void getMediaFile(@NonNull long sdk, @NonNull String sdkfileid, String proxy, String passwd, @NonNull long timeout,
@NonNull Consumer
+ *
+ *
+ * 注意:
+ * 1.批量更新请求中的各个操作会逐个按顺序执行,直到全部执行完成则请求返回,或者其中一个操作报错则不再继续执行后续的操作
+ * 2.每一个更新操作在执行之前都会做请求校验(包括权限校验、参数校验等等),如果校验未通过则该更新操作会报错并返回,不再执行后续操作
+ * 3.单次批量更新请求的操作数量 <= 5
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/batch_update?access_token=ACCESS_TOKEN
+ *
+ * @param request 编辑表格内容请求参数
+ * @return 编辑表格内容批量更新的响应结果
+ * @throws WxErrorException the wx error exception
+ */
+ WxCpDocSheetBatchUpdateResponse docBatchUpdate(@NonNull WxCpDocSheetBatchUpdateRequest request) throws WxErrorException;
+
+ /**
+ * 获取表格行列信息
+ * 该接口用于获取在线表格的工作表、行数、列数等。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_properties?access_token=ACCESS_TOKEN
+ *
+ * @param docId 在线表格的docid
+ * @return 返回表格行列信息
+ * @throws WxErrorException
+ */
+ WxCpDocSheetProperties getSheetProperties(@NonNull String docId) throws WxErrorException;
+
+
+ /**
+ * 本接口用于获取指定范围内的在线表格信息,单次查询的范围大小需满足以下限制:
+ *
+ * 查询范围行数 <=1000
+ * 查询范围列数 <=200
+ * 范围内的总单元格数量 <=10000
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址: https://qyapi.weixin.qq.com/cgi-bin/wedoc/spreadsheet/get_sheet_range_data?access_token=ACCESS_TOKEN
+ *
+ * @param request 获取指定范围内的在线表格信息请求参数
+ * @return 返回指定范围内的在线表格信息
+ * @throws WxErrorException
+ */
+ WxCpDocSheetData getSheetRangeData(@NonNull WxCpDocSheetGetDataRequest request) throws WxErrorException;
+
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
index 56687c9cb1..5f1d41c197 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolService.java
@@ -80,9 +80,10 @@ public interface WxCpSchoolService {
/**
* 获取直播详情
+ *
+ *
+ *
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid
- * =EXTERNAL_USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* @param externalUserId 外部联系人的userid,注意不是学校成员的帐号
* @return external contact
@@ -306,9 +315,9 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取可使用的家长范围
* 获取可在微信「学校通知-学校应用」使用该应用的家长范围,以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。
- *
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID}
*
* @param agentId the agent id
* @return allow scope
@@ -332,7 +341,7 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门列表
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID}
*
* @param id 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构
* @return wx cp department list
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
index 9bcb161534..76012a2812 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpService.java
@@ -584,7 +584,14 @@ public interface WxCpService extends WxService {
/**
* 企业互联的服务类对象
*
- * @return
+ * @return 企业互联服务对象
*/
WxCpCorpGroupService getCorpGroupService();
+
+ /**
+ * 获取智能机器人服务
+ *
+ * @return 智能机器人服务 intelligent robot service
+ */
+ WxCpIntelligentRobotService getIntelligentRobotService();
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
index 2368386b23..7a7b5f40a8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpUserService.java
@@ -38,7 +38,7 @@ public interface WxCpUserService {
*
- * Created by songfan on 2020/7/14.
*
- * @author songfan & Mr.Pan
+ * @author songfan, Mr.Pan
+ * @since 2020/7/14
*/
@Data
@Builder
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
index 8605760fa7..f3fdd96ce7 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/WxCpUserExternalUnassignList.java
@@ -12,7 +12,8 @@
/**
* 离职员工外部联系人列表
*
- * @author yqx & Wang_Wong created on 2020/3/15
+ * @author yqx, Wang_Wong
+ * @since 2020/3/15
*/
@Getter
@Setter
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
index bb02b039bd..87e3d5580a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/acquisition/WxCpCustomerAcquisitionStatistic.java
@@ -10,7 +10,7 @@
* 获客链接的使用详情
*
* @author Hugo
- * @date 2023/12/11 10:31
+ * @since 2023/12/11 10:31
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
index 20d6b32442..23bb70a240 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleInfo.java
@@ -10,9 +10,10 @@
import java.util.List;
/**
- * @Date: 2024-03-07 17:02
- * @Author: shenliuming
- * @return:
+ * 防骚扰规则详情
+ *
+ * @author shenliuming
+ * @since 2024-03-07 17:02
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
index 6826413e13..543d32fcb9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/interceptrule/WxCpInterceptRuleList.java
@@ -9,9 +9,10 @@
import java.util.List;
/**
- * @Date: 2024-03-07 15:54
- * @Author: shenliuming
- * @return:
+ * 防骚扰规则列表
+ *
+ * @author shenliuming
+ * @since 2024-03-07 15:54
*/
@Data
@EqualsAndHashCode(callSuper = true)
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
index be9dcc9dd0..1fff457f97 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
@@ -33,6 +33,7 @@ public class Attachment implements Serializable {
* Sets image.
*
* @param image the image
+ * @return this
*/
public Attachment setImage(Image image) {
this.image = image;
@@ -44,6 +45,7 @@ public Attachment setImage(Image image) {
* Sets link.
*
* @param link the link
+ * @return this
*/
public Attachment setLink(Link link) {
this.link = link;
@@ -55,6 +57,7 @@ public Attachment setLink(Link link) {
* Sets mini program.
*
* @param miniProgram the mini program
+ * @return this
*/
public Attachment setMiniProgram(MiniProgram miniProgram) {
this.miniProgram = miniProgram;
@@ -66,6 +69,7 @@ public Attachment setMiniProgram(MiniProgram miniProgram) {
* Sets video.
*
* @param video the video
+ * @return this
*/
public Attachment setVideo(Video video) {
this.video = video;
@@ -77,6 +81,7 @@ public Attachment setVideo(Video video) {
* Sets file.
*
* @param file the file
+ * @return this
*/
public Attachment setFile(File file) {
this.file = file;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobot.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobot.java
new file mode 100644
index 0000000000..60d518cac3
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobot.java
@@ -0,0 +1,77 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 智能机器人信息
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxCpIntelligentRobot extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人ID
+ */
+ @SerializedName("robot_id")
+ private String robotId;
+
+ /**
+ * 机器人名称
+ */
+ @SerializedName("name")
+ private String name;
+
+ /**
+ * 机器人描述
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ * 机器人头像
+ */
+ @SerializedName("avatar")
+ private String avatar;
+
+ /**
+ * 机器人状态 0:停用 1:启用
+ */
+ @SerializedName("status")
+ private Integer status;
+
+ /**
+ * 创建时间
+ */
+ @SerializedName("create_time")
+ private Long createTime;
+
+ /**
+ * 更新时间
+ */
+ @SerializedName("update_time")
+ private Long updateTime;
+
+ /**
+ * From json wx cp intelligent robot.
+ *
+ * @param json the json
+ * @return the wx cp intelligent robot
+ */
+ public static WxCpIntelligentRobot fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobot.class);
+ }
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatRequest.java
new file mode 100644
index 0000000000..d94ea93623
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatRequest.java
@@ -0,0 +1,49 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 智能机器人聊天请求
+ *
+ * @author Binary Wang
+ */
+@Data
+public class WxCpIntelligentRobotChatRequest implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人ID
+ */
+ @SerializedName("robot_id")
+ private String robotId;
+
+ /**
+ * 用户ID
+ */
+ @SerializedName("userid")
+ private String userid;
+
+ /**
+ * 消息内容
+ */
+ @SerializedName("message")
+ private String message;
+
+ /**
+ * 会话ID,可选,用于保持会话连续性
+ */
+ @SerializedName("session_id")
+ private String sessionId;
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ public static WxCpIntelligentRobotChatRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotChatRequest.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatResponse.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatResponse.java
new file mode 100644
index 0000000000..c7e56a4d03
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotChatResponse.java
@@ -0,0 +1,46 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 智能机器人聊天响应
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxCpIntelligentRobotChatResponse extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人回复内容
+ */
+ @SerializedName("reply")
+ private String reply;
+
+ /**
+ * 会话ID
+ */
+ @SerializedName("session_id")
+ private String sessionId;
+
+ /**
+ * 消息ID
+ */
+ @SerializedName("msg_id")
+ private String msgId;
+
+ public static WxCpIntelligentRobotChatResponse fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotChatResponse.class);
+ }
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateRequest.java
new file mode 100644
index 0000000000..46dd5f609b
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateRequest.java
@@ -0,0 +1,43 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 创建智能机器人请求
+ *
+ * @author Binary Wang
+ */
+@Data
+public class WxCpIntelligentRobotCreateRequest implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人名称
+ */
+ @SerializedName("name")
+ private String name;
+
+ /**
+ * 机器人描述
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ * 机器人头像
+ */
+ @SerializedName("avatar")
+ private String avatar;
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ public static WxCpIntelligentRobotCreateRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotCreateRequest.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateResponse.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateResponse.java
new file mode 100644
index 0000000000..449d91f7d3
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotCreateResponse.java
@@ -0,0 +1,34 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 创建智能机器人响应
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxCpIntelligentRobotCreateResponse extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人ID
+ */
+ @SerializedName("robot_id")
+ private String robotId;
+
+ public static WxCpIntelligentRobotCreateResponse fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotCreateResponse.class);
+ }
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageRequest.java
new file mode 100644
index 0000000000..405c67daff
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageRequest.java
@@ -0,0 +1,56 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 智能机器人发送消息请求
+ * 官方文档: https://developer.work.weixin.qq.com/document/path/100719
+ *
+ * @author Binary Wang
+ */
+@Data
+public class WxCpIntelligentRobotSendMessageRequest implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人ID,必填
+ */
+ @SerializedName("robot_id")
+ private String robotId;
+
+ /**
+ * 接收消息的用户ID,必填
+ */
+ @SerializedName("userid")
+ private String userid;
+
+ /**
+ * 消息内容,必填
+ */
+ @SerializedName("message")
+ private String message;
+
+ /**
+ * 会话ID,可选,用于保持会话连续性
+ */
+ @SerializedName("session_id")
+ private String sessionId;
+
+ /**
+ * 消息ID,可选
+ */
+ @SerializedName("msg_id")
+ private String msgId;
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ public static WxCpIntelligentRobotSendMessageRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotSendMessageRequest.class);
+ }
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageResponse.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageResponse.java
new file mode 100644
index 0000000000..8098d2037e
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotSendMessageResponse.java
@@ -0,0 +1,42 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 智能机器人发送消息响应
+ * 官方文档: https://developer.work.weixin.qq.com/document/path/100719
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxCpIntelligentRobotSendMessageResponse extends WxCpBaseResp implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 消息ID
+ */
+ @SerializedName("msg_id")
+ private String msgId;
+
+ /**
+ * 会话ID
+ */
+ @SerializedName("session_id")
+ private String sessionId;
+
+ public static WxCpIntelligentRobotSendMessageResponse fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotSendMessageResponse.class);
+ }
+
+ @Override
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotUpdateRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotUpdateRequest.java
new file mode 100644
index 0000000000..027812a7e9
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/intelligentrobot/WxCpIntelligentRobotUpdateRequest.java
@@ -0,0 +1,55 @@
+package me.chanjar.weixin.cp.bean.intelligentrobot;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+
+/**
+ * 更新智能机器人请求
+ *
+ * @author Binary Wang
+ */
+@Data
+public class WxCpIntelligentRobotUpdateRequest implements Serializable {
+ private static final long serialVersionUID = -1L;
+
+ /**
+ * 机器人ID
+ */
+ @SerializedName("robot_id")
+ private String robotId;
+
+ /**
+ * 机器人名称
+ */
+ @SerializedName("name")
+ private String name;
+
+ /**
+ * 机器人描述
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ * 机器人头像
+ */
+ @SerializedName("avatar")
+ private String avatar;
+
+ /**
+ * 机器人状态 0:停用 1:启用
+ */
+ @SerializedName("status")
+ private Integer status;
+
+ public String toJson() {
+ return WxCpGsonBuilder.create().toJson(this);
+ }
+
+ public static WxCpIntelligentRobotUpdateRequest fromJson(String json) {
+ return WxCpGsonBuilder.create().fromJson(json, WxCpIntelligentRobotUpdateRequest.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
index a903d0fa54..38d25e61cd 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/kf/WxCpKfAccountLink.java
@@ -27,10 +27,10 @@ public class WxCpKfAccountLink implements Serializable {
* 场景值,字符串类型,由开发者自定义。
* 不多于32字节
* 字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
- *
+ *
* 1. 若scene非空,返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用,用户进入会话事件会将SCENE_PARAM原样返回。
* 其中SCENE_PARAM需要urlencode,且长度不能超过128字节。
- * 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2
+ * {@code 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2}
* 2. 历史调用接口返回的客服链接(包含encScene=XXX参数),不支持scene_param参数。
* 3. 返回的客服链接,不能修改或复制参数到其他链接使用。否则进入会话事件参数校验不通过,导致无法回调。
*/
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
index c5cb21bde5..0149a426f6 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlReq.java
@@ -5,8 +5,9 @@
/**
* 生成异步上传任务
+ *
* @author imyzt
- * @date 2025/04/27
+ * @since 2025/04/27
*/
@Data
public class MediaUploadByUrlReq {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
index cc931eed39..595f85dffa 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/media/MediaUploadByUrlResult.java
@@ -10,8 +10,9 @@
/**
* 异步上传企微素材
+ *
* @author imyzt
- * @date 2025/4/27
+ * @since 2025/4/27
*/
@EqualsAndHashCode(callSuper = true)
@Data
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java
index d115245e04..97beeec189 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpGroupRobotMessage.java
@@ -252,6 +252,12 @@ public String toJson() {
messageJson.add("markdown", text);
break;
}
+ case MARKDOWN_V2: {
+ JsonObject text = new JsonObject();
+ text.addProperty("content", this.getContent());
+ messageJson.add("markdown_v2", text);
+ break;
+ }
case IMAGE: {
JsonObject text = new JsonObject();
text.addProperty("base64", this.getBase64());
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
index 92209fd4e5..7e777384eb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpLinkedCorpMessage.java
@@ -85,13 +85,13 @@ public class WxCpLinkedCorpMessage implements Serializable {
/**
*
* 文档地址
- *
* 文档地址
- *
* external_userid必须是handover_userid的客户(即配置了客户联系功能的成员所添加的联系人)。
* 在职成员的每位客户最多被分配2次。客户被转接成功后,将有90个自然日的服务关系保护期,保护期内的客户无法再次被分配。
- *
* 权限说明:
- *
* handover_userid必须是已离职用户。
* external_userid必须是handover_userid的客户(即配置了客户联系功能的成员所添加的联系人)。
* 在职成员的每位客户最多被分配2次。客户被转接成功后,将有90个自然日的服务关系保护期,保护期内的客户无法再次被分配。
- *
* 权限说明:
- *
* 注意::
- *
* 注意:
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
@@ -716,11 +724,14 @@ WxCpUserExternalGroupChatStatistic getGroupChatStatistic(Date startTime, Integer
* 企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。(注:企业微信终端需升级到2.7.5版本及以上)
* 注意:调用该接口并不会直接发送消息给客户/客户群,需要相关的客服人员操作以后才会实际发送(客服人员的企业微信需要升级到2.7.5及以上版本)
* 同一个企业每个自然月内仅可针对一个客户/客户群发送4条消息,超过限制的用户将会被忽略。
- *
*
* @param mediaId 媒体id
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
index e49a36ba50..534cc89b36 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMessageService.java
@@ -72,8 +72,9 @@ public interface WxCpMessageService {
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/recall?access_token=ACCESS_TOKEN
* 文档地址: https://developer.work.weixin.qq.com/document/path/94867
*
+ *
* @param msgId 消息id
- * @throws WxErrorException
+ * @throws WxErrorException 异常
*/
void recall(String msgId) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java
index 221caf2e70..b754e32b7e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java
@@ -28,9 +28,26 @@ public interface WxCpMsgAuditService {
* @param timeout 超时时间,根据实际需要填写
* @return 返回是否调用成功 chat datas
* @throws Exception the exception
+ * @deprecated 请使用 {@link #getChatRecords(long, long, String, String, long)} 代替,
+ * 该方法会将SDK暴露给调用方,容易导致SDK生命周期管理混乱,引发JVM崩溃
*/
+ @Deprecated
WxCpChatDatas getChatDatas(long seq, @NonNull long limit, String proxy, String passwd, @NonNull long timeout) throws Exception;
+ /**
+ * 拉取聊天记录函数(推荐使用)
+ * 该方法不会将SDK暴露给调用方,SDK生命周期由框架自动管理,更加安全
+ *
+ * @param seq 从指定的seq开始拉取消息,注意的是返回的消息从seq+1开始返回,seq为之前接口返回的最大seq值。首次使用请使用seq:0
+ * @param limit 一次拉取的消息条数,最大值1000条,超过1000条会返回错误
+ * @param proxy 使用代理的请求,需要传入代理的链接。如:socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081,如果没有传null
+ * @param passwd 代理账号密码,需要传入代理的账号密码。如 user_name:passwd_123,如果没有传null
+ * @param timeout 超时时间,根据实际需要填写
+ * @return 返回聊天记录列表,不包含SDK信息
+ * @throws Exception the exception
+ */
+ List
* 企业和第三方应用可通过此接口获取企业与成员的群发记录。
- * 获取企业群发成员执行结果
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
*
*
* @param msgid 群发消息的id,通过获取群发记录列表接口返回
@@ -1031,7 +1046,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取群发成员发送任务列表。
- * 获取群发成员发送任务列表
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
*
*
* @param msgid 群发消息的id,通过获取群发记录列表接口返回
@@ -1045,7 +1060,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 添加入群欢迎语素材。
- * 添加入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param template 素材内容
@@ -1057,7 +1072,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 编辑入群欢迎语素材。
- * 编辑入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param template the template
@@ -1069,7 +1084,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取入群欢迎语素材。
- * 获取入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param templateId 群欢迎语的素材id
@@ -1082,7 +1097,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
*
* 删除入群欢迎语素材。
* 企业可通过此API删除入群欢迎语素材,且仅能删除调用方自己创建的入群欢迎语素材。
- * 删除入群欢迎语素材
+ * 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
*
*
* @param templateId 群欢迎语的素材id
@@ -1094,8 +1109,8 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
- * 获取商品图册
- * 获取商品图册列表
+ * 获取商品图册列表
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
*
*
* @param limit 返回的最大记录数,整型,最大值100,默认值50,超过最大值时取默认值
@@ -1108,7 +1123,7 @@ WxCpGroupMsgListResult getGroupMsgListV2(String chatType, Date startTime, Date e
/**
*
* 获取商品图册
- * 获取商品图册
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
*
*
* @param productId 商品id
@@ -1155,7 +1170,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口新建敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN
- *
+ *
* @param ruleAddRequest the rule add request
* @return 规则id
* @throws WxErrorException the wx error exception
@@ -1169,7 +1184,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN
- *
+ *
* @param interceptRule the rule
* @throws WxErrorException the wx error exception
*/
@@ -1181,7 +1196,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式:POST(HTTPS)
* 请求地址
- *
+ *
* @param ruleId 规则id
* @throws WxErrorException the wx error exception
*/
@@ -1220,7 +1235,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN
* 文档地址
- *
+ *
* @param wxCpProductAlbumInfo 商品图册信息
* @return 商品id string
* @throws WxErrorException the wx error exception
@@ -1235,7 +1250,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN
* 文档地址
- *
+ *
* @param wxCpProductAlbumInfo 商品图册信息
* @throws WxErrorException the wx error exception
*/
@@ -1250,7 +1265,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN
*
* 文档地址
- *
+ *
* @param productId 商品id
* @throws WxErrorException the wx error exception
*/
@@ -1379,7 +1394,7 @@ WxMediaUploadResult uploadAttachment(String mediaType, Integer attachmentType, F
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/statistic?access_token=ACCESS_TOKEN
*
* @author Hugo
- * @date 2023/12/5 14:34
+ * @since 2023/12/5 14:34
* @param linkId 获客链接的id
* @param startTime 统计起始时间
* @param endTime 统计结束时间
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
index e396ed58ac..b8ccea5e50 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpGroupRobotService.java
@@ -70,6 +70,23 @@ public interface WxCpGroupRobotService {
*/
void sendMarkdown(String webhookUrl, String content) throws WxErrorException;
+ /**
+ * 发送markdown_v2类型的消息
+ *
+ * @param content markdown内容,最长不超过4096个字节,必须是utf8编码
+ * @throws WxErrorException 异常
+ */
+ void sendMarkdownV2(String content) throws WxErrorException;
+
+ /**
+ * 发送markdown_v2类型的消息
+ *
+ * @param webhookUrl webhook地址
+ * @param content markdown内容,最长不超过4096个字节,必须是utf8编码
+ * @throws WxErrorException 异常
+ */
+ void sendMarkdownV2(String webhookUrl, String content) throws WxErrorException;
+
/**
* 发送image类型的消息
*
@@ -109,9 +126,10 @@ public interface WxCpGroupRobotService {
/**
* 发送模板卡片消息
- * @param webhookUrl
- * @param wxCpGroupRobotMessage
- * @throws WxErrorException
+ *
+ * @param webhookUrl webhook地址
+ * @param wxCpGroupRobotMessage 群机器人消息
+ * @throws WxErrorException 异常
*/
void sendTemplateCardMessage(String webhookUrl, WxCpGroupRobotMessage wxCpGroupRobotMessage) throws WxErrorException;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpIntelligentRobotService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpIntelligentRobotService.java
new file mode 100644
index 0000000000..bc5f3f1915
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpIntelligentRobotService.java
@@ -0,0 +1,77 @@
+package me.chanjar.weixin.cp.api;
+
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.cp.bean.intelligentrobot.*;
+
+/**
+ * 企业微信智能机器人接口
+ * 官方文档: https://developer.work.weixin.qq.com/document/path/101039
+ *
+ * @author Binary Wang
+ */
+public interface WxCpIntelligentRobotService {
+
+ /**
+ * 创建智能机器人
+ *
+ * @param request 创建请求参数
+ * @return 创建结果
+ * @throws WxErrorException 微信接口异常
+ */
+ WxCpIntelligentRobotCreateResponse createRobot(WxCpIntelligentRobotCreateRequest request) throws WxErrorException;
+
+ /**
+ * 删除智能机器人
+ *
+ * @param robotId 机器人ID
+ * @throws WxErrorException 微信接口异常
+ */
+ void deleteRobot(String robotId) throws WxErrorException;
+
+ /**
+ * 更新智能机器人
+ *
+ * @param request 更新请求参数
+ * @throws WxErrorException 微信接口异常
+ */
+ void updateRobot(WxCpIntelligentRobotUpdateRequest request) throws WxErrorException;
+
+ /**
+ * 查询智能机器人
+ *
+ * @param robotId 机器人ID
+ * @return 机器人信息
+ * @throws WxErrorException 微信接口异常
+ */
+ WxCpIntelligentRobot getRobot(String robotId) throws WxErrorException;
+
+ /**
+ * 智能机器人会话
+ *
+ * @param request 聊天请求参数
+ * @return 聊天响应
+ * @throws WxErrorException 微信接口异常
+ */
+ WxCpIntelligentRobotChatResponse chat(WxCpIntelligentRobotChatRequest request) throws WxErrorException;
+
+ /**
+ * 重置智能机器人会话
+ *
+ * @param robotId 机器人ID
+ * @param userid 用户ID
+ * @param sessionId 会话ID
+ * @throws WxErrorException 微信接口异常
+ */
+ void resetSession(String robotId, String userid, String sessionId) throws WxErrorException;
+
+ /**
+ * 智能机器人主动发送消息
+ * 官方文档: https://developer.work.weixin.qq.com/document/path/100719
+ *
+ * @param request 发送消息请求参数
+ * @return 发送消息响应
+ * @throws WxErrorException 微信接口异常
+ */
+ WxCpIntelligentRobotSendMessageResponse sendMessage(WxCpIntelligentRobotSendMessageRequest request) throws WxErrorException;
+
+}
\ No newline at end of file
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
index 5a53829dc0..046cfbc5bb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpKfService.java
@@ -222,7 +222,7 @@ WxCpKfCustomerBatchGetResp customerBatchGet(List
+ *
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception
@@ -238,7 +238,7 @@ WxCpKfCustomerBatchGetResp customerBatchGet(List
+ *
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
index a2e2344190..63fabad7a1 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpLivingService.java
@@ -27,7 +27,7 @@ public interface WxCpLivingService {
/**
* 获取直播详情
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
*
* @param livingId 直播id
* @return 获取的直播详情 living info
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
index e874b26f42..dd5ce594b2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMediaService.java
@@ -110,9 +110,9 @@ WxMediaUploadResult upload(String mediaType, String filename, String url)
* 获取高清语音素材.
* 可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材,格式为speex,16K采样率。该音频比上文的临时素材获取接口(格式为amr,8K采样率)更加清晰,适合用作语音识别等对音质要求较高的业务。
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
* 仅企业微信2.4及以上版本支持。
- * 文档地址:https://work.weixin.qq.com/api/doc#90000/90135/90255
+ * 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/90255
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return school user info
@@ -123,7 +124,7 @@ public interface WxCpOAuth2Service {
/**
*
* 获取用户登录身份
- * https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* 该接口可使用用户登录成功颁发的code来获取成员信息,适用于自建应用与代开发应用
*
* 注意: 旧的/user/getuserinfo 接口的url已变更为auth/getuserinfo,不过旧接口依旧可以使用,建议是关注新接口即可
@@ -140,13 +141,15 @@ public interface WxCpOAuth2Service {
/**
* 获取用户二次验证信息
- *
*
* @param wxCpOaMeetingRoomBookingInfoRequest 会议室预定信息查询对象
+ * @return 会议室预定信息
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookingInfoResult getMeetingRoomBookingInfo(WxCpOaMeetingRoomBookingInfoRequest wxCpOaMeetingRoomBookingInfoRequest) throws WxErrorException;
@@ -99,6 +100,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoom(WxCpOaMeetingRoomBookRequest wxCpOaMeetingRoomBookRequest) throws WxErrorException;
@@ -114,6 +116,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookByScheduleRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomBySchedule(WxCpOaMeetingRoomBookByScheduleRequest wxCpOaMeetingRoomBookByScheduleRequest) throws WxErrorException;
@@ -129,6 +132,7 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookByMeetingRequest 会议室预定对象
+ * @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomByMeeting(WxCpOaMeetingRoomBookByMeetingRequest wxCpOaMeetingRoomBookByMeetingRequest) throws WxErrorException;
@@ -147,10 +151,10 @@ public interface WxCpOaMeetingRoomService {
* @param wxCpOaMeetingRoomCancelBookRequest 取消预定会议室对象
* @throws WxErrorException .
*/
- void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
+ void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
- /**
+ /**
* 根据会议室预定ID查询预定详情.
*
* api: https://qyapi.weixin.qq.com/cgi-bin/auth/get_tfa_info?access_token=ACCESS_TOKEN
* 权限说明:仅『通讯录同步』或者自建应用可调用,如用自建应用调用,用户需要在二次验证范围和应用可见范围内。
* 并发限制:20
+ *
*
* @param code 用户进入二次验证页面时,企业微信颁发的code,每次成员授权带上的code将不一样,code只能使用一次,5分钟未被使用自动过期
- * @return me.chanjar.weixin.cp.bean.workbench.WxCpSecondVerificationInfo 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟,且只能使用一次。
+ * @return 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟,且只能使用一次。
+ * @throws WxErrorException 微信错误异常
*/
WxCpSecondVerificationInfo getTfaInfo(String code) throws WxErrorException;
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
index c2e6c5c872..cc039fd9f5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaMeetingRoomService.java
@@ -84,6 +84,7 @@ public interface WxCpOaMeetingRoomService {
*
* 企业可通过此接口根据预定id查询相关会议室的预定情况
@@ -161,8 +165,9 @@ public interface WxCpOaMeetingRoomService {
*
*
* @param wxCpOaMeetingRoomBookingInfoByBookingIdRequest 根据会议室预定ID查询预定详情对象
+ * @return 预定详情
* @throws WxErrorException .
*/
- WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
+ WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
index ee57107b5c..3494dcfa4e 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaService.java
@@ -11,7 +11,8 @@
/**
* 企业微信OA相关接口.
*
- * @author Element & Wang_Wong created on 2019-04-06 10:52
+ * @author Element, Wang_Wong
+ * @since 2019-04-06 10:52
*/
public interface WxCpOaService {
@@ -331,7 +332,7 @@ List
+ *
* @param userId 需要录入的用户id
* @param userFace 需要录入的人脸图片数据,需要将图片数据base64处理后填入,对已录入的人脸会进行更新处理
* @throws WxErrorException the wx error exception
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
index 1356c839b2..d63d32694a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOaWeDocService.java
@@ -78,4 +78,53 @@ public interface WxCpOaWeDocService {
* @throws WxErrorException the wx error exception
*/
WxCpDocShare docShare(@NonNull String docId) throws WxErrorException;
+
+ /**
+ * 编辑表格内容
+ * 该接口可以对一个在线表格批量执行多个更新操作
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid
- * =LIVINGID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
+ *
*
* @param livingId the living id
* @return living info
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
index a92bfcc100..d004ca8aa5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java
@@ -19,9 +19,10 @@ public interface WxCpSchoolUserService {
/**
* 获取访问用户身份
* 该接口用于根据code获取成员信息
- *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return user info
@@ -32,9 +33,10 @@ public interface WxCpSchoolUserService {
/**
* 获取家校访问用户身份
* 该接口用于根据code获取家长或者学生信息
- *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
+ *
*
* @param code the code
* @return school user info
@@ -90,8 +92,10 @@ public interface WxCpSchoolUserService {
/**
* 删除学生
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param studentUserId the student user id
* @return wx cp base resp
@@ -160,8 +164,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 读取学生或家长
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param userId the user id
* @return user
@@ -171,9 +177,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门成员详情
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
- * &fetch_child=FETCH_CHILD
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
+ *
*
* @param departmentId 获取的部门id
* @param fetchChild 1/0:是否递归获取子部门下面的成员
@@ -184,9 +191,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取部门家长详情
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id
- * =DEPARTMENT_ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID}
+ *
*
* @param departmentId 获取的部门id
* @return user list parent
@@ -207,8 +215,10 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 删除家长
+ *
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID}
+ *
*
* @param userId the user id
* @return wx cp base resp
@@ -256,7 +266,7 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 删除部门
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID}
*
* @param id the id
* @return wx cp base resp
@@ -292,10 +302,9 @@ WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserI
/**
* 获取外部联系人详情
* 学校可通过此接口,根据外部联系人的userid(如何获取?),拉取外部联系人详情。
- *
* 获取部门成员详情
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
*
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/90201
*
@@ -213,7 +213,7 @@ public interface WxCpUserService {
* 获取加入企业二维码。
*
* 请求方式:GET(HTTPS)
- * 请求地址:https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE
+ * {@code 请求地址:https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE}
*
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/91714
*
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
index d0b7441d90..bc18c9bc7a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/BaseWxCpServiceImpl.java
@@ -74,6 +74,7 @@ public abstract class BaseWxCpServiceImpl
+ *
*
*
+ *
*
*
* 请使用.
- * {@link LinkedCorpMsgType#TEXT}
- * {@link LinkedCorpMsgType#IMAGE}
- * {@link LinkedCorpMsgType#VIDEO}
- * {@link LinkedCorpMsgType#NEWS}
- * {@link LinkedCorpMsgType#MPNEWS}
- * {@link LinkedCorpMsgType#MARKDOWN}
- * {@link LinkedCorpMsgType#MINIPROGRAM_NOTICE}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#TEXT}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#IMAGE}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#VIDEO}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#NEWS}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MARKDOWN}
+ * {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MINIPROGRAM_NOTICE}
*
*
* @param msgType 消息类型
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
index c5e55220e5..08a0936317 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpXmlMessage.java
@@ -68,19 +68,19 @@ public class WxCpXmlMessage implements Serializable {
/**
*
* 当接受用户消息时,可能会获得以下值:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#LOCATION}
- * {@link WxConsts.XmlMsgType#LINK}
- * {@link WxConsts.XmlMsgType#EVENT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LOCATION}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LINK}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#EVENT}
* 当发送消息的时候使用:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#NEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#NEWS}
*
*/
@XStreamAlias("MsgType")
@@ -157,7 +157,7 @@ public class WxCpXmlMessage implements Serializable {
@XStreamAlias("MemChangeList")
@XStreamConverter(value = XStreamCDataConverter.class)
- private String MemChangeList;
+ private String memChangeList;
@XStreamAlias("LastMemVer")
@XStreamConverter(value = XStreamCDataConverter.class)
@@ -253,6 +253,24 @@ public class WxCpXmlMessage implements Serializable {
@XStreamConverter(value = XStreamCDataConverter.class)
private String linkId;
+ /**
+ * 智能机器人ID
+ * 接收智能机器人消息时使用
+ * https://developer.work.weixin.qq.com/document/path/100719
+ */
+ @XStreamAlias("RobotId")
+ @XStreamConverter(value = XStreamCDataConverter.class)
+ private String robotId;
+
+ /**
+ * 智能机器人会话ID
+ * 接收智能机器人消息时使用,用于保持会话连续性
+ * https://developer.work.weixin.qq.com/document/path/100719
+ */
+ @XStreamAlias("SessionId")
+ @XStreamConverter(value = XStreamCDataConverter.class)
+ private String sessionId;
+
/**
* 通讯录变更事件.
* 请参考常量 me.chanjar.weixin.cp.constant.WxCpConsts.ContactChangeType
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
index d3cbb89a3d..1ab92630a9 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
@@ -12,7 +12,8 @@
* 用法: WxCustomMessage m = WxCustomMessage.TEMPLATECARD().title(...)....toUser(...).build();
*
*
- * @author yzts a> created on 2019-05-16
+ * @author yzts
+ * @since 2019-05-16
*/
public class TemplateCardBuilder extends BaseBuilder
+ *
* 取值范围:-604800 ~ 86399
*/
@SerializedName("remind_time_diffs")
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java
new file mode 100644
index 0000000000..37c42717e7
--- /dev/null
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/doc/WxCpDocSheetBatchUpdateRequest.java
@@ -0,0 +1,199 @@
+package me.chanjar.weixin.cp.bean.oa.doc;
+
+import java.io.Serializable;
+import java.util.List;
+
+import com.google.gson.annotations.SerializedName;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import me.chanjar.weixin.cp.bean.oa.doc.WxCpDocSheetData.GridData;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+/**
+ * 编辑表格内容请求
+ *
+ * @author zhongying
+ * @since 2026-01-07
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class WxCpDocSheetBatchUpdateRequest implements Serializable {
+ private static final long serialVersionUID = 584565591133421347L;
+
+ /**
+ * 文档的docid.必填
+ */
+ @SerializedName("docid")
+ private String docId;
+
+ /**
+ * 更新操作列表.必填
+ */
+ @SerializedName("requests")
+ private List
+ *
* 会议室冲突日期列表,为当天0点的时间戳;使用重复会议预定会议室,部分日期与会议室预定情况冲突时返回
*/
@SerializedName("conflict_date")
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
index 58daeb007c..eada2ad100 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTips.java
@@ -8,7 +8,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:40
+ * @since 2025/1/16 09:40
*/
@Data
public class TemplateTips {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
index 939e6819a0..0af8be8be5 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsContent.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:42
+ * @since 2025/1/16 09:42
*/
@Data
public class TemplateTipsContent {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
index ac4681038c..78e88562e8 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubText.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:45
+ * @since 2025/1/16 09:45
*/
@Data
public class TemplateTipsSubText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
index 9c99b2688e..f33c31d054 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContent.java
@@ -6,7 +6,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:46
+ * @since 2025/1/16 09:46
*/
@Data
public class TemplateTipsSubTextContent {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
index 4cd198409a..fd4db2c18f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentLink.java
@@ -5,7 +5,7 @@
/**
* @author mrsiu@msn.com
* @version 1.0
- * @date 2025/1/16 09:49
+ * @since 2025/1/16 09:49
*/
@Data
public class TemplateTipsSubTextContentLink {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
index 12969cdcdb..0a2e792edb 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsSubTextContentPlainText.java
@@ -3,9 +3,9 @@
import lombok.Data;
/**
- * @author mrsiu@msn.com
- * @date 2025/1/16 09:47
- * @version 1.0
+ * @author mrsiu@msn.com
+ * @version 1.0
+ * @since 2025/1/16 09:47
*/
@Data
public class TemplateTipsSubTextContentPlainText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
index 100c5bb137..c9dbe68abf 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/oa/templatedata/TemplateTipsText.java
@@ -6,9 +6,9 @@
import java.util.List;
/**
- * @author mrsiu@msn.com
- * @date 2025/1/16 09:43
- * @version 1.0
+ * @author mrsiu@msn.com
+ * @version 1.0
+ * @since 2025/1/16 09:43
*/
@Data
public class TemplateTipsText {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java
index 36203aab11..fd96d76c30 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java
@@ -260,7 +260,79 @@ public interface WxCpConfigStorage {
/**
* 获取会话存档的secret
+ *
* @return msg audit secret
*/
String getMsgAuditSecret();
+
+ /**
+ * 获取会话存档SDK
+ * 会话存档SDK初始化后有效期为7200秒,无需每次重新初始化
+ *
+ * @return sdk id,如果未初始化或已过期返回0
+ */
+ long getMsgAuditSdk();
+
+ /**
+ * 检查会话存档SDK是否已过期
+ *
+ * @return true: 已过期, false: 未过期
+ */
+ boolean isMsgAuditSdkExpired();
+
+ /**
+ * 更新会话存档SDK
+ *
+ * @param sdk sdk id
+ * @param expiresInSeconds 过期时间(秒)
+ */
+ void updateMsgAuditSdk(long sdk, int expiresInSeconds);
+
+ /**
+ * 使会话存档SDK过期
+ */
+ void expireMsgAuditSdk();
+
+ /**
+ * 增加会话存档SDK的引用计数
+ * 用于支持多线程安全的SDK生命周期管理
+ *
+ * @param sdk sdk id
+ * @return 增加后的引用计数,如果SDK不匹配返回-1
+ */
+ int incrementMsgAuditSdkRefCount(long sdk);
+
+ /**
+ * 减少会话存档SDK的引用计数
+ * 当引用计数降为0时,自动销毁SDK以释放资源
+ *
+ * @param sdk sdk id
+ * @return 减少后的引用计数,如果返回0表示SDK已被销毁,如果SDK不匹配返回-1
+ */
+ int decrementMsgAuditSdkRefCount(long sdk);
+
+ /**
+ * 获取会话存档SDK的引用计数
+ *
+ * @param sdk sdk id
+ * @return 当前引用计数,如果SDK不匹配返回-1
+ */
+ int getMsgAuditSdkRefCount(long sdk);
+
+ /**
+ * 获取当前SDK并增加引用计数(原子操作)
+ * 如果SDK未初始化或已过期,返回0而不增加引用计数
+ * 此方法用于在获取SDK后立即增加引用计数,避免并发问题
+ *
+ * @return 当前有效的SDK id并已增加引用计数,如果SDK无效返回0
+ */
+ long acquireMsgAuditSdk();
+
+ /**
+ * 减少SDK引用计数并在必要时释放(原子操作)
+ * 此方法确保引用计数递减和SDK检查在同一个同步块内完成
+ *
+ * @param sdk sdk id
+ */
+ void releaseMsgAuditSdk(long sdk);
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
index 07acb189a8..df758ac3a2 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpCorpGroupConfigStorage.java
@@ -31,8 +31,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Update corp access token.
*
- * @param corpId
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @param corpAccessToken the corp access token
* @param expiresInSeconds the expires in seconds
*/
@@ -41,8 +41,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* 授权企业的access token相关
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token
*/
String getCorpAccessToken(String corpId, Integer agentId);
@@ -50,8 +50,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token entity.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token entity
*/
WxAccessToken getCorpAccessTokenEntity(String corpId, Integer agentId);
@@ -59,8 +59,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Is access token expired boolean.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the boolean
*/
boolean isCorpAccessTokenExpired(String corpId, Integer agentId);
@@ -68,8 +68,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Expire access token.
*
- * @param corpId the corp id
- * @param agentId
+ * @param corpId 企业ID
+ * @param agentId 应用ID
*/
void expireCorpAccessToken(String corpId, Integer agentId);
@@ -118,7 +118,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token lock.
*
- * @param corpId the corp id
+ * @param corpId 企业ID
+ * @param agentId 应用ID
* @return the access token lock
*/
Lock getCorpAccessTokenLock(String corpId, Integer agentId);
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
index 2cd37821b5..0a2ed0e76a 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpTpConfigStorage.java
@@ -133,7 +133,7 @@ public interface WxCpTpConfigStorage {
String getEncodingAESKey();
/**
- * 企微服务商企业ID & 企业secret
+ * {@code 企微服务商企业ID & 企业secret}
*
* @return the corp id
*/
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
index 08eed33c16..6d1260fe68 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/AbstractWxCpTpInRedisConfigImpl.java
@@ -187,7 +187,9 @@ public String getEncodingAESKey() {
/**
- * 企微服务商企业ID & 企业secret, 来自于企微配置
+ * {@code 企微服务商企业ID & 企业secret, 来自于企微配置}
+ *
+ * @return 企业ID
*/
@Override
public String getCorpId() {
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java
index 57647b3712..f8047e846f 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java
@@ -1,5 +1,6 @@
package me.chanjar.weixin.cp.config.impl;
+import com.tencent.wework.Finance;
import me.chanjar.weixin.common.bean.WxAccessToken;
import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
import me.chanjar.weixin.cp.config.WxCpConfigStorage;
@@ -49,6 +50,15 @@ public class WxCpDefaultConfigImpl implements WxCpConfigStorage, Serializable {
private volatile String msgAuditSecret;
private volatile String msgAuditPriKey;
private volatile String msgAuditLibPath;
+ /**
+ * 会话存档SDK及其过期时间
+ */
+ private volatile long msgAuditSdk;
+ private volatile long msgAuditSdkExpiresTime;
+ /**
+ * 会话存档SDK引用计数,用于多线程安全的生命周期管理
+ */
+ private volatile int msgAuditSdkRefCount;
private volatile String oauth2redirectUri;
private volatile String httpProxyHost;
private volatile int httpProxyPort;
@@ -444,10 +454,98 @@ public String getMsgAuditSecret() {
/**
* 设置会话存档secret
- * @param msgAuditSecret
+ *
+ * @param msgAuditSecret the msg audit secret
+ * @return this
*/
public WxCpDefaultConfigImpl setMsgAuditSecret(String msgAuditSecret) {
this.msgAuditSecret = msgAuditSecret;
return this;
}
+
+ @Override
+ public long getMsgAuditSdk() {
+ return this.msgAuditSdk;
+ }
+
+ @Override
+ public boolean isMsgAuditSdkExpired() {
+ return System.currentTimeMillis() > this.msgAuditSdkExpiresTime;
+ }
+
+ @Override
+ public synchronized void updateMsgAuditSdk(long sdk, int expiresInSeconds) {
+ // 如果有旧的SDK且不同于新的SDK,需要销毁旧的SDK
+ if (this.msgAuditSdk > 0 && this.msgAuditSdk != sdk) {
+ // 无论旧SDK是否仍有引用,都需要销毁它以避免资源泄漏
+ // 如果有飞行中的请求使用旧SDK,这些请求可能会失败,但这比资源泄漏更安全
+ Finance.DestroySdk(this.msgAuditSdk);
+ }
+ this.msgAuditSdk = sdk;
+ // 预留200秒的时间
+ this.msgAuditSdkExpiresTime = System.currentTimeMillis() + (expiresInSeconds - 200) * 1000L;
+ // 重置引用计数,因为这是一个全新的SDK
+ this.msgAuditSdkRefCount = 0;
+ }
+
+ @Override
+ public void expireMsgAuditSdk() {
+ this.msgAuditSdkExpiresTime = 0;
+ }
+
+ @Override
+ public synchronized int incrementMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && sdk > 0) {
+ return ++this.msgAuditSdkRefCount;
+ }
+ return -1; // SDK不匹配,返回-1表示错误
+ }
+
+ @Override
+ public synchronized int decrementMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && this.msgAuditSdkRefCount > 0) {
+ int newCount = --this.msgAuditSdkRefCount;
+ // 当引用计数降为0时,自动销毁SDK以释放资源
+ // 再次检查SDK是否仍然是当前缓存的SDK(防止并发重新初始化)
+ if (newCount == 0 && this.msgAuditSdk == sdk) {
+ Finance.DestroySdk(sdk);
+ this.msgAuditSdk = 0;
+ this.msgAuditSdkExpiresTime = 0;
+ }
+ return newCount;
+ }
+ return -1; // SDK不匹配或引用计数已为0,返回-1表示错误
+ }
+
+ @Override
+ public synchronized int getMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && sdk > 0) {
+ return this.msgAuditSdkRefCount;
+ }
+ return -1; // SDK不匹配,返回-1表示错误
+ }
+
+ @Override
+ public synchronized long acquireMsgAuditSdk() {
+ // 检查SDK是否有效(已初始化且未过期)
+ if (this.msgAuditSdk > 0 && !isMsgAuditSdkExpired()) {
+ this.msgAuditSdkRefCount++;
+ return this.msgAuditSdk;
+ }
+ return 0; // SDK未初始化或已过期
+ }
+
+ @Override
+ public synchronized void releaseMsgAuditSdk(long sdk) {
+ if (this.msgAuditSdk == sdk && this.msgAuditSdkRefCount > 0) {
+ int newCount = --this.msgAuditSdkRefCount;
+ // 当引用计数降为0时,自动销毁SDK以释放资源
+ // 再次检查SDK是否仍然是当前缓存的SDK(防止并发重新初始化)
+ if (newCount == 0 && this.msgAuditSdk == sdk) {
+ Finance.DestroySdk(sdk);
+ this.msgAuditSdk = 0;
+ this.msgAuditSdkExpiresTime = 0;
+ }
+ }
+ }
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
index 4225cff0af..48e2445506 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java
@@ -1,5 +1,6 @@
package me.chanjar.weixin.cp.config.impl;
+import com.tencent.wework.Finance;
import me.chanjar.weixin.common.bean.WxAccessToken;
import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
import me.chanjar.weixin.cp.config.WxCpConfigStorage;
@@ -50,6 +51,15 @@ public class WxCpRedisConfigImpl implements WxCpConfigStorage {
private volatile File tmpDirFile;
private volatile ApacheHttpClientBuilder apacheHttpClientBuilder;
private volatile String webhookKey;
+ /**
+ * 会话存档SDK及其过期时间(SDK是本地JVM变量,不适合存储到Redis)
+ */
+ private volatile long msgAuditSdk;
+ private volatile long msgAuditSdkExpiresTime;
+ /**
+ * 会话存档SDK引用计数,用于多线程安全的生命周期管理
+ */
+ private volatile int msgAuditSdkRefCount;
/**
* Instantiates a new Wx cp redis config.
@@ -463,11 +473,97 @@ public boolean autoRefreshToken() {
@Override
public String getWebhookKey() {
- return this.getWebhookKey();
+ return this.webhookKey;
}
@Override
public String getMsgAuditSecret() {
return null;
}
+
+ @Override
+ public long getMsgAuditSdk() {
+ return this.msgAuditSdk;
+ }
+
+ @Override
+ public boolean isMsgAuditSdkExpired() {
+ return System.currentTimeMillis() > this.msgAuditSdkExpiresTime;
+ }
+
+ @Override
+ public synchronized void updateMsgAuditSdk(long sdk, int expiresInSeconds) {
+ // 如果有旧的SDK且不同于新的SDK,需要销毁旧的SDK
+ if (this.msgAuditSdk > 0 && this.msgAuditSdk != sdk) {
+ // 无论旧SDK是否仍有引用,都需要销毁它以避免资源泄漏
+ // 如果有飞行中的请求使用旧SDK,这些请求可能会失败,但这比资源泄漏更安全
+ Finance.DestroySdk(this.msgAuditSdk);
+ }
+ this.msgAuditSdk = sdk;
+ // 预留200秒的时间
+ this.msgAuditSdkExpiresTime = System.currentTimeMillis() + (expiresInSeconds - 200) * 1000L;
+ // 重置引用计数,因为这是一个全新的SDK
+ this.msgAuditSdkRefCount = 0;
+ }
+
+ @Override
+ public void expireMsgAuditSdk() {
+ this.msgAuditSdkExpiresTime = 0;
+ }
+
+ @Override
+ public synchronized int incrementMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && sdk > 0) {
+ return ++this.msgAuditSdkRefCount;
+ }
+ return -1; // SDK不匹配,返回-1表示错误
+ }
+
+ @Override
+ public synchronized int decrementMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && this.msgAuditSdkRefCount > 0) {
+ int newCount = --this.msgAuditSdkRefCount;
+ // 当引用计数降为0时,自动销毁SDK以释放资源
+ // 再次检查SDK是否仍然是当前缓存的SDK(防止并发重新初始化)
+ if (newCount == 0 && this.msgAuditSdk == sdk) {
+ Finance.DestroySdk(sdk);
+ this.msgAuditSdk = 0;
+ this.msgAuditSdkExpiresTime = 0;
+ }
+ return newCount;
+ }
+ return -1; // SDK不匹配或引用计数已为0,返回-1表示错误
+ }
+
+ @Override
+ public synchronized int getMsgAuditSdkRefCount(long sdk) {
+ if (this.msgAuditSdk == sdk && sdk > 0) {
+ return this.msgAuditSdkRefCount;
+ }
+ return -1; // SDK不匹配,返回-1表示错误
+ }
+
+ @Override
+ public synchronized long acquireMsgAuditSdk() {
+ // 检查SDK是否有效(已初始化且未过期)
+ if (this.msgAuditSdk > 0 && !isMsgAuditSdkExpired()) {
+ this.msgAuditSdkRefCount++;
+ return this.msgAuditSdk;
+ }
+ return 0; // SDK未初始化或已过期
+ }
+
+ @Override
+ public synchronized void releaseMsgAuditSdk(long sdk) {
+ if (this.msgAuditSdk == sdk && this.msgAuditSdkRefCount > 0) {
+ int newCount = --this.msgAuditSdkRefCount;
+ // 当引用计数降为0时,自动销毁SDK以释放资源
+ // 再次检查SDK是否仍然是当前缓存的SDK(防止并发重新初始化)
+ if (newCount == 0 && this.msgAuditSdk == sdk) {
+ Finance.DestroySdk(sdk);
+ this.msgAuditSdk = 0;
+ this.msgAuditSdkExpiresTime = 0;
+ }
+ }
+ }
}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
index fc124251f5..7fbbc9ccce 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpTpDefaultConfigImpl.java
@@ -29,7 +29,7 @@ public class WxCpTpDefaultConfigImpl implements WxCpTpConfigStorage, Serializabl
private final transient Map
+ * 服务商可通过本接口获取服务商所拥有的应用模板列表
+ * 文档地址:https://developer.work.weixin.qq.com/document/path/97111
+ *
+ *
+ * @return 应用模板列表
+ * @throws WxErrorException 微信错误异常
+ */
+ WxCpTpTemplateList getTemplateList() throws WxErrorException;
+
+ /**
+ * 获取代开发应用详情
+ *
+ * 服务商可通过本接口获取某个授权企业中已经安装的代开发自建应用的详情
+ * 文档地址:https://developer.work.weixin.qq.com/document/path/97111
+ *
+ *
+ * @param authCorpId 授权企业的corpid
+ * @param agentId 应用的agentid,为空时则返回该企业所有的代开发自建应用详情
+ * @return 代开发应用详情
+ * @throws WxErrorException 微信错误异常
+ */
+ WxCpTpCustomizedAppDetail getCustomizedAppDetail(String authCorpId, Integer agentId) throws WxErrorException;
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpEditionService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpEditionService.java
index 2c2f11628b..d539f03bca 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpEditionService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpEditionService.java
@@ -15,7 +15,7 @@ public interface WxCpTpEditionService {
* 延长试用期
*
*
- * 获取审批申请详情
+ * 获取审批申请详情
*
* @param spNo 审批单编号。
* @param corpId the corp id
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
index 3aff90bb56..6e0acb7dee 100644
--- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
+++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpOrderService.java
@@ -18,7 +18,7 @@ public interface WxCpTpOrderService {
* 获取订单详情
*
* 文档地址 - *
+ * * * @param startTime 起始时间 * @param endTime 终止时间 diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java index b24be535da..92966c1d03 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpService.java @@ -199,7 +199,7 @@ public interface WxCpTpService { * @return permanent code info * @throws WxErrorException the wx error exception * @author yuan - * @since 2020 -03-18 + * @since 2020-03-18 */ WxCpTpPermanentCodeInfo getPermanentCodeInfo(String authCode) throws WxErrorException; @@ -227,7 +227,7 @@ public interface WxCpTpService { * @param authType 授权类型:0 正式授权, 1 测试授权。 * @return pre auth url * @throws WxErrorException the wx error exception - * @link https ://work.weixin.qq.com/api/doc/90001/90143/90602 + * @see 文档地址 */ String getPreAuthUrl(String redirectUri, String state, int authType) throws WxErrorException; @@ -558,12 +558,12 @@ WxCpTpXmlMessage fromEncryptedXml(String encryptedXml, WxCpTpAppQrcode getAppQrcode(String suiteId, String appId, String state, Integer style, Integer resultType) throws WxErrorException ; /** - * * 明文corpid转换为加密corpid 为更好地保护企业与用户的数据,第三方应用获取的corpid不再是明文的corpid,将升级为第三方服务商级别的加密corpid。文档说明 * 第三方可以将已有的明文corpid转换为第三方的加密corpid。 - * @param corpId - * @return - * @throws WxErrorException + * + * @param corpId 企业ID + * @return 加密的企业ID + * @throws WxErrorException 微信错误异常 */ WxCpTpCorpId2OpenCorpId corpId2OpenCorpId(String corpId) throws WxErrorException; @@ -655,9 +655,25 @@ WxCpTpXmlMessage fromEncryptedXml(String encryptedXml, /** * 构造第三方应用oauth2链接 + * + * @return OAuth2服务 */ WxCpTpOAuth2Service getWxCpTpOAuth2Service(); void setWxCpTpOAuth2Service(WxCpTpOAuth2Service wxCpTpOAuth2Service); + /** + * 获取代开发服务 + * + * @return 代开发服务 + */ + WxCpTpCustomizedService getWxCpTpCustomizedService(); + + /** + * 设置代开发服务 + * + * @param wxCpTpCustomizedService 代开发服务 + */ + void setWxCpTpCustomizedService(WxCpTpCustomizedService wxCpTpCustomizedService); + } diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java index b508df59a1..df60041865 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/WxCpTpTagService.java @@ -13,7 +13,7 @@ * * * @author zhangq* 文档地址 - *
+ * ** 文档地址 - *
+ * * * @param orderId 订单号 * @return the order @@ -49,7 +49,7 @@ public WxCpTpOrderDetails getOrder(String orderId) throws WxErrorException { * 获取订单列表 ** 文档地址 - *
+ * * * @param startTime 起始时间 * @param endTime 终止时间 diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceHttpComponentsImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceHttpComponentsImpl.java index bba597a3ee..44b5fd8693 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceHttpComponentsImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceHttpComponentsImpl.java @@ -10,7 +10,6 @@ import me.chanjar.weixin.common.util.http.hc.DefaultHttpComponentsClientBuilder; import me.chanjar.weixin.common.util.http.hc.HttpComponentsClientBuilder; import me.chanjar.weixin.common.util.json.GsonParser; -import me.chanjar.weixin.cp.config.WxCpTpConfigStorage; import me.chanjar.weixin.cp.constant.WxCpApiPathConsts; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.config.RequestConfig; @@ -87,9 +86,10 @@ public void initHttp() { HttpComponentsClientBuilder apacheHttpClientBuilder = DefaultHttpComponentsClientBuilder.get(); apacheHttpClientBuilder.httpProxyHost(this.configStorage.getHttpProxyHost()) - .httpProxyPort(this.configStorage.getHttpProxyPort()) - .httpProxyUsername(this.configStorage.getHttpProxyUsername()) - .httpProxyPassword(this.configStorage.getHttpProxyPassword().toCharArray()); + .httpProxyPort(this.configStorage.getHttpProxyPort()) + .httpProxyUsername(this.configStorage.getHttpProxyUsername()) + .httpProxyPassword(this.configStorage.getHttpProxyPassword() == null ? null : + this.configStorage.getHttpProxyPassword().toCharArray()); if (this.configStorage.getHttpProxyHost() != null && this.configStorage.getHttpProxyPort() > 0) { this.httpProxy = new HttpHost(this.configStorage.getHttpProxyHost(), this.configStorage.getHttpProxyPort()); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceOkHttpImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceOkHttpImpl.java index 63d5e95bae..c4dab9cf20 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceOkHttpImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpServiceOkHttpImpl.java @@ -108,12 +108,12 @@ public void initHttp() { OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder(); clientBuilder.proxy(getRequestHttpProxy().getProxy()); //设置授权 - clientBuilder.authenticator(new Authenticator() { + clientBuilder.proxyAuthenticator(new Authenticator() { @Override public Request authenticate(Route route, Response response) throws IOException { String credential = Credentials.basic(httpProxy.getProxyUsername(), httpProxy.getProxyPassword()); return response.request().newBuilder() - .header("Authorization", credential) + .header("Proxy-Authorization", credential) .build(); } }); diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java index b81760e72c..1b03f18c79 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/tp/service/impl/WxCpTpTagServiceImpl.java @@ -25,7 +25,7 @@ * * * @author zhangq+ * 查询投诉单列表API + * 商户可通过调用此接口,查询指定时间段的所有用户投诉信息,以分页输出查询结果。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaComplaintRequest} 查询投诉单列表请求数据 + * @return {@link WxMaComplaintResult} 微信返回的投诉单列表 + * @throws WxErrorException the wx error exception + */ + WxMaComplaintResult queryComplaints(WxMaComplaintRequest request) throws WxErrorException; + + /** + *
+ * 查询投诉单详情API + * 商户可通过调用此接口,查询指定投诉单的用户投诉详情,包含投诉内容、投诉关联订单、投诉人联系方式等信息,方便商户处理投诉。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaComplaintDetailRequest} 投诉单详情请求数据 + * @return {@link WxMaComplaintDetailResult} 微信返回的投诉单详情 + * @throws WxErrorException the wx error exception + */ + WxMaComplaintDetailResult getComplaint(WxMaComplaintDetailRequest request) throws WxErrorException; + + /** + *
+ * 查询投诉协商历史API + * 商户可通过调用此接口,查询指定投诉的用户商户协商历史,以分页输出查询结果,方便商户根据处理历史来制定后续处理方案。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaNegotiationHistoryRequest} 请求数据 + * @return {@link WxMaNegotiationHistoryResult} 微信返回结果 + * @throws WxErrorException the wx error exception + */ + WxMaNegotiationHistoryResult queryNegotiationHistorys(WxMaNegotiationHistoryRequest request) throws WxErrorException; + + /** + *
+ * 创建投诉通知回调地址API + * 商户通过调用此接口创建投诉通知回调URL,当用户产生新投诉且投诉状态已变更时,微信会通过回调URL通知商户。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaComplaintNotifyUrlRequest} 请求数据 + * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果 + * @throws WxErrorException the wx error exception + */ + WxMaComplaintNotifyUrlResult addComplaintNotifyUrl(WxMaComplaintNotifyUrlRequest request) throws WxErrorException; + + /** + *
+ * 查询投诉通知回调地址API + * 商户通过调用此接口查询投诉通知的回调URL。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果 + * @throws WxErrorException the wx error exception + */ + WxMaComplaintNotifyUrlResult getComplaintNotifyUrl() throws WxErrorException; + + /** + *
+ * 更新投诉通知回调地址API + * 商户通过调用此接口更新投诉通知的回调URL。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaComplaintNotifyUrlRequest} 请求数据 + * @return {@link WxMaComplaintNotifyUrlResult} 微信返回结果 + * @throws WxErrorException the wx error exception + */ + WxMaComplaintNotifyUrlResult updateComplaintNotifyUrl(WxMaComplaintNotifyUrlRequest request) throws WxErrorException; + + /** + *
+ * 删除投诉通知回调地址API + * 当商户不再需要推送通知时,可通过调用此接口删除投诉通知的回调URL,取消通知回调。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @throws WxErrorException the wx error exception + */ + void deleteComplaintNotifyUrl() throws WxErrorException; + + /** + *
+ * 提交回复API + * 商户可通过调用此接口,提交回复内容。其中上传图片凭证需首先调用商户上传反馈图片接口,得到图片id,再将id填入请求。 + * 回复可配置文字链,传入跳转链接文案和跳转链接字段,用户点击即可跳转对应页面 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaResponseRequest} 请求数据 + * @throws WxErrorException the wx error exception + */ + void submitResponse(WxMaResponseRequest request) throws WxErrorException; + + /** + *
+ * 反馈处理完成API + * 商户可通过调用此接口,反馈投诉单已处理完成。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param request {@link WxMaCompleteRequest} 请求数据 + * @throws WxErrorException the wx error exception + */ + void complete(WxMaCompleteRequest request) throws WxErrorException; + + /** + *
+ * 商户上传反馈图片API + * 商户可通过调用此接口上传反馈图片凭证,上传成功后可在提交回复时使用。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param imageFile 需要上传的图片文件 + * @return String 微信返回的媒体文件标识Id + * @throws WxErrorException the wx error exception + * @throws IOException IO异常 + */ + String uploadResponseImage(File imageFile) throws WxErrorException, IOException; + + /** + *
+ * 商户上传反馈图片API + * 商户可通过调用此接口上传反馈图片凭证,上传成功后可在提交回复时使用。 + * 文档详见: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ * + * @param inputStream 需要上传的图片文件流 + * @param fileName 需要上传的图片文件名 + * @return String 微信返回的媒体文件标识Id + * @throws WxErrorException the wx error exception + * @throws IOException IO异常 + */ + String uploadResponseImage(InputStream inputStream, String fileName) throws WxErrorException, IOException; +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaDeviceSubscribeService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaDeviceSubscribeService.java index f44f64e48d..b45bc058a6 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaDeviceSubscribeService.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaDeviceSubscribeService.java @@ -1,9 +1,10 @@ package cn.binarywang.wx.miniapp.api; -import cn.binarywang.wx.miniapp.bean.device.WxMaDeviceSubscribeMessageRequest; -import cn.binarywang.wx.miniapp.bean.device.WxMaDeviceTicketRequest; +import cn.binarywang.wx.miniapp.bean.device.*; import me.chanjar.weixin.common.error.WxErrorException; +import java.util.List; + /** * 小程序设备订阅消息相关 API * 文档: @@ -21,6 +22,7 @@ public interface WxMaDeviceSubscribeService { * 注意: * 设备ticket有效时间为5分钟 * + * * @param deviceTicketRequest * @return * @throws WxErrorException @@ -37,4 +39,53 @@ public interface WxMaDeviceSubscribeService { */ void sendDeviceSubscribeMsg(WxMaDeviceSubscribeMessageRequest deviceSubscribeMessageRequest) throws WxErrorException; + /** + *
+ * 创建设备组 + * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/createIotGroupId.html + *+ * + * @param createIotGroupIdRequest 请求参数 + * @return 设备组的唯一标识 + * @throws WxErrorException + */ + String createIotGroupId(WxMaCreateIotGroupIdRequest createIotGroupIdRequest) throws WxErrorException; + + /** + *
+ * 查询设备组信息 + * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/getIotGroupInfo.html + *+ * + * @param getIotGroupInfoRequest 请求参数 + * @return 设备组信息 + * @throws WxErrorException + */ + WxMaIotGroupDeviceInfoResponse getIotGroupInfo(WxMaGetIotGroupInfoRequest getIotGroupInfoRequest) throws WxErrorException; + + /** + *
+ * 设备组添加设备 + * 一个设备组最多添加 50 个设备。 一个设备同一时间只能被添加到一个设备组中。 + * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/addIotGroupDevice.html + *+ * + * @param request 请求参数 + * @return 成功添加的设备信息 + * @throws WxErrorException + */ + List
+ * 设备组删除设备 + * 详情请见:https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/hardware-device/removeIotGroupDevice.html + *+ * + * @param request 请求参数 + * @return 成功删除的设备信息 + * @throws WxErrorException + */ + List
+ * 文档地址:用工关系简介 + *
+ * + * @author Binary Wang + * created on 2025-12-19 + */ +public interface WxMaEmployeeRelationService { + + /** + * 解绑用工关系 + *+ * 企业可以调用该接口解除和用户的B2C用工关系 + *
+ * 文档地址:解绑用工关系 + * + * @param request 解绑请求参数 + * @throws WxErrorException 调用微信接口失败时抛出 + */ + void unbindEmployee(WxMaUnbindEmployeeRequest request) throws WxErrorException; + + /** + * 推送用工消息 + *+ * 企业可以调用该接口向用户推送用工相关消息 + *
+ * 文档地址:推送用工消息 + * + * @param request 推送消息请求参数 + * @throws WxErrorException 调用微信接口失败时抛出 + */ + void sendEmployeeMsg(WxMaSendEmployeeMsgRequest request) throws WxErrorException; +} diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java new file mode 100644 index 0000000000..b8b5a03809 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaKefuService.java @@ -0,0 +1,128 @@ +package cn.binarywang.wx.miniapp.api; + +import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfInfo; +import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfList; +import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfSession; +import cn.binarywang.wx.miniapp.bean.kefu.WxMaKfSessionList; +import cn.binarywang.wx.miniapp.bean.kefu.request.WxMaKfAccountRequest; +import me.chanjar.weixin.common.error.WxErrorException; + +/** + *+ * 小程序客服管理接口. + * 不同于 WxMaCustomserviceWorkService (企业微信客服绑定) 和 WxMaMsgService.sendKefuMsg (发送客服消息), + * 此接口专门处理小程序客服账号管理、会话管理等功能。 + * + * 注意:小程序客服管理接口与公众号客服管理接口在API端点和功能上有所不同。 + *+ * + * @author Binary Wang + */ +public interface WxMaKefuService { + + /** + *
+ * 获取客服基本信息 + * 详情请见:获取客服基本信息 + * 接口url格式:https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN + *+ * + * @return 客服列表 + * @throws WxErrorException 异常 + */ + WxMaKfList kfList() throws WxErrorException; + + /** + *
+ * 添加客服账号 + * 详情请见:添加客服账号 + * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN + *+ * + * @param request 客服账号信息 + * @return 是否成功 + * @throws WxErrorException 异常 + */ + boolean kfAccountAdd(WxMaKfAccountRequest request) throws WxErrorException; + + /** + *
+ * 修改客服账号 + * 详情请见:修改客服账号 + * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN + *+ * + * @param request 客服账号信息 + * @return 是否成功 + * @throws WxErrorException 异常 + */ + boolean kfAccountUpdate(WxMaKfAccountRequest request) throws WxErrorException; + + /** + *
+ * 删除客服账号 + * 详情请见:删除客服账号 + * 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT + *+ * + * @param kfAccount 客服账号 + * @return 是否成功 + * @throws WxErrorException 异常 + */ + boolean kfAccountDel(String kfAccount) throws WxErrorException; + + /** + *
+ * 创建会话 + * 详情请见:创建会话 + * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/create?access_token=ACCESS_TOKEN + *+ * + * @param openid 用户openid + * @param kfAccount 客服账号 + * @return 是否成功 + * @throws WxErrorException 异常 + */ + boolean kfSessionCreate(String openid, String kfAccount) throws WxErrorException; + + /** + *
+ * 关闭会话 + * 详情请见:关闭会话 + * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/close?access_token=ACCESS_TOKEN + *+ * + * @param openid 用户openid + * @param kfAccount 客服账号 + * @return 是否成功 + * @throws WxErrorException 异常 + */ + boolean kfSessionClose(String openid, String kfAccount) throws WxErrorException; + + /** + *
+ * 获取客户的会话状态 + * 详情请见:获取客户的会话状态 + * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID + *+ * + * @param openid 用户openid + * @return 会话信息 + * @throws WxErrorException 异常 + */ + WxMaKfSession kfSessionGet(String openid) throws WxErrorException; + + /** + *
+ * 获取客服的会话列表 + * 详情请见:获取客服的会话列表 + * 接口url格式:https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT + *+ * + * @param kfAccount 客服账号 + * @return 会话列表 + * @throws WxErrorException 异常 + */ + WxMaKfSessionList kfSessionList(String kfAccount) throws WxErrorException; + +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java index ef3a46bad9..dc7425fa6e 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaService.java @@ -285,6 +285,13 @@ WxMaApiResponse execute( */ WxMaCustomserviceWorkService getCustomserviceWorkService(); + /** + * 获取小程序客服管理服务。 + * + * @return 客服管理服务对象WxMaKefuService + */ + WxMaKefuService getKefuService(); + /** * 获取jsapi操作相关服务对象。 * @@ -605,4 +612,22 @@ WxMaApiResponse execute( * @return 同城配送服务对象WxMaIntracityService */ WxMaIntracityService getIntracityService(); + + /** + * 获取交易投诉服务对象。 + *
+ * 通过 code 换取用户登录态信息,用于多端登录场景(如手表端)。 + *
+ * 文档地址:多端登录 + * + * @param code 登录时获取的 code + * @param checkcode 手表授权页面返回的 checkcode + * @return 登录验证结果,包含 session_key、openid、unionid 和 is_limit 字段 + * @throws WxErrorException 调用微信接口失败时抛出 + */ + WxMaCode2VerifyInfoResult getCode2VerifyInfo(String code, String checkcode) throws WxErrorException; } diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java index a633c93de6..68d4dc0c97 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaXPayService.java @@ -71,6 +71,16 @@ public interface WxMaXPayService { */ WxMaXPayPresentCurrencyResponse presentCurrency(WxMaXPayPresentCurrencyRequest request, WxMaXPaySigParams sigParams) throws WxErrorException; + /** + * 道具直购。 + * + * @param request 道具直购请求对象 + * @param sigParams 签名参数对象 + * @return 道具直购结果 + * @throws WxErrorException 直购失败时抛出 + */ + WxMaXPayPresentGoodsResponse presentGoods(WxMaXPayPresentGoodsRequest request, WxMaXPaySigParams sigParams) throws WxErrorException; + /** * 下载对账单。 * diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java index ec33dede0c..c0e1ff4a4e 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/impl/BaseWxMaServiceImpl.java @@ -113,6 +113,7 @@ public abstract class BaseWxMaServiceImpl
+ * 多端登录验证接口的响应
+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/miniapp/openapi/code2Verifyinfo.html
+ *
+ * 微信返回报文:{"errcode": 0, "errmsg": "ok", "session_key":"xxx", "openid":"xxx", "unionid":"xxx", "is_limit": false}
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@EqualsAndHashCode(callSuper = false)
+public class WxMaCode2VerifyInfoResult implements Serializable {
+ private static final long serialVersionUID = -2468325025088437364L;
+
+ @SerializedName("session_key")
+ private String sessionKey;
+
+ @SerializedName("openid")
+ private String openid;
+
+ @SerializedName("unionid")
+ private String unionid;
+
+ /**
+ * 是否为受限用户
+ */
+ @SerializedName("is_limit")
+ private Boolean isLimit;
+
+ public static WxMaCode2VerifyInfoResult fromJson(String json) {
+ return WxMaGsonBuilder.create().fromJson(json, WxMaCode2VerifyInfoResult.class);
+ }
+
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaGroupEnterInfo.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaGroupEnterInfo.java
new file mode 100644
index 0000000000..e65ec602da
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaGroupEnterInfo.java
@@ -0,0 +1,46 @@
+package cn.binarywang.wx.miniapp.bean;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+
+import java.io.Serializable;
+
+/**
+ * 微信小程序群入口信息.
+ * 对应 wx.getGroupEnterInfo 接口返回的解密数据
+ *
+ * @see wx.getGroupEnterInfo 官方文档
+ */
+@Data
+public class WxMaGroupEnterInfo implements Serializable {
+ private static final long serialVersionUID = -8053613683499632227L;
+
+ /**
+ * 多聊群下返回的群唯一标识.
+ */
+ @SerializedName("opengid")
+ private String openGId;
+
+ /**
+ * 单聊群下返回的群唯一标识.
+ */
+ @SerializedName("open_single_roomid")
+ private String openSingleRoomid;
+
+ /**
+ * 用户在当前群的唯一标识.
+ */
+ @SerializedName("group_openid")
+ private String groupOpenid;
+
+ /**
+ * 聊天室类型.
+ */
+ @SerializedName("chat_type")
+ private Integer chatType;
+
+ public static WxMaGroupEnterInfo fromJson(String json) {
+ return WxMaGsonBuilder.create().fromJson(json, WxMaGroupEnterInfo.class);
+ }
+}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaKefuMessage.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaKefuMessage.java
index 0cd77c7937..cdce681175 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaKefuMessage.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaKefuMessage.java
@@ -40,6 +40,9 @@ public class WxMaKefuMessage implements Serializable {
@SerializedName("miniprogrampage")
private KfMaPage maPage;
+ @SerializedName("aimsgcontext")
+ private AiMsgContext aiMsgContext;
+
@Data
@AllArgsConstructor
@NoArgsConstructor
@@ -90,6 +93,16 @@ public static class KfMaPage implements Serializable {
private String thumbMediaId;
}
+ @Data
+ @AllArgsConstructor
+ @NoArgsConstructor
+ public static class AiMsgContext implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ @SerializedName("msgid")
+ private String msgId;
+ }
+
/**
* 获得文本消息builder.
*/
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaMessage.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaMessage.java
index d95882a240..88450403e3 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaMessage.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/WxMaMessage.java
@@ -257,6 +257,62 @@ public class WxMaMessage implements Serializable {
*/
private String context;
+ /**
+ * 微信支付订单号
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+ /**
+ * 商户号
+ */
+ @XStreamAlias("merchant_id")
+ private String merchantId;
+ /**
+ * 子商户号
+ */
+ @XStreamAlias("sub_merchant_id")
+ private String subMerchantId;
+ /**
+ * 商户订单号
+ */
+ @XStreamAlias("merchant_trade_no")
+ private String merchantTradeNo;
+ /**
+ * 支付成功时间,秒级时间戳
+ */
+ @XStreamAlias("pay_time")
+ private Long payTime;
+ /**
+ * 消息文本内容
+ */
+ @XStreamAlias("msg")
+ private String msg;
+ /**
+ * 发货时间,秒级时间戳
+ */
+ @XStreamAlias("shipped_time")
+ private Long shippedTime;
+ /**
+ * 预计结算时间,秒级时间戳。发货时推送才有该字段
+ */
+ @XStreamAlias("estimated_settlement_time")
+ private Long estimatedSettlementTime;
+ /**
+ * 确认收货方式:1. 手动确认收货;2. 自动确认收货。结算时推送才有该字段
+ */
+ @XStreamAlias("confirm_receive_method")
+ private Integer confirmReceiveMethod;
+ /**
+ * 确认收货时间,秒级时间戳。结算时推送才有该字段
+ */
+ @XStreamAlias("confirm_receive_time")
+ private Long confirmReceiveTime;
+ /**
+ * 订单结算时间,秒级时间戳。结算时推送才有该字段
+ */
+ @XStreamAlias("settlement_time")
+ private Long settlementTime;
+
/**
* 不要直接使用这个字段,
* 这个字段只是为了适配 SubscribeMsgPopupEvent SubscribeMsgChangeEvent SubscribeMsgSentEvent
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailRequest.java
new file mode 100644
index 0000000000..759f7392bf
--- /dev/null
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailRequest.java
@@ -0,0 +1,38 @@
+package cn.binarywang.wx.miniapp.bean.complaint;
+
+import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 小程序投诉单详情请求实体
+ *
+ * @author Binary Wang
+ * created on 2025-01-01
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class WxMaComplaintDetailRequest implements Serializable {
+ private static final long serialVersionUID = 3244929701614280806L;
+
+ /**
+ * + * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java new file mode 100644 index 0000000000..52a0be1704 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintDetailResult.java @@ -0,0 +1,166 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse; +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.EqualsAndHashCode; + +import java.io.Serializable; +import java.util.List; + +/** + * 小程序投诉单详情结果 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@EqualsAndHashCode(callSuper = true) +public class WxMaComplaintDetailResult extends WxMaBaseResponse { + + /** + *
+ * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + /** + *
+ * 字段名:投诉时间 + * 是否必填:是 + * 描述:用户提交投诉的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE + *+ */ + @SerializedName("complaint_time") + private String complaintTime; + + /** + *
+ * 字段名:投诉详情 + * 是否必填:是 + * 描述:用户提交的投诉详情 + *+ */ + @SerializedName("complaint_detail") + private String complaintDetail; + + /** + *
+ * 字段名:投诉状态 + * 是否必填:是 + * 描述:投诉单状态:WAITING_MERCHANT_RESPONSE-等待商户回复 MERCHANT_RESPONSED-商户已回复 WAITING_USER_RESPONSE-等待用户回复 USER_RESPONSED-用户已回复 COMPLAINT_COMPLETED-投诉已完成 + *+ */ + @SerializedName("complaint_state") + private String complaintState; + + /** + *
+ * 字段名:投诉人openid + * 是否必填:是 + * 描述:投诉人在小程序的openid + *+ */ + @SerializedName("openid") + private String openid; + + /** + *
+ * 字段名:投诉人联系方式 + * 是否必填:否 + * 描述:投诉人联系方式,可能为空 + *+ */ + @SerializedName("phone_number") + private String phoneNumber; + + /** + *
+ * 字段名:被投诉订单信息 + * 是否必填:是 + * 描述:被投诉的订单信息 + *+ */ + @SerializedName("complaint_order_info") + private ComplaintOrderInfo complaintOrderInfo; + + /** + *
+ * 字段名:投诉材料 + * 是否必填:否 + * 描述:用户上传的投诉相关的图片凭证 + *+ */ + @SerializedName("complaint_media_list") + private List
+ * 字段名:商户订单号 + * 是否必填:是 + * 描述:商户系统内部订单号 + *+ */ + @SerializedName("transaction_id") + private String transactionId; + + /** + *
+ * 字段名:微信订单号 + * 是否必填:是 + * 描述:微信支付系统生成的订单号 + *+ */ + @SerializedName("out_trade_no") + private String outTradeNo; + + /** + *
+ * 字段名:订单金额 + * 是否必填:是 + * 描述:订单金额,单位为分 + *+ */ + @SerializedName("amount") + private Integer amount; + } + + /** + * 投诉材料 + */ + @Data + public static class ComplaintMedia implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:媒体文件业务类型 + * 是否必填:是 + * 描述:媒体文件对应的业务类型:USER_COMPLAINT_IMAGE-用户投诉图片 + *+ */ + @SerializedName("media_type") + private String mediaType; + + /** + *
+ * 字段名:媒体文件请求URL + * 是否必填:是 + * 描述:微信返回的媒体文件请求URL,通过该URL可以获取到对应的媒体文件(图片、视频等) + *+ */ + @SerializedName("media_url") + private String mediaUrl; + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java new file mode 100644 index 0000000000..6af338c974 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlRequest.java @@ -0,0 +1,38 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序投诉通知回调URL请求实体 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaComplaintNotifyUrlRequest implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:通知地址 + * 是否必填:是 + * 描述:通知地址,仅支持https + *+ */ + @SerializedName("url") + private String url; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java new file mode 100644 index 0000000000..7771998b80 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintNotifyUrlResult.java @@ -0,0 +1,37 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse; +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.EqualsAndHashCode; + +/** + * 小程序投诉通知回调URL结果 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@EqualsAndHashCode(callSuper = true) +public class WxMaComplaintNotifyUrlResult extends WxMaBaseResponse { + + /** + *
+ * 字段名:通知地址 + * 是否必填:是 + * 描述:通知地址,仅支持https + *+ */ + @SerializedName("url") + private String url; + + /** + *
+ * 字段名:签名串 + * 是否必填:是 + * 描述:用于验证通知消息的签名串 + *+ */ + @SerializedName("signature") + private String signature; +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java new file mode 100644 index 0000000000..9ac45e0c12 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintRequest.java @@ -0,0 +1,70 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序交易投诉查询请求实体 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaComplaintRequest implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:开始日期 + * 是否必填:是 + * 描述:查询的起始时间,格式为YYYY-MM-DD,例如2021-01-01 + *+ */ + @SerializedName("begin_date") + private String beginDate; + + /** + *
+ * 字段名:结束日期 + * 是否必填:是 + * 描述:查询的结束时间,格式为YYYY-MM-DD,例如2021-01-31 + *+ */ + @SerializedName("end_date") + private String endDate; + + /** + *
+ * 字段名:分页大小 + * 是否必填:否 + * 描述:单次拉取条目,最大为50,不传默认为10 + *+ */ + @SerializedName("limit") + @Builder.Default + private Integer limit = 10; + + /** + *
+ * 字段名:分页开始位置 + * 是否必填:否 + * 描述:该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回,不传默认为0 + *+ */ + @SerializedName("offset") + @Builder.Default + private Integer offset = 0; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java new file mode 100644 index 0000000000..0e4208fdc1 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaComplaintResult.java @@ -0,0 +1,156 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse; +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.EqualsAndHashCode; + +import java.io.Serializable; +import java.util.List; + +/** + * 小程序交易投诉查询结果 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@EqualsAndHashCode(callSuper = true) +public class WxMaComplaintResult extends WxMaBaseResponse { + + /** + *
+ * 字段名:投诉单信息 + * 是否必填:是 + * 描述:查询返回的投诉单信息 + *+ */ + @SerializedName("data") + private List
+ * 字段名:总数 + * 是否必填:是 + * 描述:总投诉单条数,用于分页展示 + *+ */ + @SerializedName("total_count") + private Integer totalCount; + + /** + * 投诉单信息 + */ + @Data + public static class Complaint implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + /** + *
+ * 字段名:投诉时间 + * 是否必填:是 + * 描述:用户提交投诉的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE + *+ */ + @SerializedName("complaint_time") + private String complaintTime; + + /** + *
+ * 字段名:投诉详情 + * 是否必填:是 + * 描述:用户提交的投诉详情 + *+ */ + @SerializedName("complaint_detail") + private String complaintDetail; + + /** + *
+ * 字段名:投诉状态 + * 是否必填:是 + * 描述:投诉单状态:WAITING_MERCHANT_RESPONSE-等待商户回复 MERCHANT_RESPONSED-商户已回复 WAITING_USER_RESPONSE-等待用户回复 USER_RESPONSED-用户已回复 COMPLAINT_COMPLETED-投诉已完成 + *+ */ + @SerializedName("complaint_state") + private String complaintState; + + /** + *
+ * 字段名:投诉人openid + * 是否必填:是 + * 描述:投诉人在小程序的openid + *+ */ + @SerializedName("openid") + private String openid; + + /** + *
+ * 字段名:投诉人联系方式 + * 是否必填:否 + * 描述:投诉人联系方式,可能为空 + *+ */ + @SerializedName("phone_number") + private String phoneNumber; + + /** + *
+ * 字段名:被投诉订单信息 + * 是否必填:是 + * 描述:被投诉的订单信息 + *+ */ + @SerializedName("complaint_order_info") + private ComplaintOrderInfo complaintOrderInfo; + } + + /** + * 被投诉订单信息 + */ + @Data + public static class ComplaintOrderInfo implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:商户订单号 + * 是否必填:是 + * 描述:商户系统内部订单号 + *+ */ + @SerializedName("transaction_id") + private String transactionId; + + /** + *
+ * 字段名:微信订单号 + * 是否必填:是 + * 描述:微信支付系统生成的订单号 + *+ */ + @SerializedName("out_trade_no") + private String outTradeNo; + + /** + *
+ * 字段名:订单金额 + * 是否必填:是 + * 描述:订单金额,单位为分 + *+ */ + @SerializedName("amount") + private Integer amount; + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java new file mode 100644 index 0000000000..71d1066024 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaCompleteRequest.java @@ -0,0 +1,38 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序反馈处理完成请求实体 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaCompleteRequest implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java new file mode 100644 index 0000000000..a03742b6af --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryRequest.java @@ -0,0 +1,60 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序查询投诉协商历史请求实体 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaNegotiationHistoryRequest implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + /** + *
+ * 字段名:分页大小 + * 是否必填:否 + * 描述:单次拉取条目,最大为50,不传默认为10 + *+ */ + @SerializedName("limit") + @Builder.Default + private Integer limit = 10; + + /** + *
+ * 字段名:分页开始位置 + * 是否必填:否 + * 描述:该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回,不传默认为0 + *+ */ + @SerializedName("offset") + @Builder.Default + private Integer offset = 0; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java new file mode 100644 index 0000000000..194daca9ff --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/complaint/WxMaNegotiationHistoryResult.java @@ -0,0 +1,88 @@ +package cn.binarywang.wx.miniapp.bean.complaint; + +import cn.binarywang.wx.miniapp.bean.WxMaBaseResponse; +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.EqualsAndHashCode; + +import java.io.Serializable; +import java.util.List; + +/** + * 小程序查询投诉协商历史结果 + * + * @author Binary Wang + * created on 2025-01-01 + */ +@Data +@EqualsAndHashCode(callSuper = true) +public class WxMaNegotiationHistoryResult extends WxMaBaseResponse { + + /** + *
+ * 字段名:协商历史 + * 是否必填:是 + * 描述:协商历史记录 + *+ */ + @SerializedName("data") + private List
+ * 字段名:总数 + * 是否必填:是 + * 描述:总协商历史条数,用于分页展示 + *+ */ + @SerializedName("total_count") + private Integer totalCount; + + /** + * 协商历史 + */ + @Data + public static class NegotiationHistory implements Serializable { + private static final long serialVersionUID = 3244929701614280806L; + + /** + *
+ * 字段名:操作时间 + * 是否必填:是 + * 描述:操作时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE + *+ */ + @SerializedName("operate_time") + private String operateTime; + + /** + *
+ * 字段名:操作类型 + * 是否必填:是 + * 描述:操作类型:USER_CREATE_COMPLAINT-用户提交投诉 USER_CONTINUE_COMPLAINT-用户继续投诉 MERCHANT_RESPONSE-商户回复 MERCHANT_CONFIRM_COMPLETE-商户确认完成处理 + *+ */ + @SerializedName("operate_type") + private String operateType; + + /** + *
+ * 字段名:操作内容 + * 是否必填:是 + * 描述:具体的操作内容 + *+ */ + @SerializedName("operate_details") + private String operateDetails; + + /** + *
+ * 字段名:图片凭证 + * 是否必填:否 + * 描述:操作过程中上传的图片凭证 + *+ */ + @SerializedName("image_list") + private List
+ * 字段名:投诉单号 + * 是否必填:是 + * 描述:投诉单对应的投诉单号 + *+ */ + @SerializedName("complaint_id") + private String complaintId; + + /** + *
+ * 字段名:回复内容 + * 是否必填:是 + * 描述:具体的回复内容,长度不超过200字符 + *+ */ + @SerializedName("response_content") + private String responseContent; + + /** + *
+ * 字段名:回复图片 + * 是否必填:否 + * 描述:回复的图片凭证,最多可传5张图片,由图片上传接口返回 + *+ */ + @SerializedName("response_images") + private List
+ * 字段名:跳转链接 + * 是否必填:否 + * 描述:点击跳转链接 + *+ */ + @SerializedName("jump_url") + private String jumpUrl; + + /** + *
+ * 字段名:跳转链接文案 + * 是否必填:否 + * 描述:跳转链接文案,在response_content中展示的跳转链接文案,长度不超过10个字符 + *+ */ + @SerializedName("jump_url_text") + private String jumpUrlText; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java new file mode 100644 index 0000000000..20a0a146ae --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaCreateIotGroupIdRequest.java @@ -0,0 +1,38 @@ +package cn.binarywang.wx.miniapp.bean.device; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * @Author: yanglegetuo + * @Date: 2025/12/22 8:51 + * @Description: 创建设备组 请求参数 + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class WxMaCreateIotGroupIdRequest implements Serializable { + private static final long serialVersionUID = 1827809470414413390L; + /** + * 设备型号id。通过注册设备获得(必填) + */ + @SerializedName("model_id") + private String modelId; + /** + * 设备组的名称(创建时决定,无法修改) + */ + @SerializedName("group_name") + private String groupName; + + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java new file mode 100644 index 0000000000..47ebc2be44 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaGetIotGroupInfoRequest.java @@ -0,0 +1,33 @@ +package cn.binarywang.wx.miniapp.bean.device; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * @Author: yanglegetuo + * @Date: 2025/12/22 8:51 + * @Description: 查询设备组信息 请求参数 + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class WxMaGetIotGroupInfoRequest implements Serializable { + + private static final long serialVersionUID = 4913375114243384968L; + /** + * 设备组的唯一标识(必填) + */ + @SerializedName("group_id") + private String groupId; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java new file mode 100644 index 0000000000..e7bd92edf8 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/device/WxMaIotGroupDeviceInfoResponse.java @@ -0,0 +1,51 @@ +package cn.binarywang.wx.miniapp.bean.device; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; +import java.util.List; + +/** + * @Author: yanglegetuo + * @Date: 2025/12/22 8:51 + * @Description: 设备组信息 响应参数 + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class WxMaIotGroupDeviceInfoResponse implements Serializable { + + private static final long serialVersionUID = 6615660801230308048L; + /** + * 设备组名称 + */ + @SerializedName("group_name") + private String groupName; + /** + * 设备列表 + */ + @SerializedName("device_list") + private List
+ * 文档地址:推送用工消息 + *
+ * + * @author Binary Wang + * created on 2025-12-19 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaSendEmployeeMsgRequest implements Serializable { + private static final long serialVersionUID = 1L; + + /** + *+ * 字段名:用户openid + * 是否必填:是 + * 描述:需要接收消息的用户openid + *+ */ + @SerializedName("openid") + private String openid; + + /** + *
+ * 字段名:企业id + * 是否必填:是 + * 描述:企业id,小程序管理员在微信开放平台配置 + *+ */ + @SerializedName("corp_id") + private String corpId; + + /** + *
+ * 字段名:消息内容 + * 是否必填:是 + * 描述:推送的消息内容,文本格式,最长不超过200个字符 + *+ */ + @SerializedName("msg") + private String msg; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java new file mode 100644 index 0000000000..e56d84670c --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/employee/WxMaUnbindEmployeeRequest.java @@ -0,0 +1,51 @@ +package cn.binarywang.wx.miniapp.bean.employee; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序解绑用工关系请求实体 + *
+ * 文档地址:解绑用工关系 + *
+ * + * @author Binary Wang + * created on 2025-12-19 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class WxMaUnbindEmployeeRequest implements Serializable { + private static final long serialVersionUID = 1L; + + /** + *+ * 字段名:用户openid + * 是否必填:是 + * 描述:需要解绑的用户openid + *+ */ + @SerializedName("openid") + private String openid; + + /** + *
+ * 字段名:企业id + * 是否必填:是 + * 描述:企业id,小程序管理员在微信开放平台配置 + *+ */ + @SerializedName("corp_id") + private String corpId; + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/express/request/WxMaExpressOrderCargo.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/express/request/WxMaExpressOrderCargo.java index 96817a2256..b6de21b9e6 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/express/request/WxMaExpressOrderCargo.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/express/request/WxMaExpressOrderCargo.java @@ -34,7 +34,7 @@ public class WxMaExpressOrderCargo implements Serializable { * 描述: 单位是千克(kg) * */ - private Integer weight; + private Double weight; /** * 包裹长度 @@ -44,7 +44,7 @@ public class WxMaExpressOrderCargo implements Serializable { * */ @SerializedName("space_x") - private Integer spaceLength; + private Double spaceLength; /** * 包裹宽度 @@ -54,7 +54,7 @@ public class WxMaExpressOrderCargo implements Serializable { * */ @SerializedName("space_y") - private Integer spaceWidth; + private Double spaceWidth; /** * 包裹高度 @@ -64,7 +64,7 @@ public class WxMaExpressOrderCargo implements Serializable { * */ @SerializedName("space_z") - private Integer spaceHeight; + private Double spaceHeight; /** * 包裹中商品详情列表 diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfInfo.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfInfo.java new file mode 100644 index 0000000000..476056d518 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfInfo.java @@ -0,0 +1,79 @@ +package cn.binarywang.wx.miniapp.bean.kefu; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 小程序客服信息. + * + * @author Binary Wang + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class WxMaKfInfo implements Serializable { + private static final long serialVersionUID = -7916302137791763175L; + + /** + * 客服账号. + */ + @SerializedName("kf_account") + private String kfAccount; + + /** + * 客服昵称. + */ + @SerializedName("kf_nick") + private String kfNick; + + /** + * 客服密码. + */ + @SerializedName("kf_id") + private String kfId; + + /** + * 客服头像. + */ + @SerializedName("kf_headimgurl") + private String kfHeadImgUrl; + + /** + * 如果客服帐号已绑定了客服人员微信号,则此处显示微信号. + */ + @SerializedName("kf_wx") + private String kfWx; + + /** + * 如果客服帐号尚未绑定微信号,但是已经发起了一个绑定邀请,则此处显示绑定邀请的微信号. + */ + @SerializedName("invite_wx") + private String inviteWx; + + /** + * 邀请的状态,有等待确认"waiting",被拒绝"rejected",过期"expired". + */ + @SerializedName("invite_expire_time") + private Long inviteExpireTime; + + /** + * 邀请的过期时间,为unix时间戳. + */ + @SerializedName("invite_status") + private String inviteStatus; + + public static WxMaKfInfo fromJson(String json) { + return WxMaGsonBuilder.create().fromJson(json, WxMaKfInfo.class); + } + + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfList.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfList.java new file mode 100644 index 0000000000..8dd87a1728 --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/bean/kefu/WxMaKfList.java @@ -0,0 +1,35 @@ +package cn.binarywang.wx.miniapp.bean.kefu; + +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; +import java.util.List; + +/** + * 小程序客服列表. + * + * @author Binary Wang + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class WxMaKfList implements Serializable { + private static final long serialVersionUID = 6416633293297389972L; + + @SerializedName("kf_list") + private List
* {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setRetrySleepMillis(int)}
*
+ *
+ * @return 重试间隔,单位:毫秒
*/
int getRetrySleepMillis();
/**
- * http 请求最大重试次数
+ * HTTP 请求最大重试次数
*
*
* {@link cn.binarywang.wx.miniapp.api.impl.BaseWxMaServiceImpl#setMaxRetryTimes(int)}
*
+ *
+ * @return 最大重试次数
*/
int getMaxRetryTimes();
/**
- * http client builder
+ * 获取用于创建 HTTP 客户端的 ApacheHttpClientBuilder
*
- * @return ApacheHttpClientBuilder apache http client builder
+ * @return ApacheHttpClientBuilder 实例
*/
ApacheHttpClientBuilder getApacheHttpClientBuilder();
/**
- * 是否自动刷新token
+ * 是否在 token 失效时自动刷新
*
- * @return the boolean
+ * @return 如果自动刷新则返回 true,否则返回 false
*/
boolean autoRefreshToken();
/**
- * 设置自定义的apiHost地址
- * 具体取值,可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
+ * 设置自定义的 apiHost 地址
+ * 具体取值,可以参考 API 域名文档
*
- * @param apiHostUrl api域名地址
+ * @param apiHostUrl api 域名地址
*/
void setApiHostUrl(String apiHostUrl);
/**
- * 获取自定义的apiHost地址,用于替换原请求中的https://api.weixin.qq.com
- * 具体取值,可以参考https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Interface_field_description.html
+ * 获取自定义的 apiHost 地址,用于替换原请求中的 https://api.weixin.qq.com
+ * 具体取值,可以参考 API 域名文档
*
- * @return 自定义的api域名地址
+ * @return 自定义的 api 域名地址
*/
String getApiHostUrl();
/**
- * 获取自定义的获取accessToken地址,用于向自定义统一服务获取accessToken
+ * 获取自定义的获取 accessToken 地址,用于向自定义统一服务获取 accessToken
*
- * @return 自定义的获取accessToken地址
+ * @return 自定义的获取 accessToken 地址
*/
String getAccessTokenUrl();
/**
- * 设置自定义的获取accessToken地址 可用于设置获取accessToken的自定义服务
+ * 设置自定义的获取 accessToken 地址,可用于设置获取 accessToken 的自定义服务
*
- * @param accessTokenUrl 自定义的获取accessToken地址
+ * @param accessTokenUrl 自定义的获取 accessToken 地址
*/
void setAccessTokenUrl(String accessTokenUrl);
/**
- * 服务端API签名用到的RSA私钥【pkcs8格式,会以 -----BEGIN PRIVATE KEY-----开头, 'BEGIN RSA PRIVATE
- * KEY'的是pkcs1格式,需要转换(可用openssl转换)。 设置参考:
- * https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
+ * 服务端 API 签名用到的 RSA 私钥(pkcs8 格式,会以 -----BEGIN PRIVATE KEY----- 开头,
+ * 'BEGIN RSA PRIVATE KEY' 的是 pkcs1 格式,需要转换(可用 openssl 转换)。设置参考:
+ * API 签名文档
*
- * @return rsa private key string
+ * @return RSA 私钥字符串(pkcs8 格式)
*/
String getApiSignatureRsaPrivateKey();
/**
- * 服务端API签名用到的AES密钥
- * https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/getting_started/api_signature.html
+ * 服务端 API 签名用到的 AES 密钥
+ * API 签名文档
*
- * @return aes key string
+ * @return AES 密钥字符串
*/
String getApiSignatureAesKey();
@@ -307,6 +343,52 @@ default void updateAccessTokenBefore(WxAccessTokenEntity wxAccessTokenEntity) {}
/** 密钥对应的序号 */
String getApiSignatureRsaPrivateKeySn();
- /** 密钥对应的小程序ID (普通小程序同 appId, 托管第三方平台的是 componentAppId) */
+ /** 密钥对应的小程序 ID(普通小程序为 appId,托管第三方平台为 componentAppId) */
String getWechatMpAppid();
+
+ /** 微信 API 默认主机地址 */
+ String DEFAULT_API_HOST_URL = "https://api.weixin.qq.com";
+ /** 微信云托管使用的 HTTP 协议主机地址 */
+ String CLOUD_RUN_API_HOST_URL = "http://api.weixin.qq.com";
+
+ /**
+ * 是否使用微信云托管内网模式
+ * 当部署在微信云托管环境时,api.weixin.qq.com 会被解析为内网地址,此时需要使用 HTTP 协议访问
+ * 开启此配置后,SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
+ *
+ * @see 微信云托管内网调用微信接口
+ * @return 是否使用微信云托管模式
+ */
+ default boolean isUseWxCloudRun() {
+ return false;
+ }
+
+ /**
+ * 设置是否使用微信云托管内网模式
+ * 当部署在微信云托管环境时,api.weixin.qq.com 会被解析为内网地址,此时需要使用 HTTP 协议访问
+ * 开启此配置后,SDK 会自动将 https://api.weixin.qq.com 替换为 http://api.weixin.qq.com
+ *
+ * @see 微信云托管内网调用微信接口
+ * @param useWxCloudRun 是否使用微信云托管模式
+ */
+ default void setUseWxCloudRun(boolean useWxCloudRun) {
+ // 默认空实现
+ }
+
+ /**
+ * 根据配置获取实际应使用的 API 主机地址
+ * 优先级:自定义 apiHostUrl > 微信云托管模式 > 默认 HTTPS 地址
+ *
+ * @return 实际应使用的 API 主机地址
+ */
+ default String getEffectiveApiHostUrl() {
+ String apiHostUrl = getApiHostUrl();
+ if (apiHostUrl != null && !apiHostUrl.isEmpty()) {
+ return apiHostUrl;
+ }
+ if (isUseWxCloudRun()) {
+ return CLOUD_RUN_API_HOST_URL;
+ }
+ return DEFAULT_API_HOST_URL;
+ }
}
diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/config/impl/WxMaDefaultConfigImpl.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/config/impl/WxMaDefaultConfigImpl.java
index ab82d6209e..07dfaefcc9 100644
--- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/config/impl/WxMaDefaultConfigImpl.java
+++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/config/impl/WxMaDefaultConfigImpl.java
@@ -69,6 +69,10 @@ public class WxMaDefaultConfigImpl implements WxMaConfig {
private String apiHostUrl;
private String accessTokenUrl;
+ /** 是否使用微信云托管模式(使用 HTTP 协议访问内网地址) */
+ @Getter(AccessLevel.NONE)
+ private boolean useWxCloudRun = false;
+
/** 自定义配置token的消费者 */
@Setter private Consumer+ * 文档地址:https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/guarantee/complaint.html + *+ */ + public interface Complaint { + /** 查询投诉单列表 */ + String QUERY_COMPLAINTS_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/list"; + /** 查询投诉单详情 */ + String GET_COMPLAINT_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/detail"; + /** 查询投诉协商历史 */ + String QUERY_NEGOTIATION_HISTORY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/negotiation/history"; + /** 创建投诉通知回调地址 */ + String ADD_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/add"; + /** 查询投诉通知回调地址 */ + String GET_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/get"; + /** 更新投诉通知回调地址 */ + String UPDATE_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/update"; + /** 删除投诉通知回调地址 */ + String DELETE_COMPLAINT_NOTIFY_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/notify/delete"; + /** 提交回复 */ + String SUBMIT_RESPONSE_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/response"; + /** 反馈处理完成 */ + String COMPLETE_COMPLAINT_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/complete"; + /** 上传反馈图片 */ + String UPLOAD_RESPONSE_IMAGE_URL = "https://api.weixin.qq.com/cgi-bin/miniapp/complaint/upload"; + } + + /** 用工关系 */ + public interface Employee { + /** 解绑用工关系 */ + String UNBIND_EMPLOYEE_URL = "https://api.weixin.qq.com/wxa/unbinduserb2cauthinfo"; + /** 推送用工消息 */ + String SEND_EMPLOYEE_MSG_URL = "https://api.weixin.qq.com/wxa/sendemployeerelationmsg"; + } } diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/json/WxMaGsonBuilder.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/json/WxMaGsonBuilder.java index 5379826656..33cc28d6a3 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/json/WxMaGsonBuilder.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/json/WxMaGsonBuilder.java @@ -9,8 +9,13 @@ import cn.binarywang.wx.miniapp.bean.code.WxMaCodeCommitRequest; import cn.binarywang.wx.miniapp.bean.code.WxMaCodeVersionDistribution; import cn.binarywang.wx.miniapp.json.adaptor.*; +import com.google.gson.ExclusionStrategy; +import com.google.gson.FieldAttributes; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder; + +import java.io.File; import java.util.Objects; /** @@ -30,6 +35,18 @@ public class WxMaGsonBuilder { INSTANCE.registerTypeAdapter(WxMaRetainInfo.class, new WxMaRetainInfoGsonAdapter()); INSTANCE.registerTypeAdapter(WxMaUserPortrait.class, new WxMaUserPortraitGsonAdapter()); INSTANCE.registerTypeAdapter(WxMaSubscribeMsgEvent.WxMaSubscribeMsgEventJson.class, new WxMaSubscribeMsgEventJsonAdapter()); + + INSTANCE.setExclusionStrategies(new ExclusionStrategy() { + @Override + public boolean shouldSkipField(FieldAttributes fieldAttributes) { + return false; + } + + @Override + public boolean shouldSkipClass(Class> aClass) { + return aClass == File.class || aClass == ApacheHttpClientBuilder.class; + } + }); } public static Gson create() { diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaJsonOutMessage.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaJsonOutMessage.java new file mode 100644 index 0000000000..3f9bbe200c --- /dev/null +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaJsonOutMessage.java @@ -0,0 +1,67 @@ +package cn.binarywang.wx.miniapp.message; + +import cn.binarywang.wx.miniapp.config.WxMaConfig; +import cn.binarywang.wx.miniapp.json.WxMaGsonBuilder; +import cn.binarywang.wx.miniapp.util.crypt.WxMaCryptUtils; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; +import lombok.experimental.Accessors; + +import java.io.Serializable; + +/** + * 微信小程序输出给微信服务器的JSON格式消息. + * + * @author Binary Wang + */ +@Data +@Accessors(chain = true) +@Builder +@AllArgsConstructor +@NoArgsConstructor +public class WxMaJsonOutMessage implements WxMaOutMessage { + private static final long serialVersionUID = 4241135225946919154L; + + protected String toUserName; + protected String fromUserName; + protected Long createTime; + protected String msgType; + + /** + * 转换成JSON格式. + */ + @Override + public String toJson() { + return WxMaGsonBuilder.create().toJson(this); + } + + /** + * 转换成XML格式(对于JSON消息类型,返回JSON格式). + */ + @Override + public String toXml() { + // JSON消息类型默认返回JSON格式 + return toJson(); + } + + /** + * 转换成加密的JSON格式. + */ + @Override + public String toEncryptedJson(WxMaConfig config) { + String plainJson = toJson(); + WxMaCryptUtils pc = new WxMaCryptUtils(config); + return pc.encrypt(plainJson); + } + + /** + * 转换成加密的XML格式(对于JSON消息类型,返回加密的JSON格式). + */ + @Override + public String toEncryptedXml(WxMaConfig config) { + // JSON消息类型默认返回加密的JSON格式 + return toEncryptedJson(config); + } +} \ No newline at end of file diff --git a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageHandler.java b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageHandler.java index 9fdd956934..c222692e8f 100644 --- a/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageHandler.java +++ b/weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageHandler.java @@ -20,10 +20,10 @@ public interface WxMaMessageHandler { * @param context 上下文 * @param service 服务类 * @param sessionManager session管理器 - * @return 输出消息 + * @return 输出消息,可以是XML格式或JSON格式 * @throws WxErrorException 异常 */ - WxMaXmlOutMessage handle(WxMaMessage message, Map
- * 微信AI开放接口(语音识别,微信翻译). - * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712282KzWVE - * Created by BinaryWang on 2018/6/9. - *+ * 微信AI开放接口(语音识别,微信翻译) + *
+ * 提供微信AI相关的功能,包括语音识别、微信翻译等。 + * 支持上传语音文件进行语音识别,以及文本翻译功能。 + *
+ *+ * 详情请见:微信AI开放接口 + *
+ * Created by BinaryWang on 2018/6/9. * * @author Binary Wang */ public interface WxMpAiOpenService { - /** - *- * 提交语音. - * http请求方式: POST - * http://api.weixin.qq.com/cgi-bin/media/voice/addvoicetorecofortext?access_token=ACCESS_TOKEN&format=&voice_id=xxxxxx&lang=zh_CN - *- * - * @param voiceId 语音唯一标识 - * @param lang 语言,zh_CN 或 en_US,默认中文 - * @param voiceFile 语音文件 - * @throws WxErrorException the wx error exception - */ - void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException; + /** + *
+ * 提交语音 + *+ * + * @param voiceId 语音唯一标识 + * @param lang 语言,zh_CN 或 en_US,默认中文 + * @param voiceFile 语音文件 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获取语音识别结果. - * 接口调用请求说明 - * - * http://api.weixin.qq.com/cgi-bin/media/voice/queryrecoresultfortext?access_token=ACCESS_TOKEN&voice_id=xxxxxx&lang=zh_CN - * 请注意,添加完文件之后10s内调用这个接口 - * - *- * - * @param voiceId 语音唯一标识 - * @param lang 语言,zh_CN 或 en_US,默认中文 - * @return the string - * @throws WxErrorException the wx error exception - */ - String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException; + /** + *
+ * 获取语音识别结果 + * 请注意,添加完文件之后10s内调用这个接口 + *+ * + * @param voiceId 语音唯一标识 + * @param lang 语言,zh_CN 或 en_US,默认中文 + * @return 语音识别结果文本 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 识别指定语音文件内容 + * 此方法揉合了前两两个方法:uploadVoice 和 queryRecognitionResult + *+ * + * @param voiceId 语音唯一标识 + * @param lang 语言,zh_CN 或 en_US,默认中文 + * @param voiceFile 语音文件 + * @return 语音识别结果文本 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 微信翻译. - * 接口调用请求说明 - * - * http请求方式: POST - * http://api.weixin.qq.com/cgi-bin/media/voice/translatecontent?access_token=ACCESS_TOKEN&lfrom=xxx<o=xxx - * - *- * - * @param langFrom 源语言,zh_CN 或 en_US - * @param langTo 目标语言,zh_CN 或 en_US - * @param content 要翻译的文本内容 - * @return the string - * @throws WxErrorException the wx error exception - */ - String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException; + /** + *
+ * 微信翻译 + *+ * + * @param langFrom 源语言,zh_CN 或 en_US + * @param langTo 目标语言,zh_CN 或 en_US + * @param content 要翻译的文本内容 + * @return 翻译结果文本 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 提供微信卡券的创建、查询、核销、管理等功能。 + * 支持卡券API签名生成、卡券Code解码、卡券核销、库存管理等功能。 + *
+ *+ * 详情请见:卡券开发文档 + *
* * @author YuJian(mgcnrx11 @ hotmail.com) on 01/11/2016 * @author yuanqixun 2018-08-29 */ public interface WxMpCardService { /** - * 得到WxMpService. + *+ * 获取WxMpService实例 + ** - * @return WxMpService wx mp service + * @return WxMpService实例 */ WxMpService getWxMpService(); /** - * 获得卡券api_ticket,不强制刷新卡券api_ticket. + *
+ * 获得卡券api_ticket,不强制刷新卡券api_ticket + ** - * @return 卡券api_ticket card api ticket - * @throws WxErrorException 异常 - * @see #getCardApiTicket(boolean) #getCardApiTicket(boolean)#getCardApiTicket(boolean) + * @return 卡券api_ticket + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获得卡券api_ticket.
+ * 获得卡券api_ticket
* 获得时会检查卡券apiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干
- *
- * 详情请见:http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94.9F.E6.88.90.E7.AE.97.E6.B3.95
*
*
- * @param forceRefresh 强制刷新
- * @return 卡券api_ticket card api ticket
- * @throws WxErrorException 异常
+ * @param forceRefresh 强制刷新,如果为true则强制刷新api_ticket
+ * @return 卡券api_ticket
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 创建调用卡券api时所需要的签名.
- *
- * 详情请见:http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD
- * .954-.E5.8D.A1.E5.88.B8.E6.89.A9.E5.B1.95.E5.AD.97.E6.AE.B5.E5.8F.8A.E7.AD.BE.E5.90.8D.E7.94
- * .9F.E6.88.90.E7.AE.97.E6.B3.95
+ * 创建调用卡券api时所需要的签名
*
*
- * @param optionalSignParam 参与签名的参数数组。可以为下列字段:app_id, card_id, card_type, code, openid, location_id 注意:当做wx.chooseCard调用时,必须传入app_id参与签名,否则会造成签名失败导致拉取卡券列表为空
- * @return 卡券Api签名对象 wx card api signature
- * @throws WxErrorException 异常
+ * @param optionalSignParam 参与签名的参数数组。可以为下列字段:app_id, card_id, card_type, code, openid, location_id
+ * 注意:当做wx.chooseCard调用时,必须传入app_id参与签名,否则会造成签名失败导致拉取卡券列表为空
+ * @return 卡券Api签名对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ * + * 卡券Code解码 + ** * @param encryptCode 加密Code,通过JSSDK的chooseCard接口获得 - * @return 解密后的Code string - * @throws WxErrorException 异常 + * @return 解密后的Code + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 卡券Code查询 + ** * @param cardId 卡券ID代表一类卡券 * @param code 单张卡券的唯一标准 * @param checkConsume 是否校验code核销状态,填入true和false时的code异常状态返回数据不同 - * @return WxMpCardResult对象 wx mp card result - * @throws WxErrorException 异常 + * @return WxMpCardResult对象,包含卡券查询结果信息 + * @throws WxErrorException 微信API调用异常,可能包括: + *
* 卡券Code核销。核销失败会抛出异常
+ *
*
* @param code 单张卡券的唯一标准
- * @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。
- * @throws WxErrorException 异常
+ * @return 调用返回的JSON字符串,可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ * + * 卡券Code核销。核销失败会抛出异常 + ** * @param code 单张卡券的唯一标准 * @param cardId 当自定义Code卡券时需要传入card_id - * @return 调用返回的JSON字符串 。可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息。 - * @throws WxErrorException 异常 + * @return 调用返回的JSON字符串,可用 com.google.gson.JsonParser#parse 等方法直接取JSON串中的errcode等信息 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 卡券Mark接口
* 开发者在帮助消费者核销卡券之前,必须帮助先将此code(卡券串码)与一个openid绑定(即mark住),
* 才能进一步调用核销接口,否则报错。
+ *
*
* @param code 卡券的code码
* @param cardId 卡券的ID
* @param openId 用券用户的openid
* @param isMark 是否要mark(占用)这个code,填写true或者false,表示占用或解除占用
- * @throws WxErrorException 异常
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ * + * 查看卡券详情接口 + ** * @param cardId 卡券的ID - * @return 返回的卡券详情JSON字符串
+ * 添加测试白名单 + ** * @param openid 用户的openid - * @return string string - * @throws WxErrorException 异常 + * @return 操作结果字符串 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 创建卡券二维码 + ** * @param cardId 卡券编号 * @param outerStr 二维码标识 - * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result - * @throws WxErrorException 异常 + * @return 卡券二维码创建结果对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 创建卡券二维码 + ** * @param cardId 卡券编号 - * @param outerStr 二维码标识 + * @param outerStr 用户首次领卡时,会通过 领取事件推送 给商户; 对于会员卡的二维码,用户每次扫码打开会员卡后点击任何url,会将该值拼入url中,方便开发者定位扫码来源 * @param expiresIn 指定二维码的有效时间,范围是60 ~ 1800秒。不填默认为365天有效 - * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result - * @throws WxErrorException 异常 + * @return 卡券二维码创建结果对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 创建卡券二维码 + ** * @param cardId 卡券编号 * @param outerStr 用户首次领卡时,会通过 领取事件推送 给商户; 对于会员卡的二维码,用户每次扫码打开会员卡后点击任何url,会将该值拼入url中,方便开发者定位扫码来源 * @param expiresIn 指定二维码的有效时间,范围是60 ~ 1800秒。不填默认为365天有效 - * @param openid 指定领取者的openid,只有该用户能领取。bind_openid字段为true的卡券必须填写,非指定openid不必填写。 - * @param code 卡券Code码,use_custom_code字段为true的卡券必须填写,非自定义code和导入code模式的卡券不必填写。 - * @param isUniqueCode 指定下发二维码,生成的二维码随机分配一个code,领取后不可再次扫描。填写true或false。默认false,注意填写该字段时,卡券须通过审核且库存不为0。 - * @return WxMpCardQrcodeCreateResult wx mp card qrcode create result - * @throws WxErrorException 异常 + * @param openid 指定领取者的openid,只有该用户能领取。bind_openid字段为true的卡券必须填写,非指定openid不必填写 + * @param code 卡券Code码,use_custom_code字段为true的卡券必须填写,非自定义code和导入code模式的卡券不必填写 + * @param isUniqueCode 指定下发二维码,生成的二维码随机分配一个code,领取后不可再次扫描。填写true或false。默认false,注意填写该字段时,卡券须通过审核且库存不为0 + * @return 卡券二维码创建结果对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 创建卡券货架 + ** * @param createRequest 货架创建参数 - * @return WxMpCardLandingPageCreateResult wx mp card landing page create result - * @throws WxErrorException 异常 + * @return 货架创建结果对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 将用户的卡券设置为失效状态 + ** * @param cardId 卡券编号 * @param code 用户会员卡号 * @param reason 设置为失效的原因 - * @return result string - * @throws WxErrorException 异常 + * @return 操作结果字符串 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 删除卡券接口 + ** * @param cardId 卡券id - * @return 删除结果 wx mp card delete result - * @throws WxErrorException 异常 + * @return 删除结果对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
* 导入自定义code(仅对自定义code商户)
+ *
*
* @param cardId 卡券id
- * @param codeList 需导入微信卡券后台的自定义code,上限为100个。
- * @return the wx mp card code deposit result
- * @throws WxErrorException the wx error exception
+ * @param codeList 需导入微信卡券后台的自定义code,上限为100个
+ * @return 导入结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 查询导入code数目接口
+ *
*
* @param cardId 卡券id
- * @return the wx mp card code deposit count result
- * @throws WxErrorException the wx error exception
+ * @return 查询结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 核查code接口
+ *
*
* @param cardId 卡券id
* @param codeList 已经微信卡券后台的自定义code,上限为100个
- * @return the wx mp card code checkcode result
- * @throws WxErrorException the wx error exception
+ * @return 核查结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 图文消息群发卡券获取内嵌html
+ *
*
* @param cardId 卡券id
- * @return the wx mp card mpnews gethtml result
- * @throws WxErrorException the wx error exception
+ * @return HTML获取结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 修改库存接口
- * https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#5
+ *
*
* @param cardId 卡券ID
* @param changeValue 库存变更值,负值为减少库存
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 更改Code接口
- * https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#6
+ *
*
* @param cardId 卡券ID
* @param oldCode 需变更的Code码
* @param newCode 变更后的有效Code码
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 设置买单接口
- * https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#12
+ *
*
* @param cardId 卡券ID
* @param isOpen 是否开启买单功能,填true/false
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 设置自助核销
- * https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Create_a_Coupon_Voucher_or_Card.html#14
+ *
*
* @param cardId 卡券ID
* @param isOpen 是否开启自助核销功能
* @param needVerifyCod 用户核销时是否需要输入验证码, 填true/false, 默认为false
* @param needRemarkAmount 用户核销时是否需要备注核销金额, 填true/false, 默认为false
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取用户已领取卡券接口
- * https://developers.weixin.qq.com/doc/offiaccount/Cards_and_Offer/Managing_Coupons_Vouchers_and_Cards.html#1
+ *
*
* @param openId 需要查询的用户openid
* @param cardId 卡券ID。不填写时默认查询当前appid下的卡券
- * @return user card list
- * @throws WxErrorException the wx error exception
+ * @return 用户卡券列表结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取图文群发总数据(getarticletotal)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getarticletotal?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -73,10 +76,13 @@ public interface WxMpDataCubeService {
List getArticleTotal(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文统计数据(getuserread)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getuserread?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度3天,endDate不能早于begingDate
@@ -86,10 +92,13 @@ public interface WxMpDataCubeService {
List getUserRead(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文统计分时数据(getuserreadhour)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getuserreadhour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -99,10 +108,13 @@ public interface WxMpDataCubeService {
List getUserReadHour(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文分享转发数据(getusershare)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getusershare?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天,endDate不能早于begingDate
@@ -112,10 +124,13 @@ public interface WxMpDataCubeService {
List getUserShare(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取图文分享转发分时数据(getusersharehour)
- * 详情请见文档:图文分析数据接口
+ *
+ * {@code 详情请见文档:图文分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getusersharehour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -127,10 +142,13 @@ public interface WxMpDataCubeService {
//*******************消息分析数据接口***********************//
/**
- *
* 获取消息发送概况数据(getupstreammsg)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsg?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度7天,endDate不能早于begingDate
@@ -140,10 +158,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsg(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息分送分时数据(getupstreammsghour)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsghour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
@@ -153,10 +174,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgHour(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送周数据(getupstreammsgweek)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgweek?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -166,10 +190,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送月数据(getupstreammsgmonth)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgmonth?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -179,10 +206,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgMonth(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布数据(getupstreammsgdist)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdist?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度15天,endDate不能早于begingDate
@@ -192,10 +222,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgDist(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布周数据(getupstreammsgdistweek)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdistweek?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -205,10 +238,13 @@ public interface WxMpDataCubeService {
List getUpstreamMsgDistWeek(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取消息发送分布月数据(getupstreammsgdistmonth)
- * 详情请见文档:消息分析数据接口
+ *
+ * {@code 详情请见文档:消息分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getupstreammsgdistmonth?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -220,10 +256,13 @@ public interface WxMpDataCubeService {
//*******************接口分析数据接口***********************//
/**
- *
* 获取接口分析数据(getinterfacesummary)
- * 详情请见文档:接口分析数据接口
+ *
+ * {@code 详情请见文档:接口分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getinterfacesummary?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度30天,endDate不能早于begingDate
@@ -233,10 +272,13 @@ public interface WxMpDataCubeService {
List getInterfaceSummary(Date beginDate, Date endDate) throws WxErrorException;
/**
- *
* 获取接口分析分时数据(getinterfacesummaryhour)
- * 详情请见文档:接口分析数据接口
+ *
+ * {@code 详情请见文档:接口分析数据接口}
+ *
+ *
* 接口url格式:https://api.weixin.qq.com/datacube/getinterfacesummaryhour?access_token=ACCESS_TOKEN
+ *
*
* @param beginDate 开始时间
* @param endDate 最大时间跨度1天,endDate不能早于begingDate
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpKefuService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpKefuService.java
index bceb80448d..234a7160e4 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpKefuService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpKefuService.java
@@ -29,9 +29,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
*
*
- * @param message the message
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param message 客服消息对象,包含消息类型、内容、接收者等信息
+ * @return 发送是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean sendKefuMessage(WxMpKefuMessage message) throws WxErrorException;
@@ -42,9 +42,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
*
*
- * @param message the message
- * @return the response
- * @throws WxErrorException 异常
+ * @param message 客服消息对象,包含消息类型、内容、接收者等信息
+ * @return 微信API响应结果,JSON格式字符串
+ * @throws WxErrorException 微信API调用异常
*/
String sendKefuMessageWithResponse(WxMpKefuMessage message) throws WxErrorException;
@@ -57,8 +57,8 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp kf list
- * @throws WxErrorException 异常
+ * @return 客服基本信息列表,包含客服账号、昵称、头像等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfList kfList() throws WxErrorException;
@@ -69,8 +69,8 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp kf online list
- * @throws WxErrorException 异常
+ * @return 在线客服接待信息列表,包含在线客服账号、接待状态等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfOnlineList kfOnlineList() throws WxErrorException;
@@ -81,9 +81,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param request 客服账号请求对象,包含客服账号、昵称等信息
+ * @return 添加是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountAdd(WxMpKfAccountRequest request) throws WxErrorException;
@@ -94,22 +94,22 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param request 客服账号请求对象,包含客服账号、昵称等信息
+ * @return 更新是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountUpdate(WxMpKfAccountRequest request) throws WxErrorException;
/**
*
- * 设置客服信息(即更新客服信息)
+ * 邀请绑定客服账号
* 详情请见:客服管理
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/inviteworker?access_token=ACCESS_TOKEN
*
*
- * @param request the request
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param request 客服账号请求对象,包含客服账号、邀请者微信号等信息
+ * @return 邀请是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountInviteWorker(WxMpKfAccountRequest request) throws WxErrorException;
@@ -120,10 +120,10 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @param imgFile the img file
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @param imgFile 头像图片文件,支持JPG、PNG格式,大小不超过2MB
+ * @return 上传是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountUploadHeadImg(String kfAccount, File imgFile) throws WxErrorException;
@@ -134,9 +134,9 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 删除是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfAccountDel(String kfAccount) throws WxErrorException;
@@ -150,10 +150,10 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/create?access_token=ACCESS_TOKEN
*
*
- * @param openid the openid
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 创建是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfSessionCreate(String openid, String kfAccount) throws WxErrorException;
@@ -165,10 +165,10 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/close?access_token=ACCESS_TOKEN
*
*
- * @param openid the openid
- * @param kfAccount the kf account
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 关闭是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean kfSessionClose(String openid, String kfAccount) throws WxErrorException;
@@ -180,9 +180,9 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
*
*
- * @param openid the openid
- * @return the wx mp kf session get result
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @return 客户会话状态信息,包含客服账号、会话状态等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionGetResult kfSessionGet(String openid) throws WxErrorException;
@@ -194,9 +194,9 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
*
*
- * @param kfAccount the kf account
- * @return the wx mp kf session list
- * @throws WxErrorException 异常
+ * @param kfAccount 客服账号,格式为:账号前缀@微信号
+ * @return 客服会话列表,包含正在接待的会话信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionList kfSessionList(String kfAccount) throws WxErrorException;
@@ -208,8 +208,8 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/kfsession/getwaitcase?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp kf session wait case list
- * @throws WxErrorException 异常
+ * @return 未接入会话列表,包含等待接入的会话信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfSessionWaitCaseList kfSessionGetWaitCase() throws WxErrorException;
@@ -223,12 +223,12 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
*
*
- * @param startTime 起始时间
- * @param endTime 结束时间
- * @param msgId 消息id顺序从小到大,从1开始
- * @param number 每次获取条数,最多10000条
- * @return 聊天记录对象 wx mp kf msg list
- * @throws WxErrorException 异常
+ * @param startTime 起始时间,用于筛选聊天记录的时间范围
+ * @param endTime 结束时间,用于筛选聊天记录的时间范围
+ * @param msgId 消息id顺序从小到大,从1开始,用于分页获取
+ * @param number 每次获取条数,最多10000条,用于分页控制
+ * @return 聊天记录对象,包含客服和用户的聊天消息列表
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfMsgList kfMsgList(Date startTime, Date endTime, Long msgId, Integer number) throws WxErrorException;
@@ -240,17 +240,17 @@ public interface WxMpKefuService {
* 接口url格式: https://api.weixin.qq.com/customservice/msgrecord/getmsglist?access_token=ACCESS_TOKEN
*
*
- * @param startTime 起始时间
- * @param endTime 结束时间
- * @return 聊天记录对象 wx mp kf msg list
- * @throws WxErrorException 异常
+ * @param startTime 起始时间,用于筛选聊天记录的时间范围
+ * @param endTime 结束时间,用于筛选聊天记录的时间范围
+ * @return 聊天记录对象,包含客服和用户的聊天消息列表
+ * @throws WxErrorException 微信API调用异常
*/
WxMpKfMsgList kfMsgList(Date startTime, Date endTime) throws WxErrorException;
/**
*
* 客服输入状态
- * 开发者可通过调用“客服输入状态”接口,返回客服当前输入状态给用户。
+ * 开发者可通过调用"客服输入状态"接口,返回客服当前输入状态给用户。
* 此接口需要客服消息接口权限。
* 如果不满足发送客服消息的触发条件,则无法下发输入状态。
* 下发输入状态,需要客服之前30秒内跟用户有过消息交互。
@@ -261,10 +261,10 @@ public interface WxMpKefuService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
*
*
- * @param openid 用户id
- * @param command "Typing":对用户下发“正在输入"状态 "CancelTyping":取消对用户的”正在输入"状态
- * @return the boolean
- * @throws WxErrorException 异常
+ * @param openid 用户的openid,标识具体的用户
+ * @param command 输入状态命令,可选值:"Typing":对用户下发"正在输入"状态;"CancelTyping":取消对用户的"正在输入"状态
+ * @return 发送是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean sendKfTypingState(String openid, String command) throws WxErrorException;
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
index 823c2c6343..5ad3098c2a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMassMessageService.java
@@ -8,138 +8,234 @@
import me.chanjar.weixin.mp.bean.result.WxMpMassUploadResult;
/**
- * - * 群发消息服务类. + * 群发消息服务类 + ** * @author Binary Wang */ public interface WxMpMassMessageService { /** *+ * 提供微信公众号群发消息的功能,包括图文消息、视频消息的群发, + * 支持按分组群发、按openid列表群发、消息预览、群发状态查询等功能。 + *
+ *+ * 详情请见:群发消息开发文档 + *
* Created by Binary Wang on 2017-8-16. - *
- * 上传群发用的图文消息,上传后才能群发图文消息.
- *
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
+ * 上传群发用的图文消息,上传后才能群发图文消息
*
*
- * @param news the news
- * @return the wx mp mass upload result
- * @throws WxErrorException the wx error exception
- * @see #massGroupMessageSend(WxMpMassTagMessage) #massGroupMessageSend(WxMpMassTagMessage)
- * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage) #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @param news 图文消息对象
+ * @return 上传结果对象,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 上传群发用的视频,上传后才能群发视频消息.
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
+ * 上传群发用的视频,上传后才能群发视频消息
*
*
- * @param video the video
- * @return the wx mp mass upload result
- * @throws WxErrorException the wx error exception
- * @see #massGroupMessageSend(WxMpMassTagMessage) #massGroupMessageSend(WxMpMassTagMessage)
- * @see #massOpenIdsMessageSend(WxMpMassOpenIdsMessage) #massOpenIdsMessageSend(WxMpMassOpenIdsMessage)
+ * @param video 视频消息对象
+ * @return 上传结果对象,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 分组群发消息.
+ * 分组群发消息
* 如果发送图文消息,必须先使用 {@link #massNewsUpload(WxMpMassNews)} 获得media_id,然后再发送
* 如果发送视频消息,必须先使用 {@link #massVideoUpload(WxMpMassVideo)} 获得media_id,然后再发送
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param message the message
- * @return the wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param message 分组群发消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 按openId列表群发消息.
+ * 按openId列表群发消息
* 如果发送图文消息,必须先使用 {@link #massNewsUpload(WxMpMassNews)} 获得media_id,然后再发送
* 如果发送视频消息,必须先使用 {@link #massVideoUpload(WxMpMassVideo)} 获得media_id,然后再发送
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param message the message
- * @return the wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param message 按openid列表群发消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 群发消息预览接口.
+ * 群发消息预览接口
* 开发者可通过该接口发送消息给指定用户,在手机端查看消息的样式和排版。为了满足第三方平台开发者的需求,
* 在保留对openID预览能力的同时,增加了对指定微信号发送预览的能力,但该能力每日调用次数有限制(100次),请勿滥用。
- * 接口调用请求说明
- * http请求方式: POST
- * https://api.weixin.qq.com/cgi-bin/message/mass/preview?access_token=ACCESS_TOKEN
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
*
*
- * @param wxMpMassPreviewMessage the wx mp mass preview message
- * @return wxMpMassSendResult wx mp mass send result
- * @throws WxErrorException the wx error exception
+ * @param wxMpMassPreviewMessage 预览消息对象
+ * @return 群发结果对象,包含msg_id等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * 删除群发.
+ * 删除群发
* 群发之后,随时可以通过该接口删除群发。
* 请注意:
* 1、只有已经发送成功的消息才能删除
* 2、删除消息是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。
* 3、删除群发消息只能删除图文消息和视频消息,其他类型的消息一经发送,无法删除。
* 4、如果多次群发发送的是一个图文消息,那么删除其中一次群发,就会删除掉这个图文消息也,导致所有群发都失效
- * 接口调用请求说明:
- * http请求方式: POST
- * https://api.weixin.qq.com/cgi-bin/message/mass/delete?access_token=ACCESS_TOKEN
- * 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1481187827_i0l21
*
*
* @param msgId 发送出去的消息ID
* @param articleIndex 要删除的文章在图文消息中的位置,第一篇编号为1,该字段不填或填0会删除全部文章
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取群发速度
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#9
+ *
*
- * @return the wx mp mass speed get result
- * @throws WxErrorException the wx error exception
+ * @return 群发速度获取结果对象
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 设置群发速度
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#9
+ *
*
- * @param speed 群发速度的级别,是一个0到4的整数,数字越大表示群发速度越慢。 speed realspeed 0 80w/分钟 1 60w/分钟 2 45w/分钟 3 30w/分钟 4 10w/分钟
- * @throws WxErrorException the wx error exception
+ * @param speed 群发速度的级别,是一个0到4的整数,数字越大表示群发速度越慢。
+ * speed realspeed
+ * 0 80w/分钟
+ * 1 60w/分钟
+ * 2 45w/分钟
+ * 3 30w/分钟
+ * 4 10w/分钟
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 查询群发消息发送状态【订阅号与服务号认证后均可用】
- * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#%E6%9F%A5%E8%AF%A2%E7%BE%A4%E5%8F%91%E6%B6%88%E6%81%AF%E5%8F%91%E9%80%81%E7%8A%B6%E6%80%81%E3%80%90%E8%AE%A2%E9%98%85%E5%8F%B7%E4%B8%8E%E6%9C%8D%E5%8A%A1%E5%8F%B7%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9D%87%E5%8F%AF%E7%94%A8%E3%80%91
+ *
*
* @param msgId 群发消息后返回的消息id
- * @return 消息发送后的状态 ,SEND_SUCCESS表示发送成功,SENDING表示发送中,SEND_FAIL表示发送失败,DELETE表示已删除
- * @throws WxErrorException the wx error exception
+ * @return 消息发送后的状态,SEND_SUCCESS表示发送成功,SENDING表示发送中,SEND_FAIL表示发送失败,DELETE表示已删除
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
- * Created by Binary Wang on 2016/7/21.
* 素材管理的相关接口,包括媒体管理的接口,
* 即以https://api.weixin.qq.com/cgi-bin/material
* 和 https://api.weixin.qq.com/cgi-bin/media开头的接口
@@ -36,7 +35,7 @@ public interface WxMpMaterialService {
* 2、media_id是可复用的。
* 3、素材的格式大小等要求与公众平台官网一致。具体是,图片大小不超过2M,支持png/jpeg/jpg/gif格式,语音大小不超过5M,长度不超过60秒,支持mp3/amr格式
* 4、需使用https调用本接口。
- * 本接口即为原“上传多媒体文件”接口。
+ * 本接口即为原"上传多媒体文件"接口。
* 注意事项:
* 上传的临时多媒体文件有格式和大小限制,如下:
* 图片(image): 2M,支持PNG\JPEG\JPG\GIF格式
@@ -49,17 +48,17 @@ public interface WxMpMaterialService {
*
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param file 文件对象
- * @return the wx media upload result
- * @throws WxErrorException the wx error exception
- * @see #mediaUpload(String, String, InputStream) #mediaUpload(String, String, InputStream)#mediaUpload(String, String, InputStream)
+ * @param file 文件对象,需要上传的临时素材文件
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
+ * @see #mediaUpload(String, String, InputStream) 使用输入流上传临时素材
*/
WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException;
/**
*
* 新增临时素材
- * 本接口即为原“上传多媒体文件”接口。
+ * 本接口即为原"上传多媒体文件"接口。
*
* 详情请见: 新增临时素材
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
@@ -67,10 +66,10 @@ public interface WxMpMaterialService {
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
* @param fileType 文件类型,请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param inputStream 输入流
- * @return the wx media upload result
- * @throws WxErrorException the wx error exception
- * @see #mediaUpload(java.lang.String, java.io.File) #mediaUpload(java.lang.String, java.io.File)#mediaUpload(java.lang.String, java.io.File)
+ * @param inputStream 输入流,包含要上传的临时素材内容
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
+ * @see #mediaUpload(String, File) 使用文件对象上传临时素材
*/
WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) throws WxErrorException;
@@ -78,15 +77,15 @@ public interface WxMpMaterialService {
*
* 获取临时素材
* 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)。请注意,视频文件不支持https下载,调用该接口需http协议。
- * 本接口即为原“下载多媒体文件”接口。
+ * 本接口即为原"下载多媒体文件"接口。
* 根据微信文档,视频文件下载不了,会返回null
* 详情请见: 获取临时素材
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
*
*
- * @param mediaId 媒体文件Id
- * @return 保存到本地的临时文件 file
- * @throws WxErrorException the wx error exception
+ * @param mediaId 媒体文件Id,通过上传临时素材接口获取
+ * @return 保存到本地的临时文件,如果下载失败则返回null
+ * @throws WxErrorException 微信API调用异常
*/
File mediaDownload(String mediaId) throws WxErrorException;
@@ -100,9 +99,9 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
*
*
- * @param mediaId 媒体文件Id
- * @return 保存到本地的临时文件 file
- * @throws WxErrorException the wx error exception
+ * @param mediaId 媒体文件Id,通过JSSDK上传语音素材获取
+ * @return 保存到本地的临时文件,高清语音素材
+ * @throws WxErrorException 微信API调用异常
*/
File jssdkMediaDownload(String mediaId) throws WxErrorException;
@@ -114,9 +113,9 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN
*
*
- * @param file 上传的文件对象
- * @return WxMediaImgUploadResult 返回图片url
- * @throws WxErrorException the wx error exception
+ * @param file 上传的文件对象,图片素材,支持jpg/png格式,大小不超过1MB
+ * @return 图片上传结果,包含图片URL,可用于图文消息中
+ * @throws WxErrorException 微信API调用异常
*/
WxMediaImgUploadResult mediaImgUpload(File file) throws WxErrorException;
@@ -141,8 +140,8 @@ public interface WxMpMaterialService {
*
* @param mediaType 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
* @param material 上传的素材, 请看{@link WxMpMaterial}
- * @return the wx mp material upload result
- * @throws WxErrorException the wx error exception
+ * @return 上传结果,包含media_id等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialUploadResult materialFileUpload(String mediaType, WxMpMaterial material) throws WxErrorException;
@@ -155,8 +154,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the input stream
- * @throws WxErrorException the wx error exception
+ * @return 素材内容的输入流,可用于读取图片或语音文件
+ * @throws WxErrorException 微信API调用异常
*/
InputStream materialImageOrVoiceDownload(String mediaId) throws WxErrorException;
@@ -169,8 +168,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the wx mp material video info result
- * @throws WxErrorException the wx error exception
+ * @return 视频素材信息,包含标题、描述和下载地址
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialVideoInfoResult materialVideoInfo(String mediaId) throws WxErrorException;
@@ -183,8 +182,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the wx mp material news
- * @throws WxErrorException the wx error exception
+ * @return 图文素材信息,包含文章列表和标题等
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialNews materialNewsInfo(String mediaId) throws WxErrorException;
@@ -201,8 +200,8 @@ public interface WxMpMaterialService {
*
*
* @param mediaId 永久素材的id
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @return 删除是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常
*/
boolean materialDelete(String mediaId) throws WxErrorException;
@@ -219,8 +218,8 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/material/get_materialcount?access_token=ACCESS_TOKEN
*
*
- * @return the wx mp material count result
- * @throws WxErrorException the wx error exception
+ * @return 素材统计结果,包含各类素材的数量
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialCountResult materialCount() throws WxErrorException;
@@ -232,10 +231,10 @@ public interface WxMpMaterialService {
* 接口url格式:https://api.weixin.qq.com/cgi-bin/material/batchget_material?access_token=ACCESS_TOKEN
*
*
- * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材返回
* @param count 返回素材的数量,取值在1到20之间
- * @return the wx mp material news batch get result
- * @throws WxErrorException the wx error exception
+ * @return 图文素材列表,包含文章列表和标题等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialNewsBatchGetResult materialNewsBatchGet(int offset, int count) throws WxErrorException;
@@ -248,10 +247,10 @@ public interface WxMpMaterialService {
*
*
* @param type 媒体类型, 请看{@link me.chanjar.weixin.common.api.WxConsts}
- * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材 返回
+ * @param offset 从全部素材的该偏移位置开始返回,0表示从第一个素材返回
* @param count 返回素材的数量,取值在1到20之间
- * @return the wx mp material file batch get result
- * @throws WxErrorException the wx error exception
+ * @return 其他媒体素材列表,包含图片、语音、视频等素材信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMaterialFileBatchGetResult materialFileBatchGet(String type, int offset, int count) throws WxErrorException;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
index 3e78893005..ad1813ee85 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpMenuService.java
@@ -19,9 +19,9 @@ public interface WxMpMenuService {
* 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param menu the menu
- * @return 如果是个性化菜单 ,则返回menuid,否则返回null
- * @throws WxErrorException the wx error exception
+ * @param menu 菜单对象,包含菜单结构和配置信息
+ * @return 如果是个性化菜单,则返回menuid,否则返回null
+ * @throws WxErrorException 微信API调用异常
*/
String menuCreate(WxMenu menu) throws WxErrorException;
@@ -33,9 +33,9 @@ public interface WxMpMenuService {
* 详情请见:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param json the json
- * @return 如果是个性化菜单 ,则返回menuid,否则返回null
- * @throws WxErrorException the wx error exception
+ * @param json 菜单配置的JSON字符串,包含菜单结构和配置信息
+ * @return 如果是个性化菜单,则返回menuid,否则返回null
+ * @throws WxErrorException 微信API调用异常
*/
String menuCreate(String json) throws WxErrorException;
@@ -45,7 +45,7 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141015&token=&lang=zh_CN
*
*
- * @throws WxErrorException the wx error exception
+ * @throws WxErrorException 微信API调用异常
*/
void menuDelete() throws WxErrorException;
@@ -55,8 +55,8 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1455782296&token=&lang=zh_CN
*
*
- * @param menuId 个性化菜单的menuid
- * @throws WxErrorException the wx error exception
+ * @param menuId 个性化菜单的menuid,通过创建个性化菜单时返回
+ * @throws WxErrorException 微信API调用异常
*/
void menuDelete(String menuId) throws WxErrorException;
@@ -66,8 +66,8 @@ public interface WxMpMenuService {
* 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141014&token=&lang=zh_CN
*
*
- * @return the wx mp menu
- * @throws WxErrorException the wx error exception
+ * @return 当前公众号的自定义菜单配置
+ * @throws WxErrorException 微信API调用异常
*/
WxMpMenu menuGet() throws WxErrorException;
@@ -77,9 +77,9 @@ public interface WxMpMenuService {
* 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
*
*
- * @param userid 可以是粉丝的OpenID,也可以是粉丝的微信号。
- * @return the wx menu
- * @throws WxErrorException the wx error exception
+ * @param userid 可以是粉丝的OpenID,也可以是粉丝的微信号
+ * @return 匹配到的菜单配置
+ * @throws WxErrorException 微信API调用异常
*/
WxMenu menuTryMatch(String userid) throws WxErrorException;
@@ -98,8 +98,8 @@ public interface WxMpMenuService {
* https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info?access_token=ACCESS_TOKEN
*
*
- * @return the self menu info
- * @throws WxErrorException the wx error exception
+ * @return 自定义菜单配置信息,包含菜单结构和配置详情
+ * @throws WxErrorException 微信API调用异常
*/
WxMpGetSelfMenuInfoResult getSelfMenuInfo() throws WxErrorException;
}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
index ed8c5e6a79..df923512c9 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpQrcodeService.java
@@ -22,8 +22,8 @@ public interface WxMpQrcodeService {
*
* @param sceneId 场景值ID,临时二维码时为32位非0整型
* @param expireSeconds 该二维码有效时间,以秒为单位。 最大不超过2592000(即30天),此字段如果不填,则默认有效期为30秒。
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateTmpTicket(int sceneId, Integer expireSeconds) throws WxErrorException;
@@ -36,8 +36,8 @@ public interface WxMpQrcodeService {
*
* @param sceneStr 场景值ID(字符串形式的ID),字符串类型,长度限制为1到64
* @param expireSeconds 该二维码有效时间,以秒为单位。 最大不超过2592000(即30天),此字段如果不填,则默认有效期为30秒。
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateTmpTicket(String sceneStr, Integer expireSeconds) throws WxErrorException;
@@ -48,8 +48,8 @@ public interface WxMpQrcodeService {
*
*
* @param sceneId 场景值ID,最大值为100000(目前参数只支持1--100000)
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateLastTicket(int sceneId) throws WxErrorException;
@@ -60,8 +60,8 @@ public interface WxMpQrcodeService {
*
*
* @param sceneStr 参数。字符串类型长度现在为1到64
- * @return the wx mp qr code ticket
- * @throws WxErrorException the wx error exception
+ * @return 二维码ticket,可用于获取二维码图片
+ * @throws WxErrorException 微信API调用异常
*/
WxMpQrCodeTicket qrCodeCreateLastTicket(String sceneStr) throws WxErrorException;
@@ -71,9 +71,9 @@ public interface WxMpQrcodeService {
* 详情请见: 生成带参数的二维码
*
*
- * @param ticket 二维码ticket
- * @return the file
- * @throws WxErrorException the wx error exception
+ * @param ticket 二维码ticket,通过创建二维码接口获取
+ * @return 二维码图片文件,jpg格式
+ * @throws WxErrorException 微信API调用异常
*/
File qrCodePicture(WxMpQrCodeTicket ticket) throws WxErrorException;
@@ -85,8 +85,9 @@ public interface WxMpQrcodeService {
*
* @param ticket 二维码ticket
* @param needShortUrl 是否需要压缩的二维码地址
- * @return the string
- * @throws WxErrorException the wx error exception
+ * @return 二维码图片的URL地址
+ * @throws WxErrorException 微信API调用异常
+ * @deprecated 请使用 {@link #qrCodePictureUrl(String)} 方法
*/
@Deprecated
String qrCodePictureUrl(String ticket, boolean needShortUrl) throws WxErrorException;
@@ -97,9 +98,9 @@ public interface WxMpQrcodeService {
* 详情请见: 生成带参数的二维码
*
*
- * @param ticket 二维码ticket
- * @return the string
- * @throws WxErrorException the wx error exception
+ * @param ticket 二维码ticket,通过创建二维码接口获取
+ * @return 二维码图片的URL地址
+ * @throws WxErrorException 微信API调用异常
*/
String qrCodePictureUrl(String ticket) throws WxErrorException;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
index 47a24b7931..2d965bf8de 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpService.java
@@ -37,7 +37,7 @@ public interface WxMpService extends WxService {
* @param longData 需要转换的长信息,不超过4KB
* @param expireSeconds 短key有效期(单位秒),最大值为2592000(即30天),默认为2592000(30天)
* @return shortKey 短key,15字节,base62编码(0-9/a-z/A-Z)
- * @throws WxErrorException .
+ * @throws WxErrorException 微信API调用异常
*/
String genShorten(String longData, Integer expireSeconds) throws WxErrorException;
@@ -47,61 +47,64 @@ public interface WxMpService extends WxService {
* 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Account_Management/KEY_Shortener.html
*
*
- * @param shortKey 短key
- * @return WxMpShortKeyResult 解析结果
- * @throws WxErrorException .
+ * @param shortKey 短key,15字节,base62编码(0-9/a-z/A-Z)
+ * @return WxMpShortKeyResult 解析结果,包含原始长信息
+ * @throws WxErrorException 微信API调用异常
*/
WxMpShortKeyResult fetchShorten(String shortKey) throws WxErrorException;
/**
- *
* 验证消息的确来自微信服务器.
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
- *
+ * + * {@code 详情请见: 接入指南} + *
* - * @param timestamp 时间戳 - * @param nonce 随机串 - * @param signature 签名 - * @return 是否验证通过 boolean + * @param timestamp 时间戳,字符串格式 + * @param nonce 随机串,字符串格式 + * @param signature 签名,字符串格式 + * @return 是否验证通过,true表示验证通过,false表示验证失败 */ boolean checkSignature(String timestamp, String nonce, String signature); /** * 获取access_token, 不强制刷新access_token. * - * @return token access token - * @throws WxErrorException . - * @see #getAccessToken(boolean) #getAccessToken(boolean)#getAccessToken(boolean)#getAccessToken(boolean) + * @return token access token,字符串格式 + * @throws WxErrorException 微信API调用异常 + * @see #getAccessToken(boolean) 获取access_token,可选择是否强制刷新 */ String getAccessToken() throws WxErrorException; /** - *
* 获取access_token,本方法线程安全.
+ *
* 且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限
- *
+ *
+ *
* 另:本service的所有方法都会在access_token过期时调用此方法
- *
+ *
+ *
* 程序员在非必要情况下尽量不要主动调用此方法
+ *
+ *
+ * {@code 详情请见: 获取access_token}
+ *
*
- * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
- *
- *
- * @param forceRefresh 是否强制刷新
- * @return token access token
- * @throws WxErrorException .
+ * @param forceRefresh 是否强制刷新,true表示强制刷新,false表示使用缓存
+ * @return token access token,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
String getAccessToken(boolean forceRefresh) throws WxErrorException;
/**
* 获得ticket,不强制刷新ticket.
*
- * @param type ticket 类型
- * @return ticket ticket
- * @throws WxErrorException .
- * @see #getTicket(TicketType, boolean) #getTicket(TicketType, boolean)#getTicket(TicketType, boolean)#getTicket(TicketType, boolean)
+ * @param ticketType ticket 类型,通过TicketType枚举指定
+ * @return ticket ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @see #getTicket(TicketType, boolean) 获得ticket,可选择是否强制刷新
*/
- String getTicket(TicketType type) throws WxErrorException;
+ String getTicket(TicketType ticketType) throws WxErrorException;
/**
*
@@ -109,110 +112,109 @@ public interface WxMpService extends WxService {
* 获得时会检查 Token是否过期,如果过期了,那么就刷新一下,否则就什么都不干
*
*
- * @param type ticket类型
- * @param forceRefresh 强制刷新
- * @return ticket ticket
- * @throws WxErrorException .
+ * @param ticketType ticket类型,通过TicketType枚举指定
+ * @param forceRefresh 强制刷新,true表示强制刷新,false表示使用缓存
+ * @return ticket ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
- String getTicket(TicketType type, boolean forceRefresh) throws WxErrorException;
+ String getTicket(TicketType ticketType, boolean forceRefresh) throws WxErrorException;
/**
* 获得jsapi_ticket,不强制刷新jsapi_ticket.
*
- * @return jsapi ticket
- * @throws WxErrorException .
- * @see #getJsapiTicket(boolean) #getJsapiTicket(boolean)#getJsapiTicket(boolean)#getJsapiTicket(boolean)
+ * @return jsapi ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
+ * @see #getJsapiTicket(boolean) 获得jsapi_ticket,可选择是否强制刷新
*/
String getJsapiTicket() throws WxErrorException;
/**
- *
* 获得jsapi_ticket.
+ *
* 获得时会检查jsapiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干
+ *
+ *
+ * {@code 详情请见:JS-SDK使用权限签名算法}
+ *
*
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
- *
- *
- * @param forceRefresh 强制刷新
- * @return jsapi ticket
- * @throws WxErrorException .
+ * @param forceRefresh 强制刷新,true表示强制刷新,false表示使用缓存
+ * @return jsapi ticket,字符串格式
+ * @throws WxErrorException 微信API调用异常
*/
String getJsapiTicket(boolean forceRefresh) throws WxErrorException;
/**
- *
* 创建调用jsapi时所需要的签名.
+ *
+ * {@code 详情请见:JS-SDK使用权限签名算法}
+ *
*
- * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
- *
- *
- * @param url 地址
- * @return 生成的签名对象 wx jsapi signature
- * @throws WxErrorException .
+ * @param url 当前网页的URL,不包括#及其后面部分
+ * @return 生成的签名对象,包含签名、时间戳、随机串等信息
+ * @throws WxErrorException 微信API调用异常
*/
WxJsapiSignature createJsapiSignature(String url) throws WxErrorException;
/**
- *
* 长链接转短链接接口.
- * 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
- *
+ * + * 详情请见: 长链接转短链接接口 + *
* - * @param longUrl 长url - * @return 生成的短地址 string - * @throws WxErrorException . + * @param longUrl 长url,需要转换的原始URL + * @return 生成的短地址,字符串格式 + * @throws WxErrorException 微信API调用异常 + * @deprecated 请使用 {@link #genShorten(String, Integer)} 方法 */ @Deprecated String shortUrl(String longUrl) throws WxErrorException; /** - *
* 语义查询接口.
- * 详情请见:http://mp.weixin.qq.com/wiki/index.php?title=语义理解
- *
+ * + * 详情请见:语义理解 + *
* - * @param semanticQuery 查询条件 - * @return 查询结果 wx mp semantic query result - * @throws WxErrorException . + * @param semanticQuery 查询条件,包含查询内容、类型等信息 + * @return 查询结果,包含语义理解的结果和建议回复 + * @throws WxErrorException 微信API调用异常 */ WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException; /** - *
* 构造第三方使用网站应用授权登录的url.
- * 详情请见: 网站应用微信登录开发指南
- * URL格式为:https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
- *
+ * + * {@code 详情请见: 网站应用微信登录开发指南} + *
+ *+ * {@code URL格式为:https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect} + *
* * @param redirectUri 用户授权完成后的重定向链接,无需urlencode, 方法内会进行encode * @param scope 应用授权作用域,拥有多个作用域用逗号(,)分隔,网页应用目前仅填写snsapi_login即可 * @param state 非必填,用于保持请求和回调的状态,授权请求后原样带回给第三方。该参数可用于防止csrf攻击(跨站请求伪造攻击),建议第三方带上该参数,可设置为简单的随机数加session进行校验 - * @return url string + * @return url 构造好的授权登录URL,字符串格式 */ String buildQrConnectUrl(String redirectUri, String scope, String state); /** - *
* 获取微信服务器IP地址
- * http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
- *
*
- * @return 微信服务器ip地址数组 string [ ]
- * @throws WxErrorException .
+ * @return 微信服务器ip地址数组,包含所有微信服务器IP地址
+ * @throws WxErrorException 微信API调用异常
*/
String[] getCallbackIP() throws WxErrorException;
/**
- * - * 网络检测 - * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21541575776DtsuT - * 为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。 - *+ * 网络检测 + *
+ * 为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。 + *
* - * @param action 执行的检测动作 - * @param operator 指定平台从某个运营商进行检测 - * @return 检测结果 wx net check result - * @throws WxErrorException . + * @param action 执行的检测动作,可选值:all(全部检测)、dns(仅域名解析)、ping(仅网络连通性检测) + * @param operator 指定平台从某个运营商进行检测,可选值:CHINANET(中国电信)、UNICOM(中国联通)、CAP(中国联通)、CUCC(中国联通) + * @return 检测结果,包含丢包率和耗时等信息 + * @throws WxErrorException 微信API调用异常 */ WxNetCheckResult netCheck(String action, String operator) throws WxErrorException; @@ -232,78 +234,77 @@ public interface WxMpService extends WxService { * https://api.weixin.qq.com/cgi-bin/get_current_autoreply_info?access_token=ACCESS_TOKEN * * - * @return 公众号的自动回复规则 current auto reply info - * @throws WxErrorException . + * @return 公众号的自动回复规则,包含关注后自动回复、消息自动回复、关键词自动回复等信息 + * @throws WxErrorException 微信API调用异常 */ WxMpCurrentAutoReplyInfo getCurrentAutoReplyInfo() throws WxErrorException; /** - *- * 公众号调用或第三方平台帮公众号调用对公众号的所有api调用(包括第三方帮其调用)次数进行清零: - * HTTP调用:https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN - * 接口文档地址:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592 - * - *+ * 公众号调用或第三方平台帮公众号调用对公众号的所有api调用(包括第三方帮其调用)次数进行清零. + *
+ * HTTP调用:https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN + *
+ *+ * {@code 接口文档地址:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592} + *
* - * @param appid 公众号的APPID - * @throws WxErrorException the wx error exception + * @param appid 公众号的APPID,需要清零调用的公众号的appid + * @throws WxErrorException 微信API调用异常 */ void clearQuota(String appid) throws WxErrorException; /** - *
* Service没有实现某个API的时候,可以用这个,
* 比{@link #get}和{@link #post}方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
* 可以参考,{@link MediaUploadRequestExecutor}的实现方法
- *
*
- * @param * 模板消息接口 - * http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN + *+ * @author Binary Wang */ public interface WxMpTemplateMsgService { - /** - *+ * 提供微信模板消息的发送、行业设置、模板管理等功能。 + * 模板消息用于在用户触发特定事件后,向用户发送重要的服务通知。 + *
+ *+ * 详情请见:模板消息开发文档 + *
* Created by Binary Wang on 2016-10-14. + * * @author miller.lin - * @author Binary Wang
- * 设置所属行业 - * 官方文档中暂未告知响应内容 - * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - *- * - * @param wxMpIndustry 行业信息 - * @return 是否成功 industry - * @throws WxErrorException . - */ - boolean setIndustry(WxMpTemplateIndustry wxMpIndustry) throws WxErrorException; + /** + *
+ * 设置所属行业 + * 官方文档中暂未告知响应内容 + *+ * + * @param wxMpIndustry 行业信息 + * @return 是否成功设置行业 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获取设置的行业信息 - * 详情请见:http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - *- * - * @return wxMpIndustry industry - * @throws WxErrorException . - */ - WxMpTemplateIndustry getIndustry() throws WxErrorException; + /** + *
+ * 获取设置的行业信息 + *+ * + * @return 行业信息对象 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 发送模板消息 - * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - *- * - * @param templateMessage 模板消息 - * @return 消息Id string - * @throws WxErrorException . - */ - String sendTemplateMsg(WxMpTemplateMessage templateMessage) throws WxErrorException; + /** + *
+ * 发送模板消息 + *+ * + * @param templateMessage 模板消息对象 + * @return 消息ID,可用于查询模板消息发送状态 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获得模板ID - * 从行业模板库选择模板到账号后台,获得模板ID的过程可在MP中完成 - * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN - *- * - * @param shortTemplateId 模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式 - * @return templateId 模板Id - * @throws WxErrorException . - * @deprecated 请使用 addTemplate(java.lang.String, java.util.List) - */ - @Deprecated - String addTemplate(String shortTemplateId) throws WxErrorException; + /** + *
+ * 获得模板ID + * 从行业模板库选择模板到账号后台,获得模板ID的过程可在MP中完成 + *+ * + * @param shortTemplateId 模板库中模板的编号,有"TM**"和"OPENTMTM**"等形式 + * @return 模板ID + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获得模板ID - * 从类目模板库选择模板到账号后台,获得模板ID的过程可在MP中完成 - * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN - *- * - * @param shortTemplateId 模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式,对于类目模板,为纯数字ID - * @param keywordNameList 选用的类目模板的关键词,按顺序传入,如果为空,或者关键词不在模板库中,会返回40246错误码 - * @return templateId 模板Id - * @throws WxErrorException . - */ - String addTemplate(String shortTemplateId, List
+ * 获得模板ID + * 从类目模板库选择模板到账号后台,获得模板ID的过程可在MP中完成 + *+ * + * @param shortTemplateId 模板库中模板的编号,有"TM**"和"OPENTMTM**"等形式,对于类目模板,为纯数字ID + * @param keywordNameList 选用的类目模板的关键词,按顺序传入,如果为空,或者关键词不在模板库中,会返回40246错误码 + * @return 模板ID + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 获取模板列表 - * 获取已添加至账号下所有模板列表,可在MP中查看模板列表信息,为方便第三方开发者,提供通过接口调用的方式来获取账号下所有模板信息 - * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/get_all_private_template?access_token=ACCESS_TOKEN - *- * - * @return templateId 模板Id - * @throws WxErrorException . - */ - List
+ * 获取模板列表 + * 获取已添加至账号下所有模板列表,可在MP中查看模板列表信息,为方便第三方开发者,提供通过接口调用的方式来获取账号下所有模板信息 + *+ * + * @return 模板列表,包含所有已添加的模板信息 + * @throws WxErrorException 微信API调用异常,可能包括: + *
- * 删除模板 - * 删除模板可在MP中完成,为方便第三方开发者,提供通过接口调用的方式来删除某账号下的模板 - * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN - * 接口地址格式:https://api.weixin.qq.com/cgi-bin/template/del_private_template?access_token=ACCESS_TOKEN - *- * - * @param templateId 模板Id - * @return . boolean - * @throws WxErrorException . - */ - boolean delPrivateTemplate(String templateId) throws WxErrorException; + /** + *
+ * 删除模板 + * 删除模板可在MP中完成,为方便第三方开发者,提供通过接口调用的方式来删除某账号下的模板 + *+ * + * @param templateId 模板ID + * @return 是否成功删除 + * @throws WxErrorException 微信API调用异常,可能包括: + *
+ * 提供微信公众号用户标签的创建、查询、更新、删除等功能。 + * 通过标签可以方便地对用户进行分组管理和精准营销。 + * 一个公众号最多可以创建100个标签。 + *
+ *+ * 详情请见:用户标签管理 + *
* Created by Binary Wang on 2016/9/2. * * @author Binary Wang @@ -17,110 +25,193 @@ public interface WxMpUserTagService { *
* 创建标签
* 一个公众号,最多可以创建100个标签。
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/create?access_token=ACCESS_TOKEN
*
*
* @param name 标签名字(30个字符以内)
- * @return the wx user tag
- * @throws WxErrorException the wx error exception
+ * @return 创建的标签对象,包含标签ID等信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取公众号已创建的标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/get?access_token=ACCESS_TOKEN
*
*
- * @return the list
- * @throws WxErrorException the wx error exception
+ * @return 标签列表,包含所有已创建的标签信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 编辑标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/update?access_token=ACCESS_TOKEN
+ * 可以修改标签的名称,但不能修改标签ID。
*
*
- * @param tagId the tag id
- * @param name the name
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param name 新的标签名字(30个字符以内)
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 删除标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/delete?access_token=ACCESS_TOKEN
+ * 删除标签后,该标签下的所有用户将被取消标签。
*
*
- * @param tagId the tag id
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取标签下粉丝列表
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/user/tag/get?access_token=ACCESS_TOKEN
+ * 可用于获取某个标签下的所有用户信息,支持分页查询。
*
*
- * @param tagId the tag id
- * @param nextOpenid the next openid
- * @return the wx tag list user
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param nextOpenid 第一个拉取用户的openid,不填从头开始拉取
+ * @return 标签下粉丝列表对象,包含用户信息和分页信息
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 批量为用户打标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/members/batchtagging?access_token=ACCESS_TOKEN
+ * 可以为多个用户同时打上同一个标签。
*
*
- * @param tagId the tag id
- * @param openids the openids
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param openids 用户openid数组,不能为null或空数组
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 批量为用户取消标签
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/members/batchuntagging?access_token=ACCESS_TOKEN
+ * 可以为多个用户同时取消同一个标签。
*
*
- * @param tagId the tag id
- * @param openids the openids
- * @return the boolean
- * @throws WxErrorException the wx error exception
+ * @param tagId 标签ID,不能为null
+ * @param openids 用户openid数组,不能为null或空数组
+ * @return 操作是否成功,true表示成功,false表示失败
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ *
* 获取用户身上的标签列表
- * 详情请见:用户标签管理
- * 接口url格式: https://api.weixin.qq.com/cgi-bin/tags/getidlist?access_token=ACCESS_TOKEN
+ * 可查询某个用户被打上的所有标签ID。
*
*
- * @param openid the openid
- * @return 标签Id的列表 list
- * @throws WxErrorException the wx error exception
+ * @param openid 用户的openid,不能为null或空字符串
+ * @return 标签ID的列表,表示该用户被打上的所有标签
+ * @throws WxErrorException 微信API调用异常,可能包括:
+ * - * Created by BinaryWang on 2018/6/9. - *+ * Created by BinaryWang on 2018/6/9. * * @author Binary Wang */ @RequiredArgsConstructor public class WxMpAiOpenServiceImpl implements WxMpAiOpenService { - private final WxMpService wxMpService; + private final WxMpService wxMpService; - @Override - public void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException { - if (lang == null) { - lang = AiLangType.zh_CN; + @Override + public void uploadVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException { + if (lang == null) { + lang = AiLangType.zh_CN; + } + + this.wxMpService.execute(VoiceUploadRequestExecutor.create(this.wxMpService.getRequestHttp()), + String.format(VOICE_UPLOAD_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), "mp3", voiceId, lang.getCode()), + voiceFile); } - this.wxMpService.execute(VoiceUploadRequestExecutor.create(this.wxMpService.getRequestHttp()), - String.format(VOICE_UPLOAD_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), "mp3", voiceId, lang.getCode()), - voiceFile); - } + @Override + public String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException { + if (lang == null) { + lang = AiLangType.zh_CN; + } - @Override - public String recogniseVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException { - this.uploadVoice(voiceId, lang, voiceFile); - return this.queryRecognitionResult(voiceId, lang); - } + final String response = this.wxMpService.get(VOICE_QUERY_RESULT_URL, + String.format("voice_id=%s&lang=%s", voiceId, lang.getCode())); + WxError error = WxError.fromJson(response, WxType.MP); + if (error.getErrorCode() != 0) { + throw new WxErrorException(error); + } - @Override - public String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException { - String response = this.wxMpService.post(String.format(TRANSLATE_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), - langFrom.getCode(), langTo.getCode()), content); + return GsonParser.parse(response).get("result").getAsString(); + } - WxError error = WxError.fromJson(response, WxType.MP); - if (error.getErrorCode() != 0) { - throw new WxErrorException(error); + @Override + public String recogniseVoice(String voiceId, AiLangType lang, File voiceFile) throws WxErrorException { + this.uploadVoice(voiceId, lang, voiceFile); + return this.queryRecognitionResult(voiceId, lang); } - return GsonParser.parse(response).get("to_content").getAsString(); - } + @Override + public String translate(AiLangType langFrom, AiLangType langTo, String content) throws WxErrorException { + String response = this.wxMpService.post(String.format(TRANSLATE_URL.getUrl(this.wxMpService.getWxMpConfigStorage()), + langFrom.getCode(), langTo.getCode()), content); - @Override - public String queryRecognitionResult(String voiceId, AiLangType lang) throws WxErrorException { - if (lang == null) { - lang = AiLangType.zh_CN; - } + WxError error = WxError.fromJson(response, WxType.MP); + if (error.getErrorCode() != 0) { + throw new WxErrorException(error); + } - final String response = this.wxMpService.get(VOICE_QUERY_RESULT_URL, - String.format("voice_id=%s&lang=%s", voiceId, lang.getCode())); - WxError error = WxError.fromJson(response, WxType.MP); - if (error.getErrorCode() != 0) { - throw new WxErrorException(error); + return GsonParser.parse(response).get("to_content").getAsString(); } - - return GsonParser.parse(response).get("result").getAsString(); - } } diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceHttpComponentsImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceHttpComponentsImpl.java index bbf065acfc..c54202ad2f 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceHttpComponentsImpl.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceHttpComponentsImpl.java @@ -51,7 +51,8 @@ public void initHttp() { apacheHttpClientBuilder.httpProxyHost(configStorage.getHttpProxyHost()) .httpProxyPort(configStorage.getHttpProxyPort()) .httpProxyUsername(configStorage.getHttpProxyUsername()) - .httpProxyPassword(configStorage.getHttpProxyPassword().toCharArray()); + .httpProxyPassword(configStorage.getHttpProxyPassword() == null ? null : + configStorage.getHttpProxyPassword().toCharArray()); if (configStorage.getHttpProxyHost() != null && configStorage.getHttpProxyPort() > 0) { this.httpProxy = new HttpHost(configStorage.getHttpProxyHost(), configStorage.getHttpProxyPort()); diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceImpl.java index 79c3fad266..7cef64e576 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceImpl.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpServiceImpl.java @@ -2,11 +2,11 @@ /** *
- * 默认接口实现类,使用apache httpclient实现 + * 默认接口实现类,使用apache httpClient 5实现 * Created by Binary Wang on 2017-5-27. ** * @author Binary Wang */ -public class WxMpServiceImpl extends WxMpServiceHttpClientImpl { +public class WxMpServiceImpl extends WxMpServiceHttpComponentsImpl { } diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java index 007942f096..63a3208e4b 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpUserTagServiceImpl.java @@ -46,10 +46,10 @@ public List
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
@@ -60,6 +60,8 @@ public String toJson() {
/**
* 添加openid,最多支持10,000个
+ *
+ * @param openid 用户openid
*/
public void addUser(String openid) {
this.toUsers.add(openid);
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
index dca743c9c3..57b34d352a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassPreviewMessage.java
@@ -19,11 +19,11 @@ public class WxMpMassPreviewMessage implements Serializable {
*
* 消息类型
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
index 598e5754f1..466ef8d96f 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpMassTagMessage.java
@@ -24,11 +24,11 @@ public class WxMpMassTagMessage implements Serializable {
*
* 消息类型.
* 请使用
- * {@link WxConsts.MassMsgType#IMAGE}
- * {@link WxConsts.MassMsgType#MPNEWS}
- * {@link WxConsts.MassMsgType#TEXT}
- * {@link WxConsts.MassMsgType#MPVIDEO}
- * {@link WxConsts.MassMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPNEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#MPVIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.MassMsgType#VOICE}
* 如果msgtype和media_id不匹配的话,会返回系统繁忙的错误
*
*/
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
index 9e73b46159..ac4a596dd8 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/WxMpUserQuery.java
@@ -63,9 +63,8 @@ public WxMpUserQuery add(String openid, String lang) {
/**
* 添加一个OpenId到列表中,并返回本对象
* - *
* 该方法默认lang = zh_CN
- *
+ *
*
* @param openid openid
* @return {@link WxMpUserQuery}
@@ -100,6 +99,8 @@ public WxMpUserQuery remove(String openid, String lang) {
/**
* 获取查询参数列表
+ *
+ * @return 查询参数列表
*/
public List* 控制原生消息结构体,包含各字段的消息控制字段。 - * + *+ * + ** 用于 `7 更新会员信息` 的接口参数调用 - * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283 - *
+ * {@code 参考:会员卡接口} + *
* * @author YuJian(mgcnrx11@gmail.com) * @version 2017/7/15 diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java index 663fe1f1e5..b4ad8eb139 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUpdateResult.java @@ -6,10 +6,10 @@ import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder; /** - ** 用于 `7 更新会员信息` 的接口调用后的返回结果 - * https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283 - *+ *
+ * {@code 参考:会员卡接口} + *
* * @author YuJian(mgcnrx11@gmail.com) * @version 2017/7/15 diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java index 8fad40ccf8..9a2b47f5bf 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/card/membercard/WxMpMemberCardUserInfoResult.java @@ -6,11 +6,10 @@ import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder; /** - ** 拉取会员信息返回的结果 - * - * 字段格式参考https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283 6.2.1小节的步骤5 - *+ *
+ * {@code 字段格式参考:会员卡接口 6.2.1小节的步骤5} + *
* * @author YuJian * @version 2017/7/9 diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java index f066c1d934..01be3c08d2 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/kefu/WxMpKefuMessage.java @@ -45,6 +45,8 @@ public class WxMpKefuMessage implements Serializable { /** * 获得文本消息builder. + * + * @return 文本消息builder */ public static TextBuilder TEXT() { return new TextBuilder(); @@ -52,6 +54,8 @@ public static TextBuilder TEXT() { /** * 获得图片消息builder. + * + * @return 图片消息builder */ public static ImageBuilder IMAGE() { return new ImageBuilder(); @@ -59,6 +63,8 @@ public static ImageBuilder IMAGE() { /** * 获得语音消息builder. + * + * @return 语音消息builder */ public static VoiceBuilder VOICE() { return new VoiceBuilder(); @@ -66,6 +72,8 @@ public static VoiceBuilder VOICE() { /** * 获得视频消息builder. + * + * @return 视频消息builder */ public static VideoBuilder VIDEO() { return new VideoBuilder(); @@ -73,6 +81,8 @@ public static VideoBuilder VIDEO() { /** * 获得音乐消息builder. + * + * @return 音乐消息builder */ public static MusicBuilder MUSIC() { return new MusicBuilder(); @@ -80,6 +90,8 @@ public static MusicBuilder MUSIC() { /** * 获得图文消息(点击跳转到外链)builder. + * + * @return 图文消息builder */ public static NewsBuilder NEWS() { return new NewsBuilder(); @@ -87,6 +99,8 @@ public static NewsBuilder NEWS() { /** * 获得图文消息(点击跳转到图文消息页面)builder. + * + * @return 图文消息builder */ public static MpNewsBuilder MPNEWS() { return new MpNewsBuilder(); @@ -94,6 +108,8 @@ public static MpNewsBuilder MPNEWS() { /** * 获得卡券消息builder. + * + * @return 卡券消息builder */ public static WxCardBuilder WXCARD() { return new WxCardBuilder(); @@ -101,6 +117,8 @@ public static WxCardBuilder WXCARD() { /** * 获得菜单消息builder. + * + * @return 菜单消息builder */ public static WxMsgMenuBuilder MSGMENU() { return new WxMsgMenuBuilder(); @@ -108,20 +126,25 @@ public static WxMsgMenuBuilder MSGMENU() { /** * 小程序卡片. + * + * @return 小程序卡片builder */ public static MiniProgramPageBuilder MINIPROGRAMPAGE() { return new MiniProgramPageBuilder(); } /** - * 发送图文消息(点击跳转到图文消息页面)使用通过 “发布” 系列接口得到的 article_id(草稿箱功能上线后不再支持客服接口中带 media_id 的 mpnews 类型的图文消息) + * 发送图文消息(点击跳转到图文消息页面)使用通过 “发布” 系列接口得到的 article_id + * + * @return 图文消息builder */ public static MpNewsArticleBuilder MPNEWSARTICLE() { return new MpNewsArticleBuilder(); } /** - *+ * 设置消息类型 + *+ * + * + * @param msgType 消息类型 */ public void setMsgType(String msgType) { this.msgType = msgType; diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java index 3d5f4ac3a0..dfc88ab13b 100644 --- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java +++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlMessage.java @@ -927,6 +927,7 @@ public static WxMpXmlMessage fromXml(InputStream is) { * @param timestamp 时间戳 * @param nonce 随机串 * @param msgSignature 签名串 + * @return 解密后的消息对象 */ public static WxMpXmlMessage fromEncryptedXml(String encryptedXml, WxMpConfigStorage wxMpConfigStorage, String timestamp, String nonce, String msgSignature) { @@ -956,14 +957,16 @@ public WxMpXmlMessage decryptField(WxMpConfigStorage wxMpConfigStorage, /** ** 请使用 * {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#TEXT} * {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#IMAGE} @@ -135,7 +158,9 @@ public static MpNewsArticleBuilder MPNEWSARTICLE() { * {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#TASKCARD} * {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#MSGMENU} * {@link me.chanjar.weixin.common.api.WxConsts.KefuMsgType#MP_NEWS_ARTICLE} - *
* 当接受用户消息时,可能会获得以下值:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#LOCATION}
- * {@link WxConsts.XmlMsgType#LINK}
- * {@link WxConsts.XmlMsgType#EVENT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LOCATION}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LINK}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#EVENT}
*
+ *
+ * @return 消息类型
*/
public String getMsgType() {
return this.msgType;
@@ -972,13 +975,15 @@ public String getMsgType() {
/**
*
* 当发送消息的时候使用:
- * {@link WxConsts.XmlMsgType#TEXT}
- * {@link WxConsts.XmlMsgType#IMAGE}
- * {@link WxConsts.XmlMsgType#VOICE}
- * {@link WxConsts.XmlMsgType#VIDEO}
- * {@link WxConsts.XmlMsgType#NEWS}
- * {@link WxConsts.XmlMsgType#MUSIC}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#NEWS}
+ * {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#MUSIC}
*
+ *
+ * @param msgType 消息类型
*/
public void setMsgType(String msgType) {
this.msgType = msgType;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
index a44aea740c..1f3143df7e 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/message/WxMpXmlOutMessage.java
@@ -70,6 +70,8 @@ public abstract class WxMpXmlOutMessage implements Serializable {
/**
* 获得文本消息builder
+ *
+ * @return 文本消息构建器
*/
public static TextBuilder TEXT() {
return new TextBuilder();
@@ -77,6 +79,8 @@ public static TextBuilder TEXT() {
/**
* 获得图片消息builder
+ *
+ * @return 图片消息构建器
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
@@ -84,6 +88,8 @@ public static ImageBuilder IMAGE() {
/**
* 获得语音消息builder
+ *
+ * @return 语音消息构建器
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
@@ -91,6 +97,8 @@ public static VoiceBuilder VOICE() {
/**
* 获得视频消息builder
+ *
+ * @return 视频消息构建器
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
@@ -98,6 +106,8 @@ public static VideoBuilder VIDEO() {
/**
* 获得音乐消息builder
+ *
+ * @return 音乐消息构建器
*/
public static MusicBuilder MUSIC() {
return new MusicBuilder();
@@ -105,6 +115,8 @@ public static MusicBuilder MUSIC() {
/**
* 获得图文消息builder
+ *
+ * @return 图文消息构建器
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();
@@ -112,6 +124,8 @@ public static NewsBuilder NEWS() {
/**
* 获得客服消息builder
+ *
+ * @return 客服消息构建器
*/
public static TransferCustomerServiceBuilder TRANSFER_CUSTOMER_SERVICE() {
return new TransferCustomerServiceBuilder();
@@ -119,11 +133,18 @@ public static TransferCustomerServiceBuilder TRANSFER_CUSTOMER_SERVICE() {
/**
* 获得设备消息builder
+ *
+ * @return 设备消息builder
*/
public static DeviceBuilder DEVICE() {
return new DeviceBuilder();
}
+ /**
+ * 转换成xml格式
+ *
+ * @return xml格式字符串
+ */
@SuppressWarnings("unchecked")
public String toXml() {
return XStreamTransformer.toXml((Class* 查询群发消息发送状态【订阅号与服务号认证后均可用】 - * https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html#%E6%9F%A5%E8%AF%A2%E7%BE%A4%E5%8F%91%E6%B6%88%E6%81%AF%E5%8F%91%E9%80%81%E7%8A%B6%E6%80%81%E3%80%90%E8%AE%A2%E9%98%85%E5%8F%B7%E4%B8%8E%E6%9C%8D%E5%8A%A1%E5%8F%B7%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9D%87%E5%8F%AF%E7%94%A8%E3%80%91 + * 文档地址:https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Batch_Sends_and_Originality_Checks.html + ** @author S
* {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setRetrySleepMillis(int)}
*
+ *
+ * @return 重试间隔毫秒数
*/
int getRetrySleepMillis();
@@ -219,6 +221,8 @@ public interface WxMpConfigStorage {
*
* {@link me.chanjar.weixin.mp.api.impl.BaseWxMpServiceImpl#setMaxRetryTimes(int)}
*
+ *
+ * @return 最大重试次数
*/
int getMaxRetryTimes();
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
index 870fa1e276..7939d57a18 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java
@@ -39,6 +39,8 @@ public WxMpRedisConfigImpl(WxRedisOps redisOps, String keyPrefix) {
/**
* 每个公众号生成独有的存储key.
+ *
+ * @param appId 公众号appId
*/
@Override
public void setAppId(String appId) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
index e0d9e92af1..4982336f8a 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedissonConfigImpl.java
@@ -42,6 +42,8 @@ private WxMpRedissonConfigImpl(@NonNull WxRedisOps redisOps, String keyPrefix) {
/**
* 每个公众号生成独有的存储key.
+ *
+ * @param appId 公众号appId
*/
@Override
public void setAppId(String appId) {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
index b2e984b0f9..4dfee6295e 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/constant/WxMpEventConstants.java
@@ -20,7 +20,7 @@ public class WxMpEventConstants {
public static final String SUBMIT_MEMBERCARD_USER_INFO = "submit_membercard_user_info";
/**
- * 微信摇一摇周边>>摇一摇事件通知.
+ * 微信摇一摇周边-摇一摇事件通知.
*/
public static final String SHAKEAROUND_USER_SHAKE = "ShakearoundUserShake";
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
index 99d759f32f..7757ad78bf 100755
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/crypto/WxMpCryptUtil.java
@@ -27,7 +27,7 @@ public class WxMpCryptUtil extends me.chanjar.weixin.common.util.crypto.WxCryptU
/**
* 构造函数
*
- * @param wxMpConfigStorage
+ * @param wxMpConfigStorage 公众号配置存储
*/
public WxMpCryptUtil(WxMpConfigStorage wxMpConfigStorage) {
/*
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
index ace711a236..55e92700de 100644
--- a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
+++ b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/xml/XStreamTransformer.java
@@ -33,7 +33,12 @@ public class XStreamTransformer {
}
/**
- * xml -> pojo.
+ * {@code xml -> pojo.}
+ *
+ * @param + * 获取所有类目名称信息,用于给用户展示选择 + * https://developers.weixin.qq.com/doc/oplatform/openApi/miniprogram-management/category-management/api_getallcategoryname.html + *+ * + * @return 类目名称列表 + * @throws WxErrorException . + */ + WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException; + /** * 获取订单页Path信息 * diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java index fef85d7f2e..1033b57a16 100644 --- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java +++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java @@ -32,6 +32,11 @@ public interface WxOpenMaService extends WxMaService { */ String API_MODIFY_DOMAIN = "https://api.weixin.qq.com/wxa/modify_domain"; + /** + * 快速配置小程序服务器域名 + */ + String API_MODIFY_DOMAIN_DIRECTLY = "https://api.weixin.qq.com/wxa/modify_domain_directly"; + /** * 设置小程序业务域名(仅供第三方代小程序调用) *
@@ -44,6 +49,11 @@ public interface WxOpenMaService extends WxMaService {
*/
String API_SET_WEBVIEW_DOMAIN = "https://api.weixin.qq.com/wxa/setwebviewdomain";
+ /**
+ * 快速配置小程序业务域名
+ */
+ String API_SET_WEBVIEW_DOMAIN_DIRECTLY = "https://api.weixin.qq.com/wxa/setwebviewdomain_directly";
+
/**
* 获取业务域名校验文件(仅供第三方代小程序调用)
*/
@@ -310,6 +320,24 @@ WxOpenMaDomainResult modifyDomain(String action, List requestDomains, Li
List uploadDomains, List downloadDomains,
List udpDomains, List tcpDomains) throws WxErrorException;
+ /**
+ * 快速配置小程序服务器域名
+ * 文档地址
+ *
+ * @param action add添加, delete删除, set覆盖, get获取
+ * @param requestDomains request 合法域名;当 action 是 get 时不需要此字段
+ * @param wsRequestDomains socket 合法域名;当 action 是 get 时不需要此字段
+ * @param uploadDomains uploadFile 合法域名;当 action 是 get 时不需要此字段
+ * @param downloadDomains downloadFile 合法域名;当 action 是 get 时不需要此字段
+ * @param tcpDomains tcp 合法域名;当 action 是 get 时不需要此字段
+ * @param udpDomains udp 合法域名;当 action 是 get 时不需要此字段
+ * @return the wx open ma domain result
+ * @throws WxErrorException the wx error exception
+ */
+ WxOpenMaDomainResult modifyDomainDirectly(String action, List requestDomains, List wsRequestDomains,
+ List uploadDomains, List downloadDomains,
+ List udpDomains, List tcpDomains) throws WxErrorException;
+
/**
* 获取小程序的业务域名
*
@@ -346,6 +374,28 @@ WxOpenMaDomainResult modifyDomain(String action, List requestDomains, Li
*/
WxOpenMaWebDomainResult setWebViewDomainInfo(String action, List domainList) throws WxErrorException;
+ /**
+ * 快速配置小程序业务域名
+ * 文档地址
+ *
+ * @param action add添加, delete删除, set覆盖, get获取
+ * @param domainList the domain list
+ * @return 直接返回字符串
+ * @throws WxErrorException the wx error exception
+ */
+ String setWebViewDomainDirectly(String action, List domainList) throws WxErrorException;
+
+ /**
+ * 快速配置小程序业务域名
+ * 文档地址
+ *
+ * @param action add添加, delete删除, set覆盖, get获取
+ * @param domainList the domain list
+ * @return web view domain info
+ * @throws WxErrorException the wx error exception
+ */
+ WxOpenMaWebDomainResult setWebViewDomainDirectlyInfo(String action, List domainList) throws WxErrorException;
+
/**
* 获取业务域名校验文件
*
@@ -489,10 +539,36 @@ WxOpenMaDomainResult modifyDomain(String action, List requestDomains, Li
/**
* 将第三方提交的代码包提交审核(仅供第三方开发者代小程序调用)
+ *
+ * 重要提示:审核额度限制
+ *
+ *
+ * - 每个第三方平台账号每月有审核额度限制(默认20次,可通过 {@link #queryQuota()} 查询)
+ * - 每次调用 submitAudit 提交一个小程序审核时,会消耗1个审核额度
+ * - 建议在提交审核前,先调用 {@link #queryQuota()} 检查剩余额度
+ * - 如需增加额度,请联系微信开放平台客服
+ *
+ *
+ * 最佳实践:
+ *
+ * {@code
+ * // 1. 先查询剩余额度
+ * WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ * if (quota.getRest() <= 0) {
+ * throw new RuntimeException("审核额度不足,剩余:" + quota.getRest());
+ * }
+ *
+ * // 2. 提交审核
+ * WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ * message.setItemList(itemList);
+ * WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ * }
*
* @param submitAuditMessage the submit audit message
* @return the wx open ma submit audit result
* @throws WxErrorException the wx error exception
+ * @see #queryQuota() 查询审核额度
+ * @see #speedAudit(Long) 加急审核
*/
WxOpenMaSubmitAuditResult submitAudit(WxOpenMaSubmitAuditMessage submitAuditMessage) throws WxErrorException;
@@ -640,11 +716,43 @@ WxOpenMaDomainResult modifyDomain(String action, List requestDomains, Li
WxOpenMaGetCodePrivacyInfoResult getCodePrivacyInfo() throws WxErrorException;
/**
- * 查询服务商的当月提审限额和加急次数(Quota)
- * https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/code/query_quota.html
- *
- * @return the wx open ma query quota result
- * @throws WxErrorException the wx error exception
+ * 查询服务商的当月提交审核限额和加急次数(Quota)
+ *
+ * 文档地址:
+ * 查询额度
+ *
+ *
+ * 返回字段说明:
+ *
+ *
+ * - rest: 当月剩余提交审核次数
+ * - limit: 当月提交审核额度上限(默认20次)
+ * - speedup_rest: 剩余加急次数
+ * - speedup_limit: 加急额度上限
+ *
+ *
+ * 重要说明:
+ *
+ *
+ * - 每个第三方平台账号每月初会重置审核额度
+ * - 每次调用 {@link #submitAudit} 提交审核会消耗1个额度
+ * - 审核撤回不会返还额度
+ * - 建议在批量提交审核前,先调用此接口检查额度是否充足
+ *
+ *
+ * 使用示例:
+ *
+ * {@code
+ * WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ * System.out.println("剩余审核次数:" + quota.getRest());
+ * System.out.println("审核额度上限:" + quota.getLimit());
+ * System.out.println("剩余加急次数:" + quota.getSpeedupRest());
+ * }
+ *
+ * @return 审核额度信息
+ * @throws WxErrorException 调用微信接口失败时抛出
+ * @see #submitAudit(WxOpenMaSubmitAuditMessage) 提交审核
+ * @see #speedAudit(Long) 加急审核
*/
WxOpenMaQueryQuotaResult queryQuota() throws WxErrorException;
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenComponentServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenComponentServiceImpl.java
index 80da912bef..18940c4d20 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenComponentServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenComponentServiceImpl.java
@@ -1307,4 +1307,55 @@ public WxOpenResult applySetOrderPathInfo(WxOpenMaApplyOrderPathInfo info) throw
String response = post(OPEN_APPLY_SET_ORDER_PATH_INFO, gson.toJson(info));
return WxOpenGsonBuilder.create().fromJson(response, WxOpenResult.class);
}
+
+ @Override
+ public WxOpenMaDomainResult modifyWxaServerDomain(String action, List requestDomains, List wsRequestDomains,
+ List uploadDomains, List downloadDomains,
+ List udpDomains, List tcpDomains) throws WxErrorException {
+ JsonObject requestJson = new JsonObject();
+ requestJson.addProperty("action", action);
+ if (!"get".equals(action)) {
+ requestJson.add("requestdomain", toJsonArray(requestDomains));
+ requestJson.add("wsrequestdomain", toJsonArray(wsRequestDomains));
+ requestJson.add("uploaddomain", toJsonArray(uploadDomains));
+ requestJson.add("downloaddomain", toJsonArray(downloadDomains));
+ requestJson.add("udpdomain", toJsonArray(udpDomains));
+ requestJson.add("tcpdomain", toJsonArray(tcpDomains));
+ }
+
+ String response = post(API_MODIFY_WXA_SERVER_DOMAIN, requestJson.toString());
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaDomainResult.class);
+ }
+
+ @Override
+ public WxOpenMaDomainConfirmFileResult getDomainConfirmFile() throws WxErrorException {
+ String responseContent = post(API_GET_DOMAIN_CONFIRM_FILE, "{}");
+ return WxOpenMaDomainConfirmFileResult.fromJson(responseContent);
+ }
+
+ @Override
+ public String modifyWxaJumpDomain(String action, List domainList) throws WxErrorException {
+ JsonObject requestJson = new JsonObject();
+ requestJson.addProperty("action", action);
+ if (!"get".equals(action)) {
+ requestJson.add("webviewdomain", toJsonArray(domainList));
+ }
+ return post(API_MODIFY_WXA_JUMP_DOMAIN, requestJson.toString());
+ }
+
+ @Override
+ public WxOpenMaWebDomainResult modifyWxaJumpDomainInfo(String action, List domainList) throws WxErrorException {
+ String response = this.modifyWxaJumpDomain(action, domainList);
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaWebDomainResult.class);
+ }
+
+ private JsonArray toJsonArray(List list) {
+ JsonArray jsonArray = new JsonArray();
+ if (list != null) {
+ for (String item : list) {
+ jsonArray.add(item);
+ }
+ }
+ return jsonArray;
+ }
}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
index 84ff7b495c..c80ce03c3e 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenFastMaServiceImpl.java
@@ -152,6 +152,12 @@ public WxOpenResult modifyCategory(WxFastMaCategory category) throws WxErrorExce
return WxOpenGsonBuilder.create().fromJson(response, WxOpenResult.class);
}
+ @Override
+ public WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException {
+ String response = get(OPEN_GET_ALL_CATEGORY_NAME, "");
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaCategoryNameListResult.class);
+ }
+
/**
* 获取订单页Path信息
*
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorage.java
index 9ce7851065..c6dbc8f468 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorage.java
@@ -36,7 +36,7 @@ public String getComponentVerifyTicket() {
@Override
public void setComponentVerifyTicket(String componentVerifyTicket) {
- redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, Integer.MAX_VALUE, TimeUnit.SECONDS);
+ redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, 43200, TimeUnit.SECONDS);
}
@Override
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisTemplateConfigStorage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisTemplateConfigStorage.java
index 42034a1ffc..cb55e45ad0 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisTemplateConfigStorage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisTemplateConfigStorage.java
@@ -37,7 +37,7 @@ public String getComponentVerifyTicket() {
@Override
public void setComponentVerifyTicket(String componentVerifyTicket) {
- redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, Integer.MAX_VALUE, TimeUnit.SECONDS);
+ redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, 43200, TimeUnit.SECONDS);
}
@Override
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorage.java
index 7a3a9d79af..0de9b88d7e 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorage.java
@@ -36,7 +36,7 @@ public String getComponentVerifyTicket() {
@Override
public void setComponentVerifyTicket(String componentVerifyTicket) {
- redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, Integer.MAX_VALUE, TimeUnit.SECONDS);
+ redisOps.setValue(this.componentVerifyTicketKey, componentVerifyTicket, 43200, TimeUnit.SECONDS);
}
@Override
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
index 56d209a322..6204b1e260 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaBasicServiceImpl.java
@@ -146,6 +146,12 @@ public WxOpenResult modifyCategory(WxFastMaCategory category) throws WxErrorExce
return WxOpenGsonBuilder.create().fromJson(response, WxOpenResult.class);
}
+ @Override
+ public WxOpenMaCategoryNameListResult getAllCategoryName() throws WxErrorException {
+ String response = wxMaService.get(OPEN_GET_ALL_CATEGORY_NAME, "");
+ return WxOpenGsonBuilder.create().fromJson(response, WxOpenMaCategoryNameListResult.class);
+ }
+
/**
* 获取订单页Path信息
*
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImpl.java
index 85ce41fd0c..da9f910eb2 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImpl.java
@@ -113,6 +113,25 @@ public WxOpenMaDomainResult modifyDomain(String action, List requestDoma
return WxMaGsonBuilder.create().fromJson(response, WxOpenMaDomainResult.class);
}
+ @Override
+ public WxOpenMaDomainResult modifyDomainDirectly(String action, List requestDomains, List wsRequestDomains,
+ List uploadDomains, List downloadDomains,
+ List udpDomains, List tcpDomains) throws WxErrorException {
+ JsonObject requestJson = new JsonObject();
+ requestJson.addProperty(ACTION, action);
+ if (!ACTION_GET.equals(action)) {
+ requestJson.add("requestdomain", toJsonArray(requestDomains));
+ requestJson.add("wsrequestdomain", toJsonArray(wsRequestDomains));
+ requestJson.add("uploaddomain", toJsonArray(uploadDomains));
+ requestJson.add("downloaddomain", toJsonArray(downloadDomains));
+ requestJson.add("udpdomain", toJsonArray(udpDomains));
+ requestJson.add("tcpdomain", toJsonArray(tcpDomains));
+ }
+
+ String response = post(API_MODIFY_DOMAIN_DIRECTLY, GSON.toJson(requestJson));
+ return WxMaGsonBuilder.create().fromJson(response, WxOpenMaDomainResult.class);
+ }
+
@Override
public String getWebViewDomain() throws WxErrorException {
return setWebViewDomain(ACTION_GET, null);
@@ -140,6 +159,22 @@ public WxOpenMaWebDomainResult setWebViewDomainInfo(String action, List
return WxMaGsonBuilder.create().fromJson(response, WxOpenMaWebDomainResult.class);
}
+ @Override
+ public String setWebViewDomainDirectly(String action, List domainList) throws WxErrorException {
+ JsonObject requestJson = new JsonObject();
+ requestJson.addProperty(ACTION, action);
+ if (!ACTION_GET.equals(action)) {
+ requestJson.add("webviewdomain", toJsonArray(domainList));
+ }
+ return post(API_SET_WEBVIEW_DOMAIN_DIRECTLY, GSON.toJson(requestJson));
+ }
+
+ @Override
+ public WxOpenMaWebDomainResult setWebViewDomainDirectlyInfo(String action, List domainList) throws WxErrorException {
+ String response = this.setWebViewDomainDirectly(action, domainList);
+ return WxMaGsonBuilder.create().fromJson(response, WxOpenMaWebDomainResult.class);
+ }
+
@Override
public WxOpenMaDomainConfirmFileResult getWebviewDomainConfirmFile() throws WxErrorException {
String responseContent = post(API_GET_WEBVIEW_DOMAIN_CONFIRM_FILE, "{}");
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMessageRouter.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMessageRouter.java
index 7314bfd694..3c2c3058f4 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMessageRouter.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenMessageRouter.java
@@ -23,4 +23,29 @@ public WxMpXmlOutMessage route(final WxMpXmlMessage wxMessage, String appId) {
public WxMpXmlOutMessage route(final WxMpXmlMessage wxMessage, final Map context, String appId) {
return route(wxMessage, context, wxOpenService.getWxOpenComponentService().getWxMpServiceByAppid(appId));
}
+
+ /**
+ * 路由微信消息到小程序服务 (Route WeChat message to Mini App service)
+ *
+ * @param wxMessage the wx message
+ * @param appId the app id
+ * @return the wx mp xml out message
+ */
+ public WxMpXmlOutMessage routeForMa(final WxMpXmlMessage wxMessage, String appId) {
+ return routeForMa(wxMessage, new HashMap<>(), appId);
+ }
+
+ /**
+ * 路由微信消息到小程序服务 (Route WeChat message to Mini App service)
+ *
+ * @param wxMessage the wx message
+ * @param context the context
+ * @param appId the app id
+ * @return the wx mp xml out message
+ */
+ public WxMpXmlOutMessage routeForMa(final WxMpXmlMessage wxMessage, final Map context, String appId) {
+ // 将小程序服务放入上下文中,以便处理器可以访问 (Put Mini App service in context so handlers can access it)
+ context.put("wxOpenMaService", wxOpenService.getWxOpenComponentService().getWxMaServiceByAppid(appId));
+ return route(wxMessage, context, wxOpenService.getWxOpenComponentService().getWxMpServiceByAppid(appId));
+ }
}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java
new file mode 100644
index 0000000000..913c1971cb
--- /dev/null
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceHttpComponentsImpl.java
@@ -0,0 +1,74 @@
+package me.chanjar.weixin.open.api.impl;
+
+import me.chanjar.weixin.common.bean.result.WxMinishopImageUploadResult;
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.common.util.http.HttpClientType;
+import me.chanjar.weixin.common.util.http.MinishopUploadRequestExecutor;
+import me.chanjar.weixin.common.util.http.SimpleGetRequestExecutor;
+import me.chanjar.weixin.common.util.http.SimplePostRequestExecutor;
+import me.chanjar.weixin.common.util.http.hc.DefaultHttpComponentsClientBuilder;
+import me.chanjar.weixin.common.util.http.hc.HttpComponentsClientBuilder;
+import me.chanjar.weixin.open.api.WxOpenConfigStorage;
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.core5.http.HttpHost;
+
+import java.io.File;
+
+/**
+ * httpclient 5 实现
+ *
+ * @author zhangyl
+ */
+public class WxOpenServiceHttpComponentsImpl extends WxOpenServiceAbstractImpl {
+ private CloseableHttpClient httpClient;
+ private HttpHost httpProxy;
+
+ @Override
+ public void initHttp() {
+ WxOpenConfigStorage configStorage = this.getWxOpenConfigStorage();
+ HttpComponentsClientBuilder apacheHttpClientBuilder = DefaultHttpComponentsClientBuilder.get();
+
+ apacheHttpClientBuilder.httpProxyHost(configStorage.getHttpProxyHost())
+ .httpProxyPort(configStorage.getHttpProxyPort())
+ .httpProxyUsername(configStorage.getHttpProxyUsername())
+ .httpProxyPassword(configStorage.getHttpProxyPassword() == null ? null :
+ configStorage.getHttpProxyPassword().toCharArray());
+
+ if (configStorage.getHttpProxyHost() != null && configStorage.getHttpProxyPort() > 0) {
+ this.httpProxy = new HttpHost(configStorage.getHttpProxyHost(), configStorage.getHttpProxyPort());
+ }
+
+ this.httpClient = apacheHttpClientBuilder.build();
+
+ }
+
+ @Override
+ public CloseableHttpClient getRequestHttpClient() {
+ return httpClient;
+ }
+
+ @Override
+ public HttpHost getRequestHttpProxy() {
+ return httpProxy;
+ }
+
+ @Override
+ public HttpClientType getRequestType() {
+ return HttpClientType.HTTP_COMPONENTS;
+ }
+
+ @Override
+ public String get(String url, String queryParam) throws WxErrorException {
+ return execute(SimpleGetRequestExecutor.create(this), url, queryParam);
+ }
+
+ @Override
+ public String post(String url, String postData) throws WxErrorException {
+ return execute(SimplePostRequestExecutor.create(this), url, postData);
+ }
+
+ @Override
+ public WxMinishopImageUploadResult uploadMinishopMediaFile(String url, File file) throws WxErrorException {
+ return execute(MinishopUploadRequestExecutor.create(this), url, file);
+ }
+}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceImpl.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceImpl.java
index c807ccdf99..83e831df70 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceImpl.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/api/impl/WxOpenServiceImpl.java
@@ -3,6 +3,6 @@
/**
* @author 007
*/
-public class WxOpenServiceImpl extends WxOpenServiceApacheHttpClientImpl {
+public class WxOpenServiceImpl extends WxOpenServiceHttpComponentsImpl {
}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
index d8c1461d67..79400aa968 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenMaSubmitAuditMessage.java
@@ -10,8 +10,39 @@
/**
* 微信小程序代码包提交审核(仅供第三方开发者代小程序调用)
+ *
+ * 重要提示:审核额度限制
+ *
+ *
+ * - 每个第三方平台账号每月有审核额度限制(默认20次)
+ * - 每次调用 submitAudit 提交审核会消耗1个额度,无论审核是否通过
+ * - 建议在提交前先调用 queryQuota 检查剩余额度
+ *
+ *
+ * 使用示例:
+ *
+ * {@code
+ * // 1. 构建审核项
+ * WxMaCodeSubmitAuditItem item = new WxMaCodeSubmitAuditItem();
+ * item.setAddress("index");
+ * item.setTag("游戏");
+ * item.setFirstClass("游戏");
+ * item.setSecondClass("休闲游戏");
+ * item.setTitle("首页");
+ *
+ * // 2. 构建提交审核消息
+ * WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ * message.setItemList(Collections.singletonList(item));
+ * message.setVersionDesc("版本描述");
+ *
+ * // 3. 提交审核
+ * WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ * System.out.println("审核ID: " + result.getAuditId());
+ * }
*
* @author yqx
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#submitAudit(WxOpenMaSubmitAuditMessage)
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#queryQuota()
* created on 2018/9/13
*/
@Data
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenXmlMessage.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenXmlMessage.java
index 9185a4e030..449697c5a6 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenXmlMessage.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/message/WxOpenXmlMessage.java
@@ -299,7 +299,9 @@ public static String wxMpOutXmlMessageToEncryptedXml(WxMpXmlOutMessage message,
public static WxOpenXmlMessage fromXml(String xml) {
//修改微信变态的消息内容格式,方便解析
- xml = xml.replace("", "");
+ if (xml != null) {
+ xml = xml.replace(" ", "");
+ }
return XStreamTransformer.fromXml(WxOpenXmlMessage.class, xml);
}
@@ -321,6 +323,11 @@ public static WxOpenXmlMessage fromEncryptedXml(String encryptedXml, WxOpenConfi
WxOpenCryptUtil cryptUtil = new WxOpenCryptUtil(wxOpenConfigStorage);
String plainText = cryptUtil.decryptXml(msgSignature, timestamp, nonce, encryptedXml);
log.debug("解密后的原始xml消息内容:{}", plainText);
+
+ if (plainText == null || plainText.trim().isEmpty()) {
+ throw new WxRuntimeException("解密后的xml消息内容为空,请检查加密参数是否正确");
+ }
+
WxOpenXmlMessage wxOpenXmlMessage = fromXml(plainText);
wxOpenXmlMessage.setContext(plainText);
return wxOpenXmlMessage;
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java
new file mode 100644
index 0000000000..014a4ae84a
--- /dev/null
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaCategoryNameListResult.java
@@ -0,0 +1,75 @@
+package me.chanjar.weixin.open.bean.result;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import me.chanjar.weixin.open.util.json.WxOpenGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 获取类目名称信息的返回结果.
+ *
+ * 用于获取所有小程序类目的 ID 和名称信息,包括一级类目和二级类目。
+ *
+ *
+ * @author Binary Wang
+ * @see 官方文档
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class WxOpenMaCategoryNameListResult extends WxOpenResult {
+ private static final long serialVersionUID = 8989721350285449879L;
+
+ /**
+ * 类目名称列表.
+ */
+ @SerializedName("category_name_list")
+ private List categoryNameList;
+
+ @Override
+ public String toString() {
+ return WxOpenGsonBuilder.create().toJson(this);
+ }
+
+ /**
+ * 类目名称信息.
+ *
+ * 包含一级类目和二级类目的 ID 和名称。
+ *
+ */
+ @Data
+ public static class CategoryName implements Serializable {
+ private static final long serialVersionUID = 8989721350285449880L;
+
+ /**
+ * 一级类目ID.
+ */
+ @SerializedName("first_id")
+ private Integer firstId;
+
+ /**
+ * 一级类目名称.
+ */
+ @SerializedName("first_name")
+ private String firstName;
+
+ /**
+ * 二级类目ID.
+ */
+ @SerializedName("second_id")
+ private Integer secondId;
+
+ /**
+ * 二级类目名称.
+ */
+ @SerializedName("second_name")
+ private String secondName;
+
+ @Override
+ public String toString() {
+ return WxOpenGsonBuilder.create().toJson(this);
+ }
+ }
+}
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
index 3b02906242..0f964b5f44 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/bean/result/WxOpenMaQueryQuotaResult.java
@@ -6,7 +6,31 @@
import me.chanjar.weixin.open.util.json.WxOpenGsonBuilder;
/**
- * 微信开放平台小程序当前分阶段发布详情
+ * 微信开放平台小程序提交审核额度查询结果
+ *
+ * 用于查询第三方平台服务商的当月提交审核限额和加急次数
+ *
+ *
+ * 字段说明:
+ *
+ *
+ * - rest: 当月剩余提交审核次数
+ * - limit: 当月提交审核额度上限(默认20次,可联系微信开放平台增加)
+ * - speedupRest: 剩余加急次数
+ * - speedupLimit: 加急额度上限
+ *
+ *
+ * 重要提示:
+ *
+ *
+ * - 每次调用 submitAudit 提交小程序审核,会消耗1个审核额度
+ * - 额度每月初自动重置
+ * - 审核撤回不会返还已消耗的额度
+ * - 建议在批量提交审核前,先检查剩余额度是否充足
+ *
+ *
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#queryQuota()
+ * @see me.chanjar.weixin.open.api.WxOpenMaService#submitAudit(me.chanjar.weixin.open.bean.message.WxOpenMaSubmitAuditMessage)
*/
@Data
@EqualsAndHashCode(callSuper = true)
@@ -14,15 +38,27 @@ public class WxOpenMaQueryQuotaResult extends WxOpenResult {
private static final long serialVersionUID = 5915265985261653007L;
+ /**
+ * 当月剩余提交审核次数
+ */
@SerializedName("rest")
private Integer rest;
+ /**
+ * 当月提交审核额度上限
+ */
@SerializedName("limit")
private Integer limit;
+ /**
+ * 剩余加急次数
+ */
@SerializedName("speedup_rest")
private Integer speedupRest;
+ /**
+ * 加急额度上限
+ */
@SerializedName("speedup_limit")
private Integer speedupLimit;
diff --git a/weixin-java-open/src/main/java/me/chanjar/weixin/open/util/json/WxOpenGsonBuilder.java b/weixin-java-open/src/main/java/me/chanjar/weixin/open/util/json/WxOpenGsonBuilder.java
index 9cb4abd072..6b07438b11 100644
--- a/weixin-java-open/src/main/java/me/chanjar/weixin/open/util/json/WxOpenGsonBuilder.java
+++ b/weixin-java-open/src/main/java/me/chanjar/weixin/open/util/json/WxOpenGsonBuilder.java
@@ -1,12 +1,17 @@
package me.chanjar.weixin.open.util.json;
+import com.google.gson.ExclusionStrategy;
+import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
+import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder;
import me.chanjar.weixin.open.bean.WxOpenAuthorizerAccessToken;
import me.chanjar.weixin.open.bean.WxOpenComponentAccessToken;
import me.chanjar.weixin.open.bean.auth.WxOpenAuthorizationInfo;
import me.chanjar.weixin.open.bean.auth.WxOpenAuthorizerInfo;
import me.chanjar.weixin.open.bean.result.*;
+
+import java.io.File;
import java.util.Objects;
/**
@@ -27,6 +32,18 @@ public class WxOpenGsonBuilder {
INSTANCE.registerTypeAdapter(WxOpenAuthorizerInfoResult.class, new WxOpenAuthorizerInfoResultGsonAdapter());
INSTANCE.registerTypeAdapter(WxOpenAuthorizerOptionResult.class, new WxOpenAuthorizerOptionResultGsonAdapter());
INSTANCE.registerTypeAdapter(WxOpenAuthorizerListResult.class, new WxOpenAuthorizerListResultGsonAdapter());
+
+ INSTANCE.setExclusionStrategies(new ExclusionStrategy() {
+ @Override
+ public boolean shouldSkipField(FieldAttributes fieldAttributes) {
+ return false;
+ }
+
+ @Override
+ public boolean shouldSkipClass(Class> aClass) {
+ return aClass == File.class || aClass == ApacheHttpClientBuilder.class;
+ }
+ });
}
public static Gson create() {
diff --git a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorageTest.java b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorageTest.java
index 26a30a2040..bd82081113 100644
--- a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorageTest.java
+++ b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedisConfigStorageTest.java
@@ -128,4 +128,18 @@ public void testGetCardApiTicket() {
expired = this.wxOpenConfigStorage.isCardApiTicketExpired(appid);
Assert.assertEquals(expired, true);
}
+
+ @Test
+ public void testComponentVerifyTicketExpiration() {
+ // Test that ComponentVerifyTicket is set correctly
+ this.wxOpenConfigStorage.setComponentVerifyTicket("test_ticket_for_expiration");
+ String componentVerifyTicket = this.wxOpenConfigStorage.getComponentVerifyTicket();
+ Assert.assertEquals(componentVerifyTicket, "test_ticket_for_expiration");
+
+ // This test verifies that setComponentVerifyTicket now uses 43200 seconds (12 hours)
+ // instead of Integer.MAX_VALUE for expiration. The actual expiration test would
+ // require waiting or mocking time, which is not practical in unit tests.
+ // The change is validated by code inspection and the fact that other tokens
+ // use similar expiration patterns with specific timeouts.
+ }
}
diff --git a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorageTest.java b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorageTest.java
index 7168d93f1b..8042853de2 100644
--- a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorageTest.java
+++ b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenInRedissonConfigStorageTest.java
@@ -126,4 +126,18 @@ public void testGetCardApiTicket() {
expired = this.wxOpenConfigStorage.isCardApiTicketExpired(appid);
Assert.assertEquals(expired, true);
}
+
+ @Test
+ public void testComponentVerifyTicketExpiration() {
+ // Test that ComponentVerifyTicket is set correctly
+ this.wxOpenConfigStorage.setComponentVerifyTicket("test_ticket_for_expiration");
+ String componentVerifyTicket = this.wxOpenConfigStorage.getComponentVerifyTicket();
+ Assert.assertEquals(componentVerifyTicket, "test_ticket_for_expiration");
+
+ // This test verifies that setComponentVerifyTicket now uses 43200 seconds (12 hours)
+ // instead of Integer.MAX_VALUE for expiration. The actual expiration test would
+ // require waiting or mocking time, which is not practical in unit tests.
+ // The change is validated by code inspection and the fact that other tokens
+ // use similar expiration patterns with specific timeouts.
+ }
}
diff --git a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
index 4d8e41b59e..1de6ffe2d6 100644
--- a/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
+++ b/weixin-java-open/src/test/java/me/chanjar/weixin/open/api/impl/WxOpenMaServiceImplTest.java
@@ -306,6 +306,141 @@ public void testGetGrayReleasePlan() {
@Test
public void testQueryQuota() {
+ // 此测试方法演示如何使用审核额度查询功能
+ // 注意:实际运行需要真实的微信 API 凭据
+ /*
+ try {
+ // 查询当前审核额度
+ WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+
+ System.out.println("审核额度信息:");
+ System.out.println(" 当月剩余提交审核次数: " + quota.getRest());
+ System.out.println(" 当月提交审核额度上限: " + quota.getLimit());
+ System.out.println(" 剩余加急次数: " + quota.getSpeedupRest());
+ System.out.println(" 加急额度上限: " + quota.getSpeedupLimit());
+
+ // 检查额度是否充足
+ if (quota.getRest() <= 0) {
+ System.err.println("警告:审核额度已用尽!");
+ } else if (quota.getRest() <= 5) {
+ System.out.println("提示:审核额度即将用尽,请注意!");
+ }
+ } catch (WxErrorException e) {
+ e.printStackTrace();
+ }
+ */
+ }
+
+ /**
+ * 演示提交审核前检查额度的最佳实践
+ *
+ * 这是一个完整的示例,展示如何在提交审核前检查额度,避免额度不足导致的失败
+ *
+ */
+ @Test
+ public void testSubmitAuditWithQuotaCheck() {
+ // 此测试方法演示提交审核前的额度检查最佳实践
+ // 注意:实际运行需要真实的微信 API 凭据
+ /*
+ try {
+ // 步骤1:检查审核额度
+ WxOpenMaQueryQuotaResult quota = wxOpenMaService.queryQuota();
+ System.out.println("当前剩余审核额度: " + quota.getRest());
+
+ if (quota.getRest() <= 0) {
+ throw new RuntimeException("审核额度不足,无法提交审核。剩余额度: " + quota.getRest());
+ }
+
+ // 步骤2:准备审核数据
+ WxMaCodeSubmitAuditItem item = new WxMaCodeSubmitAuditItem();
+ item.setAddress("index");
+ item.setTag("工具");
+ item.setFirstClass("工具");
+ item.setSecondClass("效率");
+ item.setTitle("首页");
+
+ WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ message.setItemList(Collections.singletonList(item));
+ message.setVersionDesc("修复若干已知问题,优化用户体验");
+
+ // 步骤3:提交审核
+ WxOpenMaSubmitAuditResult result = wxOpenMaService.submitAudit(message);
+ System.out.println("提交审核成功,审核ID: " + result.getAuditId());
+
+ // 步骤4:再次查询额度,确认已消耗
+ quota = wxOpenMaService.queryQuota();
+ System.out.println("提交后剩余审核额度: " + quota.getRest());
+
+ } catch (WxErrorException e) {
+ System.err.println("提交审核失败: " + e.getMessage());
+ e.printStackTrace();
+ }
+ */
+ }
+
+ /**
+ * 演示批量提交审核时的额度管理策略
+ *
+ * 当需要为多个小程序提交审核时,应该先统一检查额度是否充足
+ *
+ */
+ @Test
+ public void testBatchSubmitAuditWithQuotaManagement() {
+ // 此测试方法演示批量提交审核时的额度管理策略
+ // 注意:实际运行需要真实的微信 API 凭据,以及 WxOpenComponentService 实例
+ /*
+ // 假设已经初始化了 wxOpenComponentService
+ // WxOpenComponentService wxOpenComponentService = ...;
+
+ try {
+ // 假设需要为多个小程序提交审核
+ List appIds = Arrays.asList("appid1", "appid2", "appid3");
+
+ // 步骤1:通过任意一个小程序服务查询总体额度
+ // 注意:审核额度是第三方平台级别的,所有授权小程序共享
+ WxOpenMaService firstMaService = wxOpenComponentService.getWxMaServiceByAppid(appIds.get(0));
+ WxOpenMaQueryQuotaResult quota = firstMaService.queryQuota();
+ System.out.println("当前剩余审核额度: " + quota.getRest());
+
+ if (quota.getRest() < appIds.size()) {
+ System.err.println("警告:审核额度不足!");
+ System.err.println(" 需要提交: " + appIds.size() + " 个");
+ System.err.println(" 剩余额度: " + quota.getRest());
+ System.err.println(" 缺少额度: " + (appIds.size() - quota.getRest()));
+ return;
+ }
+
+ // 步骤2:依次提交审核
+ int successCount = 0;
+ for (String appId : appIds) {
+ try {
+ WxOpenMaService maService = wxOpenComponentService.getWxMaServiceByAppid(appId);
+
+ WxOpenMaSubmitAuditMessage message = new WxOpenMaSubmitAuditMessage();
+ // ... 设置审核信息
+
+ WxOpenMaSubmitAuditResult result = maService.submitAudit(message);
+ System.out.println("AppId: " + appId + " 提交成功,审核ID: " + result.getAuditId());
+ successCount++;
+
+ } catch (WxErrorException e) {
+ System.err.println("AppId: " + appId + " 提交失败: " + e.getMessage());
+ }
+ }
+
+ // 步骤3:输出统计信息
+ System.out.println("批量提交完成:");
+ System.out.println(" 成功: " + successCount);
+ System.out.println(" 失败: " + (appIds.size() - successCount));
+
+ // 步骤4:查询剩余额度
+ quota = firstMaService.queryQuota();
+ System.out.println(" 剩余额度: " + quota.getRest());
+
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ */
}
@Test
diff --git a/weixin-java-pay/MULTI_APPID_USAGE.md b/weixin-java-pay/MULTI_APPID_USAGE.md
new file mode 100644
index 0000000000..e4a7d0b9eb
--- /dev/null
+++ b/weixin-java-pay/MULTI_APPID_USAGE.md
@@ -0,0 +1,200 @@
+# 支持一个商户号对应多个 appId 的使用说明
+
+## 背景
+
+在实际业务中,经常会遇到一个微信支付商户号需要绑定多个小程序的场景。例如:
+- 一个商家有多个小程序(主店、分店、活动小程序等)
+- 所有小程序共用同一个支付商户号
+- 支付配置(商户号、密钥、证书等)完全相同,只有 appId 不同
+
+## 解决方案
+
+WxJava 支持在配置多个相同商户号、不同 appId 的情况下,**可以仅通过商户号进行配置切换**,无需每次都指定 appId。
+
+## 使用方式
+
+### 1. 配置多个 appId
+
+```java
+WxPayService payService = new WxPayServiceImpl();
+
+String mchId = "1234567890"; // 商户号
+
+// 配置小程序1
+WxPayConfig config1 = new WxPayConfig();
+config1.setMchId(mchId);
+config1.setAppId("wx1111111111111111"); // 小程序1的appId
+config1.setMchKey("your_mch_key");
+config1.setApiV3Key("your_api_v3_key");
+// ... 其他配置
+
+// 配置小程序2
+WxPayConfig config2 = new WxPayConfig();
+config2.setMchId(mchId);
+config2.setAppId("wx2222222222222222"); // 小程序2的appId
+config2.setMchKey("your_mch_key");
+config2.setApiV3Key("your_api_v3_key");
+// ... 其他配置
+
+// 配置小程序3
+WxPayConfig config3 = new WxPayConfig();
+config3.setMchId(mchId);
+config3.setAppId("wx3333333333333333"); // 小程序3的appId
+config3.setMchKey("your_mch_key");
+config3.setApiV3Key("your_api_v3_key");
+// ... 其他配置
+
+// 添加到配置映射
+Map configMap = new HashMap<>();
+configMap.put(mchId + "_" + config1.getAppId(), config1);
+configMap.put(mchId + "_" + config2.getAppId(), config2);
+configMap.put(mchId + "_" + config3.getAppId(), config3);
+
+payService.setMultiConfig(configMap);
+```
+
+### 2. 切换配置的方式
+
+#### 方式一:精确切换(原有方式,向后兼容)
+
+```java
+// 切换到小程序1的配置
+payService.switchover("1234567890", "wx1111111111111111");
+
+// 切换到小程序2的配置
+payService.switchover("1234567890", "wx2222222222222222");
+```
+
+#### 方式二:仅使用商户号切换(新功能)
+
+```java
+// 仅使用商户号切换,会自动匹配该商户号的某个配置
+// 适用于不关心具体使用哪个 appId 的场景
+boolean success = payService.switchover("1234567890");
+```
+
+**注意**:当使用仅商户号切换时,会按照以下逻辑查找配置:
+1. 先尝试精确匹配商户号(针对只配置商户号、没有 appId 的情况)
+2. 如果未找到,则尝试前缀匹配(查找以 `商户号_` 开头的配置)
+3. 如果有多个匹配项,将返回其中任意一个匹配项,具体选择结果不保证稳定或可预测,如需确定性行为请使用精确匹配方式(同时指定商户号和 appId)
+
+#### 方式三:链式调用
+
+```java
+// 精确切换,支持链式调用
+WxPayUnifiedOrderResult result = payService
+ .switchoverTo("1234567890", "wx1111111111111111")
+ .unifiedOrder(request);
+
+// 仅商户号切换,支持链式调用
+WxPayUnifiedOrderResult result = payService
+ .switchoverTo("1234567890")
+ .unifiedOrder(request);
+```
+
+### 3. 动态添加配置
+
+```java
+// 运行时动态添加新的 appId 配置
+WxPayConfig newConfig = new WxPayConfig();
+newConfig.setMchId("1234567890");
+newConfig.setAppId("wx4444444444444444");
+// ... 其他配置
+
+payService.addConfig("1234567890", "wx4444444444444444", newConfig);
+
+// 切换到新添加的配置
+payService.switchover("1234567890", "wx4444444444444444");
+```
+
+### 4. 移除配置
+
+```java
+// 移除特定的 appId 配置
+payService.removeConfig("1234567890", "wx1111111111111111");
+```
+
+## 实际应用场景
+
+### 场景1:根据用户来源切换 appId
+
+```java
+// 在支付前,根据订单来源切换到对应小程序的配置
+String orderSource = order.getSource(); // 例如: "miniapp1", "miniapp2"
+String appId = getAppIdBySource(orderSource);
+
+// 精确切换到特定小程序
+payService.switchover(mchId, appId);
+
+// 创建订单
+WxPayUnifiedOrderRequest request = new WxPayUnifiedOrderRequest();
+// ... 设置订单参数
+WxPayUnifiedOrderResult result = payService.unifiedOrder(request);
+```
+
+### 场景2:处理支付回调
+
+```java
+@PostMapping("/pay/notify")
+public String handlePayNotify(@RequestBody String xmlData) {
+ try {
+ // 解析回调通知
+ WxPayOrderNotifyResult notifyResult = payService.parseOrderNotifyResult(xmlData);
+
+ // 注意:parseOrderNotifyResult 方法内部会自动调用
+ // switchover(notifyResult.getMchId(), notifyResult.getAppid())
+ // 切换到正确的配置进行签名验证
+
+ // 处理业务逻辑
+ processOrder(notifyResult);
+
+ return WxPayNotifyResponse.success("成功");
+ } catch (WxPayException e) {
+ log.error("支付回调处理失败", e);
+ return WxPayNotifyResponse.fail("失败");
+ }
+}
+```
+
+### 场景3:不关心具体 appId 的场景
+
+```java
+// 某些场景下,只要是该商户号的配置即可,不关心具体是哪个 appId
+// 例如:查询订单、退款等操作
+
+// 仅使用商户号切换
+payService.switchover(mchId);
+
+// 查询订单
+WxPayOrderQueryResult queryResult = payService.queryOrder(null, outTradeNo);
+
+// 申请退款
+WxPayRefundRequest refundRequest = new WxPayRefundRequest();
+// ... 设置退款参数
+WxPayRefundResult refundResult = payService.refund(refundRequest);
+```
+
+## 注意事项
+
+1. **向后兼容**:所有原有的使用方式继续有效,不需要修改现有代码。
+
+2. **配置隔离**:每个 `mchId + appId` 组合都是独立的配置,修改一个配置不会影响其他配置。
+
+3. **线程安全**:配置切换使用 `WxPayConfigHolder`(基于 `ThreadLocal`),是线程安全的。
+
+4. **自动切换**:在处理支付回调时,SDK 会自动根据回调中的 `mchId` 和 `appId` 切换到正确的配置。
+
+5. **推荐实践**:
+ - 如果知道具体的 appId,建议使用精确切换方式,避免歧义
+ - 如果使用仅商户号切换,确保该商户号下至少有一个可用的配置
+
+## 相关 API
+
+| 方法 | 参数 | 返回值 | 说明 |
+|-----|------|--------|------|
+| `switchover(String mchId, String appId)` | 商户号, appId | boolean | 精确切换到指定配置 |
+| `switchover(String mchId)` | 商户号 | boolean | 仅使用商户号切换 |
+| `switchoverTo(String mchId, String appId)` | 商户号, appId | WxPayService | 精确切换,支持链式调用 |
+| `switchoverTo(String mchId)` | 商户号 | WxPayService | 仅商户号切换,支持链式调用 |
+| `addConfig(String mchId, String appId, WxPayConfig)` | 商户号, appId, 配置 | void | 动态添加配置 |
+| `removeConfig(String mchId, String appId)` | 商户号, appId | void | 移除指定配置 |
diff --git a/weixin-java-pay/OVERSEAS_PAY.md b/weixin-java-pay/OVERSEAS_PAY.md
new file mode 100644
index 0000000000..b9da9814f9
--- /dev/null
+++ b/weixin-java-pay/OVERSEAS_PAY.md
@@ -0,0 +1,120 @@
+# 境外微信支付(Overseas WeChat Pay)支持
+
+本次更新添加了境外微信支付的支持,解决了 [Issue #3618](https://github.com/binarywang/WxJava/issues/3618) 中提到的问题。
+
+## 问题背景
+
+境外微信支付需要使用新的API接口地址和额外的参数:
+- 使用不同的基础URL: `https://apihk.mch.weixin.qq.com`
+- 需要额外的参数: `trade_type` 和 `merchant_category_code`
+- 使用不同的API端点: `/global/v3/transactions/*`
+
+## 新增功能
+
+### 1. GlobalTradeTypeEnum
+新的枚举类,定义了境外支付的交易类型和对应的API端点:
+- `APP`: `/global/v3/transactions/app`
+- `JSAPI`: `/global/v3/transactions/jsapi`
+- `NATIVE`: `/global/v3/transactions/native`
+- `H5`: `/global/v3/transactions/h5`
+
+### 2. WxPayUnifiedOrderV3GlobalRequest
+扩展的请求类,包含境外支付必需的额外字段:
+- `trade_type`: 交易类型 (JSAPI, APP, NATIVE, H5)
+- `merchant_category_code`: 商户类目代码(境外商户必填)
+
+### 3. 新的服务方法
+- `createOrderV3Global()`: 创建境外支付订单
+- `unifiedOrderV3Global()`: 境外统一下单接口
+
+## 使用示例
+
+### JSAPI支付示例
+```java
+// 创建境外支付请求
+WxPayUnifiedOrderV3GlobalRequest request = new WxPayUnifiedOrderV3GlobalRequest();
+request.setOutTradeNo(RandomUtils.getRandomStr());
+request.setDescription("境外商品购买");
+request.setNotifyUrl("https://your-domain.com/notify");
+
+// 设置金额
+WxPayUnifiedOrderV3GlobalRequest.Amount amount = new WxPayUnifiedOrderV3GlobalRequest.Amount();
+amount.setCurrency(WxPayConstants.CurrencyType.CNY);
+amount.setTotal(100); // 1元,单位为分
+request.setAmount(amount);
+
+// 设置支付者
+WxPayUnifiedOrderV3GlobalRequest.Payer payer = new WxPayUnifiedOrderV3GlobalRequest.Payer();
+payer.setOpenid("用户的openid");
+request.setPayer(payer);
+
+// 设置境外支付必需的参数
+request.setTradeType("JSAPI");
+request.setMerchantCategoryCode("5812"); // 商户类目代码
+
+// 调用境外支付接口
+WxPayUnifiedOrderV3Result.JsapiResult result = payService.createOrderV3Global(
+ GlobalTradeTypeEnum.JSAPI,
+ request
+);
+```
+
+### APP支付示例
+```java
+WxPayUnifiedOrderV3GlobalRequest request = new WxPayUnifiedOrderV3GlobalRequest();
+// ... 设置基础信息 ...
+
+request.setTradeType("APP");
+request.setMerchantCategoryCode("5812");
+request.setPayer(new WxPayUnifiedOrderV3GlobalRequest.Payer()); // APP支付不需要openid
+
+WxPayUnifiedOrderV3Result.AppResult result = payService.createOrderV3Global(
+ GlobalTradeTypeEnum.APP,
+ request
+);
+```
+
+### NATIVE支付示例
+```java
+WxPayUnifiedOrderV3GlobalRequest request = new WxPayUnifiedOrderV3GlobalRequest();
+// ... 设置基础信息 ...
+
+request.setTradeType("NATIVE");
+request.setMerchantCategoryCode("5812");
+request.setPayer(new WxPayUnifiedOrderV3GlobalRequest.Payer());
+
+String codeUrl = payService.createOrderV3Global(
+ GlobalTradeTypeEnum.NATIVE,
+ request
+);
+```
+
+## 配置说明
+
+境外支付使用相同的 `WxPayConfig` 配置,无需特殊设置:
+
+```java
+WxPayConfig config = new WxPayConfig();
+config.setAppId("你的AppId");
+config.setMchId("你的境外商户号");
+config.setMchKey("你的商户密钥");
+config.setNotifyUrl("https://your-domain.com/notify");
+
+// V3相关配置
+config.setPrivateKeyPath("你的私钥文件路径");
+config.setCertSerialNo("你的商户证书序列号");
+config.setApiV3Key("你的APIv3密钥");
+```
+
+**注意**: 境外支付会自动使用 `https://apihk.mch.weixin.qq.com` 作为基础URL,无需手动设置。
+
+## 兼容性
+
+- 完全向后兼容,不影响现有的国内支付功能
+- 使用相同的配置类和结果类
+- 遵循现有的代码风格和架构模式
+
+## 参考文档
+
+- [境外微信支付文档](https://pay.weixin.qq.com/doc/global/v3/zh/4013014223)
+- [原始Issue #3618](https://github.com/binarywang/WxJava/issues/3618)
\ No newline at end of file
diff --git a/weixin-java-pay/REAL_NAME_USAGE.md b/weixin-java-pay/REAL_NAME_USAGE.md
new file mode 100644
index 0000000000..867bca9ce2
--- /dev/null
+++ b/weixin-java-pay/REAL_NAME_USAGE.md
@@ -0,0 +1,143 @@
+# 微信支付实名验证接口使用说明
+
+## 概述
+
+微信支付实名验证接口允许商户查询用户的实名认证状态,如果用户未实名认证,接口会返回引导用户进行实名认证的URL。
+
+## 官方文档
+
+https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+
+## 接口说明
+
+### 查询用户实名认证信息
+
+- **接口地址**:`https://api.mch.weixin.qq.com/userinfo/realnameauth/query`
+- **请求方式**:POST(需要使用商户证书)
+- **请求参数**:
+ - `appid`:公众账号ID(自动填充)
+ - `mch_id`:商户号(自动填充)
+ - `openid`:用户在商户appid下的唯一标识
+ - `nonce_str`:随机字符串(自动生成)
+ - `sign`:签名(自动生成)
+
+- **返回参数**:
+ - `return_code`:返回状态码
+ - `return_msg`:返回信息
+ - `result_code`:业务结果
+ - `openid`:用户标识
+ - `is_certified`:实名认证状态(Y-已实名认证,N-未实名认证)
+ - `cert_info`:实名认证信息(加密,仅已实名时返回)
+ - `guide_url`:引导用户进行实名认证的URL(仅未实名时返回)
+
+## 使用示例
+
+### 1. 获取实名验证服务
+
+```java
+// 获取WxPayService实例
+WxPayService wxPayService = ... // 根据你的配置初始化
+
+// 获取实名验证服务
+RealNameService realNameService = wxPayService.getRealNameService();
+```
+
+### 2. 查询用户实名认证状态(完整方式)
+
+```java
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+try {
+ // 构建请求对象
+ RealNameRequest request = RealNameRequest.newBuilder()
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 用户的openid
+ .build();
+
+ // 调用查询接口
+ RealNameResult result = realNameService.queryRealName(request);
+
+ // 处理返回结果
+ if ("Y".equals(result.getIsCertified())) {
+ System.out.println("用户已实名认证");
+ System.out.println("认证信息:" + result.getCertInfo());
+ } else {
+ System.out.println("用户未实名认证");
+ System.out.println("引导链接:" + result.getGuideUrl());
+ // 可以将guide_url提供给用户,引导其完成实名认证
+ }
+} catch (WxPayException e) {
+ System.err.println("查询失败:" + e.getMessage());
+}
+```
+
+### 3. 查询用户实名认证状态(简化方式)
+
+```java
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+try {
+ // 直接传入openid进行查询
+ RealNameResult result = realNameService.queryRealName("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o");
+
+ // 处理返回结果
+ if ("Y".equals(result.getIsCertified())) {
+ System.out.println("用户已实名认证");
+ } else {
+ System.out.println("用户未实名认证,引导链接:" + result.getGuideUrl());
+ }
+} catch (WxPayException e) {
+ System.err.println("查询失败:" + e.getMessage());
+}
+```
+
+## 注意事项
+
+1. **证书要求**:本接口需要使用商户证书进行请求,请确保已正确配置商户证书。
+
+2. **OPENID获取**:openid是用户在商户appid下的唯一标识,需要通过微信公众平台或小程序获取。
+
+3. **认证信息**:`cert_info`字段返回的信息是加密的,需要使用相应的解密方法才能获取明文信息。
+
+4. **引导链接**:当用户未实名时,返回的`guide_url`可以用于引导用户完成实名认证,建议在小程序或H5页面中使用。
+
+5. **频率限制**:请注意接口调用频率限制,避免频繁查询同一用户的实名状态。
+
+## 业务场景
+
+- **转账前校验**:在进行企业付款到零钱等操作前,可以先查询用户的实名认证状态
+- **风控审核**:作为业务风控的一部分,确认用户已完成实名认证
+- **用户引导**:发现用户未实名时,引导用户完成实名认证以使用相关功能
+
+## 错误处理
+
+```java
+try {
+ RealNameResult result = realNameService.queryRealName(openid);
+ // 处理结果...
+} catch (WxPayException e) {
+ // 处理异常
+ String errorCode = e.getErrCode();
+ String errorMsg = e.getErrCodeDes();
+
+ // 根据错误码进行相应处理
+ switch (errorCode) {
+ case "SYSTEMERROR":
+ // 系统错误,建议稍后重试
+ break;
+ case "PARAM_ERROR":
+ // 参数错误,检查openid是否正确
+ break;
+ default:
+ // 其他错误
+ break;
+ }
+}
+```
+
+## 相关链接
+
+- [微信支付官方文档](https://pay.wechatpay.cn/doc/v2/merchant/4011987607)
+- [WxJava项目主页](https://github.com/binarywang/WxJava)
diff --git a/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md b/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md
new file mode 100644
index 0000000000..acc8f269b8
--- /dev/null
+++ b/weixin-java-pay/SUBSCRIPTION_BILLING_USAGE.md
@@ -0,0 +1,194 @@
+# 微信支付预约扣费功能使用说明
+
+## 概述
+
+微信支付预约扣费功能(连续包月功能)允许商户在用户授权的情况下,按照约定的时间和金额,自动从用户的支付账户中扣取费用。主要适用于连续包月、订阅服务等场景。
+
+## 功能特性
+
+- **预约扣费**:创建未来某个时间点的扣费计划
+- **查询预约**:查询已创建的扣费计划状态
+- **取消预约**:取消已创建的扣费计划
+- **立即扣费**:立即执行扣费操作
+- **扣费记录查询**:查询历史扣费记录
+
+## 快速开始
+
+### 1. 获取服务实例
+
+```java
+// 通过 WxPayService 获取预约扣费服务
+SubscriptionBillingService subscriptionService = wxPayService.getSubscriptionBillingService();
+```
+
+### 2. 创建预约扣费
+
+```java
+// 创建预约扣费请求
+SubscriptionScheduleRequest request = new SubscriptionScheduleRequest();
+request.setOutTradeNo("subscription_" + System.currentTimeMillis());
+request.setOpenid("用户的openid");
+request.setDescription("腾讯视频VIP会员");
+request.setScheduleTime("2024-09-01T10:00:00+08:00");
+
+// 设置扣费金额
+SubscriptionAmount amount = new SubscriptionAmount();
+amount.setTotal(3000); // 30元,单位为分
+amount.setCurrency("CNY");
+request.setAmount(amount);
+
+// 设置扣费计划(可选)
+BillingPlan billingPlan = new BillingPlan();
+billingPlan.setPlanType("MONTHLY"); // 按月扣费
+billingPlan.setPeriod(1); // 每1个月
+billingPlan.setTotalCount(12); // 总共12次
+request.setBillingPlan(billingPlan);
+
+// 发起预约扣费
+SubscriptionScheduleResult result = subscriptionService.scheduleSubscription(request);
+System.out.println("预约扣费ID: " + result.getSubscriptionId());
+```
+
+### 3. 查询预约扣费
+
+```java
+// 通过预约扣费ID查询
+String subscriptionId = "从预约扣费结果中获取的ID";
+SubscriptionQueryResult queryResult = subscriptionService.querySubscription(subscriptionId);
+System.out.println("预约状态: " + queryResult.getStatus());
+```
+
+### 4. 取消预约扣费
+
+```java
+// 创建取消请求
+SubscriptionCancelRequest cancelRequest = new SubscriptionCancelRequest();
+cancelRequest.setSubscriptionId(subscriptionId);
+cancelRequest.setCancelReason("用户主动取消");
+
+// 取消预约扣费
+SubscriptionCancelResult cancelResult = subscriptionService.cancelSubscription(cancelRequest);
+System.out.println("取消结果: " + cancelResult.getStatus());
+```
+
+### 5. 立即扣费
+
+```java
+// 创建立即扣费请求
+SubscriptionInstantBillingRequest instantRequest = new SubscriptionInstantBillingRequest();
+instantRequest.setOutTradeNo("instant_" + System.currentTimeMillis());
+instantRequest.setOpenid("用户的openid");
+instantRequest.setDescription("补扣上月会员费");
+
+// 设置扣费金额
+SubscriptionAmount instantAmount = new SubscriptionAmount();
+instantAmount.setTotal(3000); // 30元
+instantAmount.setCurrency("CNY");
+instantRequest.setAmount(instantAmount);
+
+// 执行立即扣费
+SubscriptionInstantBillingResult instantResult = subscriptionService.instantBilling(instantRequest);
+System.out.println("扣费结果: " + instantResult.getTradeState());
+```
+
+### 6. 查询扣费记录
+
+```java
+// 创建查询请求
+SubscriptionTransactionQueryRequest queryRequest = new SubscriptionTransactionQueryRequest();
+queryRequest.setOpenid("用户的openid");
+queryRequest.setBeginTime("2024-08-01T00:00:00+08:00");
+queryRequest.setEndTime("2024-08-31T23:59:59+08:00");
+queryRequest.setLimit(20);
+queryRequest.setOffset(0);
+
+// 查询扣费记录
+SubscriptionTransactionQueryResult transactionResult = subscriptionService.queryTransactions(queryRequest);
+System.out.println("总记录数: " + transactionResult.getTotalCount());
+for (SubscriptionTransactionQueryResult.SubscriptionTransaction transaction : transactionResult.getData()) {
+ System.out.println("订单号: " + transaction.getOutTradeNo() + ", 状态: " + transaction.getTradeState());
+}
+```
+
+## 扣费计划类型
+
+- `MONTHLY`:按月扣费
+- `WEEKLY`:按周扣费
+- `DAILY`:按日扣费
+- `YEARLY`:按年扣费
+
+## 预约状态说明
+
+- `SCHEDULED`:已预约
+- `CANCELLED`:已取消
+- `EXECUTED`:已执行
+- `FAILED`:执行失败
+
+## 交易状态说明
+
+- `SUCCESS`:支付成功
+- `REFUND`:转入退款
+- `NOTPAY`:未支付
+- `CLOSED`:已关闭
+- `REVOKED`:已撤销(刷卡支付)
+- `USERPAYING`:用户支付中
+- `PAYERROR`:支付失败
+
+## 注意事项
+
+1. **用户授权**:使用预约扣费功能前,需要用户在微信内完成签约授权
+2. **商户资质**:需要具备相应的业务资质才能开通此功能
+3. **金额限制**:扣费金额需要在签约模板规定的范围内
+4. **频率限制**:API调用有频率限制,请注意控制调用频次
+5. **异常处理**:建议对所有API调用进行异常处理
+
+## 相关文档
+
+- [微信支付预约扣费API文档](https://pay.weixin.qq.com/doc/v3/merchant/4012161105)
+- [微信支付开发指南](https://pay.weixin.qq.com/wiki/doc/apiv3/index.shtml)
+
+## 示例完整代码
+
+```java
+import com.github.binarywang.wxpay.service.SubscriptionBillingService;
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+
+public class SubscriptionBillingExample {
+
+ private SubscriptionBillingService subscriptionService;
+
+ public void example() throws Exception {
+ // 1. 创建预约扣费
+ SubscriptionScheduleRequest request = new SubscriptionScheduleRequest();
+ request.setOutTradeNo("subscription_" + System.currentTimeMillis());
+ request.setOpenid("用户openid");
+ request.setDescription("VIP会员续费");
+ request.setScheduleTime("2024-09-01T10:00:00+08:00");
+
+ SubscriptionAmount amount = new SubscriptionAmount();
+ amount.setTotal(3000);
+ amount.setCurrency("CNY");
+ request.setAmount(amount);
+
+ BillingPlan plan = new BillingPlan();
+ plan.setPlanType("MONTHLY");
+ plan.setPeriod(1);
+ plan.setTotalCount(12);
+ request.setBillingPlan(plan);
+
+ SubscriptionScheduleResult result = subscriptionService.scheduleSubscription(request);
+
+ // 2. 查询预约状态
+ SubscriptionQueryResult query = subscriptionService.querySubscription(result.getSubscriptionId());
+
+ // 3. 如需取消
+ if ("SCHEDULED".equals(query.getStatus())) {
+ SubscriptionCancelRequest cancelReq = new SubscriptionCancelRequest();
+ cancelReq.setSubscriptionId(result.getSubscriptionId());
+ cancelReq.setCancelReason("用户取消");
+
+ SubscriptionCancelResult cancelResult = subscriptionService.cancelSubscription(cancelReq);
+ }
+ }
+}
+```
\ No newline at end of file
diff --git a/weixin-java-pay/pom.xml b/weixin-java-pay/pom.xml
index f2d03845b0..43851df85d 100644
--- a/weixin-java-pay/pom.xml
+++ b/weixin-java-pay/pom.xml
@@ -5,7 +5,7 @@
com.github.binarywang
wx-java
- 4.7.8.B
+ 4.8.0
4.0.0
@@ -34,6 +34,14 @@
jodd-util
6.1.0
- * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_5.shtml + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012476670 **/ @Data @@ -88,4 +88,19 @@ public class SpWithdrawRequest implements Serializable { @SerializedName(value = "account_type") private String accountType; + /** + *
+ * 字段名:回调通知地址 + * 变量名:notify_url + * 是否必填:否 + * 类型:string(256) + * 描述: + * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。 + * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。 + * 示例值:https://www.weixin.qq.com/wxpay/pay.php + *+ */ + @SerializedName(value = "notify_url") + private String notifyUrl; + } diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java new file mode 100644 index 0000000000..11749ef117 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawRequest.java @@ -0,0 +1,125 @@ +package com.github.binarywang.wxpay.bean.ecommerce; + +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 二级商户按日终余额预约提现 + *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328143 + *+ * + * @author copilot + * created on 2024/12/24 + */ +@Data +@NoArgsConstructor +public class SubDayEndBalanceWithdrawRequest implements Serializable { + + private static final long serialVersionUID = -8745123456789012345L; + + /** + *
+ * 字段名:二级商户号 + * 变量名:sub_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 电商平台二级商户号,由微信支付生成并下发。 + * 示例值:1900000109 + *+ */ + @SerializedName(value = "sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:商户提现单号 + * 变量名:out_request_no + * 是否必填:是 + * 类型:string(32) + * 描述: + * 必须是字母数字 + * 示例值:20190611222222222200000000012122 + *+ */ + @SerializedName(value = "out_request_no") + private String outRequestNo; + + /** + *
+ * 字段名:提现金额 + * 变量名:amount + * 是否必填:是 + * 类型:int64 + * 描述: + * 提现金额(单位:分) + * 示例值:100 + *+ */ + @SerializedName(value = "amount") + private Integer amount; + + /** + *
+ * 字段名:备注 + * 变量名:remark + * 是否必填:否 + * 类型:string(56) + * 描述: + * 商户对提现单的备注 + * 示例值:交易提现 + *+ */ + @SerializedName(value = "remark") + private String remark; + + /** + *
+ * 字段名:银行附言 + * 变量名:bank_memo + * 是否必填:否 + * 类型:string(32) + * 描述: + * 展示在收款银行系统中的附言,数字、字母最长32个汉字(能否成功展示依赖银行系统支持)。 + * 示例值:微信支付提现 + *+ */ + @SerializedName(value = "bank_memo") + private String bankMemo; + + /** + *
+ * 字段名:出款账户类型 + * 变量名:account_type + * 是否必填:是 + * 类型:string(16) + * 描述: + * 枚举值: + * BASIC:基本户 + * OPERATION:运营账户 + * FEES:手续费账户 + * 示例值:BASIC + *+ */ + @SerializedName(value = "account_type") + private String accountType; + + /** + *
+ * 字段名:回调通知地址 + * 变量名:notify_url + * 是否必填:否 + * 类型:string(256) + * 描述: + * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。 + * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。 + * 示例值:https://www.weixin.qq.com/wxpay/pay.php + *+ */ + @SerializedName(value = "notify_url") + private String notifyUrl; +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java new file mode 100644 index 0000000000..f64eacb7b2 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawResult.java @@ -0,0 +1,99 @@ +package com.github.binarywang.wxpay.bean.ecommerce; + +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 二级商户按日终余额预约提现结果 + *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328143 + *+ * + * @author copilot + * created on 2024/12/24 + */ +@Data +@NoArgsConstructor +public class SubDayEndBalanceWithdrawResult implements Serializable { + + private static final long serialVersionUID = -8745123456789012346L; + + /** + *
+ * 字段名:二级商户号 + * 变量名:sub_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 电商平台二级商户号,由微信支付生成并下发。 + * 示例值:1900000109 + *+ */ + @SerializedName(value = "sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:电商平台商户号 + * 变量名:sp_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 电商平台商户号 + * 示例值:1800000123 + *+ */ + @SerializedName(value = "sp_mchid") + private String spMchid; + + /** + *
+ * 字段名:商户提现单号 + * 变量名:out_request_no + * 是否必填:是 + * 类型:string(32) + * 描述: + * 商户提现单号,由商户自定义生成。 + * 示例值:20190611222222222200000000012122 + *+ */ + @SerializedName(value = "out_request_no") + private String outRequestNo; + + /** + *
+ * 字段名:微信支付提现单号 + * 变量名:withdraw_id + * 是否必填:是 + * 类型:string(128) + * 描述: + * 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。 + * 示例值:12321937198237912739132791732912793127931279317929791239112123 + *+ */ + @SerializedName(value = "withdraw_id") + private String withdrawId; + + /** + *
+ * 字段名:提现单状态 + * 变量名:status + * 是否必填:是 + * 类型:string(16) + * 描述: + * 枚举值: + * CREATE_SUCCESS:受理成功 + * SUCCESS:提现成功 + * FAIL:提现失败 + * REFUND:提现退票 + * CLOSE:关单 + * INIT:业务单已创建 + * 示例值:CREATE_SUCCESS + *+ */ + @SerializedName(value = "status") + private String status; +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java new file mode 100644 index 0000000000..c642ab15d2 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubDayEndBalanceWithdrawStatusResult.java @@ -0,0 +1,261 @@ +package com.github.binarywang.wxpay.bean.ecommerce; + +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 查询二级商户按日终余额预约提现状态 + *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013328163 + *+ * + * @author copilot + * created on 2024/12/24 + */ +@Data +@NoArgsConstructor +public class SubDayEndBalanceWithdrawStatusResult implements Serializable { + + private static final long serialVersionUID = -8745123456789012347L; + + /** + *
+ * 字段名:二级商户号 + * 变量名:sub_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 电商平台二级商户号,由微信支付生成并下发。 + * 示例值:1900000109 + *+ */ + @SerializedName(value = "sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:电商平台商户号 + * 变量名:sp_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 电商平台商户号 + * 示例值:1800000123 + *+ */ + @SerializedName(value = "sp_mchid") + private String spMchid; + + /** + *
+ * 字段名:提现单状态 + * 变量名:status + * 是否必填:是 + * 类型:string(16) + * 描述: + * 枚举值: + * CREATE_SUCCESS:受理成功 + * SUCCESS:提现成功 + * FAIL:提现失败 + * REFUND:提现退票 + * CLOSE:关单 + * INIT:业务单已创建 + * 示例值:CREATE_SUCCESS + *+ */ + @SerializedName(value = "status") + private String status; + + /** + *
+ * 字段名:微信支付提现单号 + * 变量名:withdraw_id + * 是否必填:是 + * 类型:string(128) + * 描述: + * 电商平台提交二级商户提现申请后,由微信支付返回的申请单号,作为查询申请状态的唯一标识。 + * 示例值:12321937198237912739132791732912793127931279317929791239112123 + *+ */ + @SerializedName(value = "withdraw_id") + private String withdrawId; + + /** + *
+ * 字段名:商户提现单号 + * 变量名:out_request_no + * 是否必填:是 + * 类型:string(32) + * 描述: + * 商户提现单号,由商户自定义生成。 + * 示例值:20190611222222222200000000012122 + *+ */ + @SerializedName(value = "out_request_no") + private String outRequestNo; + + /** + *
+ * 字段名:提现金额 + * 变量名:amount + * 是否必填:是 + * 类型:int64 + * 描述: + * 单位:分 + * 示例值:1 + *+ */ + @SerializedName(value = "amount") + private Integer amount; + + /** + *
+ * 字段名:发起提现时间 + * 变量名:create_time + * 是否必填:是 + * 类型:string(29) + * 描述: + * 遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE, + * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒, + * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 + * 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 + * 示例值:2015-05-20T13:29:35.120+08:00 + *+ */ + @SerializedName(value = "create_time") + private String createTime; + + /** + *
+ * 字段名:提现状态更新时间 + * 变量名:update_time + * 是否必填:是 + * 类型:string(29) + * 描述: + * 遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE, + * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒, + * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 + * 例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 + * 示例值:2015-05-20T13:29:35.120+08:00 + *+ */ + @SerializedName(value = "update_time") + private String updateTime; + + /** + *
+ * 字段名:失败原因 + * 变量名:reason + * 是否必填:否 + * 类型:string(255) + * 描述: + * 仅在提现失败、退票、关单时有值 + * 示例值:卡号错误 + *+ */ + @SerializedName(value = "reason") + private String reason; + + /** + *
+ * 字段名:提现备注 + * 变量名:remark + * 是否必填:否 + * 类型:string(56) + * 描述: + * 商户对提现单的备注,若发起提现时未传入相应值或输入不合法,则该值为空 + * 示例值:交易提现 + *+ */ + @SerializedName(value = "remark") + private String remark; + + /** + *
+ * 字段名:银行附言 + * 变量名:bank_memo + * 是否必填:否 + * 类型:string(32) + * 描述: + * 展示在收款银行系统中的附言,由数字、字母、汉字组成(能否成功展示依赖银行系统支持)。若发起提现时未传入相应值或输入不合法,则该值为空 + * 示例值:微信提现 + *+ */ + @SerializedName(value = "bank_memo") + private String bankMemo; + + /** + *
+ * 字段名:出款账户类型 + * 变量名:account_type + * 是否必填:是 + * 类型:string(16) + * 描述: + * BASIC:基本户 + * OPERATION:运营账户 + * FEES:手续费账户 + * 示例值:BASIC + *+ */ + @SerializedName(value = "account_type") + private String accountType; + + /** + *
+ * 字段名:提现失败解决方案 + * 变量名:solution + * 是否必填:否 + * 类型:string(255) + * 描述: + * 仅在提现失败、退票、关单时有值 + * 示例值:请修改结算银行卡信息 + *+ */ + @SerializedName(value = "solution") + private String solution; + + /** + *
+ * 字段名:出款户名 + * 变量名:account_name + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款户名(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "account_name") + private String accountName; + + /** + *
+ * 字段名:出款账号 + * 变量名:account_number + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款账号(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "account_number") + private String accountNumber; + + /** + *
+ * 字段名:出款银行全称(含支行) + * 变量名:bank_name + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款银行全称(含支行)(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "bank_name") + private String bankName; +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java index 3c74db24c9..541d779a30 100644 --- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/SubWithdrawRequest.java @@ -9,7 +9,7 @@ /** * 二级商户账户余额提现 *
- * 文档地址:https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/pay/combine/chapter3_3.shtml + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012476652 **/ @Data @@ -86,4 +86,19 @@ public class SubWithdrawRequest implements Serializable { @SerializedName(value = "bank_memo") private String bankMemo; + /** + *
+ * 字段名:回调通知地址 + * 变量名:notify_url + * 是否必填:否 + * 类型:string(256) + * 描述: + * 异步接收提现状态变更通知的回调地址,通知url必须为外网可访问的url,不能携带参数。 + * 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效,优先回调当前传的地址。 + * 示例值:https://www.weixin.qq.com/wxpay/pay.php + *+ */ + @SerializedName(value = "notify_url") + private String notifyUrl; + } diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java new file mode 100644 index 0000000000..c5223dd123 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/ecommerce/WithdrawNotifyResult.java @@ -0,0 +1,266 @@ +package com.github.binarywang.wxpay.bean.ecommerce; + +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + * 提现状态变更通知结果 + *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4013049135 + *+ * + * @author copilot + * created on 2024/12/24 + */ +@Data +@NoArgsConstructor +public class WithdrawNotifyResult implements Serializable { + + private static final long serialVersionUID = -7451351849088368701L; + + /** + * 源数据 + */ + private NotifyResponse rawData; + + /** + *
+ * 字段名:电商平台商户号 + * 变量名:sp_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 微信支付分配给电商平台的商户号 + * 示例值:1900000100 + *+ */ + @SerializedName(value = "sp_mchid") + private String spMchid; + + /** + *
+ * 字段名:二级商户号 + * 变量名:sub_mchid + * 是否必填:否 + * 类型:string(32) + * 描述: + * 微信支付分配给二级商户的商户号,仅二级商户提现时返回 + * 示例值:1900000109 + *+ */ + @SerializedName(value = "sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:商户提现单号 + * 变量名:out_request_no + * 是否必填:是 + * 类型:string(32) + * 描述: + * 商户提现单号,由商户自定义生成 + * 示例值:20190611222222222200000000012122 + *+ */ + @SerializedName(value = "out_request_no") + private String outRequestNo; + + /** + *
+ * 字段名:微信支付提现单号 + * 变量名:withdraw_id + * 是否必填:是 + * 类型:string(32) + * 描述: + * 微信支付提现单号 + * 示例值:12321002198704230011101200 + *+ */ + @SerializedName(value = "withdraw_id") + private String withdrawId; + + /** + *
+ * 字段名:提现状态 + * 变量名:status + * 是否必填:是 + * 类型:string(16) + * 描述: + * 提现状态: + * CREATE_SUCCESS:受理成功 + * SUCCESS:提现成功 + * FAILED:提现失败 + * REFUND:提现退票 + * CLOSE:关单 + * 示例值:SUCCESS + *+ */ + @SerializedName(value = "status") + private String status; + + /** + *
+ * 字段名:提现金额 + * 变量名:amount + * 是否必填:是 + * 类型:int64 + * 描述: + * 提现金额,单位:分(人民币) + * 示例值:100 + *+ */ + @SerializedName(value = "amount") + private Integer amount; + + /** + *
+ * 字段名:提现发起时间 + * 变量名:create_time + * 是否必填:是 + * 类型:string(29) + * 描述: + * 提现发起时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE, + * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒, + * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 + * 例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日13点29分35秒 + * 示例值:2018-06-08T10:34:56+08:00 + *+ */ + @SerializedName(value = "create_time") + private String createTime; + + /** + *
+ * 字段名:提现更新时间 + * 变量名:update_time + * 是否必填:是 + * 类型:string(29) + * 描述: + * 提现更新时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss:sss+TIMEZONE, + * YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss:sss表示时分秒毫秒, + * TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。 + * 例如:2015-05-20T13:29:35.120+08:00表示,北京时间2015年5月20日13点29分35秒 + * 示例值:2018-06-08T10:34:56+08:00 + *+ */ + @SerializedName(value = "update_time") + private String updateTime; + + /** + *
+ * 字段名:失败原因 + * 变量名:reason + * 是否必填:否 + * 类型:string(256) + * 描述: + * 提现失败原因,仅在提现失败、退票时有值 + * 示例值:账户余额不足 + *+ */ + @SerializedName(value = "reason") + private String reason; + + /** + *
+ * 字段名:备注 + * 变量名:remark + * 是否必填:否 + * 类型:string(256) + * 描述: + * 商户对提现单的备注,若提现申请时未传递,则无此字段 + * 示例值:交易提现 + *+ */ + @SerializedName(value = "remark") + private String remark; + + /** + *
+ * 字段名:银行附言 + * 变量名:bank_memo + * 是否必填:否 + * 类型:string(256) + * 描述: + * 展示在收款银行系统中的附言,若提现申请时未传递,则无此字段 + * 示例值:微信支付提现 + *+ */ + @SerializedName(value = "bank_memo") + private String bankMemo; + + /** + *
+ * 字段名:账户类型 + * 变量名:account_type + * 是否必填:否 + * 类型:string(16) + * 描述: + * 提现账户类型,仅电商平台提现时返回: + * BASIC:基本账户 + * OPERATION:运营账户 + * FEES:手续费账户 + * 示例值:BASIC + *+ */ + @SerializedName(value = "account_type") + private String accountType; + + /** + *
+ * 字段名:提现失败解决方案 + * 变量名:solution + * 是否必填:否 + * 类型:string(255) + * 描述: + * 仅在提现失败、退票、关单时有值 + * 示例值:请修改结算银行卡信息 + *+ */ + @SerializedName(value = "solution") + private String solution; + + /** + *
+ * 字段名:出款户名 + * 变量名:account_name + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款户名(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "account_name") + private String accountName; + + /** + *
+ * 字段名:出款账号 + * 变量名:account_number + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款账号(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "account_number") + private String accountNumber; + + /** + *
+ * 字段名:出款银行全称(含支行) + * 变量名:bank_name + * 是否必填:否 + * 类型:string(256) + * 描述: + * 出款银行全称(含支行)(加密) + * 示例值:2mPt3pWzZ+O3dSGbGnCrR3bqMZ5pwfpQy1NNrA== + *+ */ + @SerializedName(value = "bank_name") + private String bankName; +} \ No newline at end of file diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersRequest.java new file mode 100644 index 0000000000..b651100a59 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersRequest.java @@ -0,0 +1,585 @@ +package com.github.binarywang.wxpay.bean.mipay; + +import com.github.binarywang.wxpay.bean.mipay.enums.CashAddTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.CashReduceTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.MixPayTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.OrderTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.UserCardTypeEnum; +import com.github.binarywang.wxpay.v3.SpecEncrypt; +import com.google.gson.annotations.SerializedName; +import java.util.List; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; +import lombok.experimental.Accessors; + +/** + * 医保自费混合收款下单请求 + *
+ * 从业机构调用该接口向微信医保后台下单 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131 + * @author xgl + * @date 2025/12/19 14:37 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@Accessors(chain = true) +public class MedInsOrdersRequest { + + /** + *
+ * 字段名:混合支付类型 + * 变量名:mix_pay_type + * 必填:是 + * 类型:string + * 描述: + * 混合支付类型可选取值: + * - UNKNOWN_MIX_PAY_TYPE: 未知的混合支付类型,会被拦截 + * - CASH_ONLY: 只向微信支付下单,没有向医保局下单 + * - INSURANCE_ONLY: 只向医保局下单,没有向微信支付下单 + * - CASH_AND_INSURANCE: 向医保局下单,也向微信支付下单 + *+ */ + @SerializedName("mix_pay_type") + public MixPayTypeEnum mixPayType; + + /** + *
+ * 字段名:订单类型 + * 变量名:order_type + * 必填:是 + * 类型:string + * 描述: + * 订单类型可选取值: + * - UNKNOWN_ORDER_TYPE: 未知类型,会被拦截 + * - REG_PAY: 挂号支付 + * - DIAG_PAY: 诊间支付 + * - COVID_EXAM_PAY: 新冠检测费用(核酸) + * - IN_HOSP_PAY: 住院费支付 + * - PHARMACY_PAY: 药店支付 + * - INSURANCE_PAY: 保险费支付 + * - INT_REG_PAY: 互联网医院挂号支付 + * - INT_RE_DIAG_PAY: 互联网医院复诊支付 + * - INT_RX_PAY: 互联网医院处方支付 + * - COVID_ANTIGEN_PAY: 新冠抗原检测 + * - MED_PAY: 药费支付 + *+ */ + @SerializedName("order_type") + public OrderTypeEnum orderType; + + /** + *
+ * 字段名:从业机构/服务商的公众号ID + * 变量名:appid + * 必填:是 + * 类型:string(32) + * 描述:从业机构/服务商的公众号ID + *+ */ + @SerializedName("appid") + public String appid; + + /** + *
+ * 字段名:医疗机构的公众号ID + * 变量名:sub_appid + * 必填:是 + * 类型:string(32) + * 描述:医疗机构的公众号ID + *+ */ + @SerializedName("sub_appid") + public String subAppid; + + /** + *
+ * 字段名:医疗机构的商户号 + * 变量名:sub_mchid + * 必填:是 + * 类型:string(32) + * 描述:医疗机构的商户号 + *+ */ + @SerializedName("sub_mchid") + public String subMchid; + + /** + *
+ * 字段名:用户在appid下的唯一标识 + * 变量名:openid + * 必填:否 + * 类型:string(128) + * 描述:openid与sub_openid二选一,传入openid时需要使用appid调起医保自费混合支付 + *+ */ + @SerializedName("openid") + public String openid; + + /** + *
+ * 字段名:用户在sub_appid下的唯一标识 + * 变量名:sub_openid + * 必填:否 + * 类型:string(128) + * 描述:openid与sub_openid二选一,传入sub_openid时需要使用sub_appid调起医保自费混合支付 + *+ */ + @SerializedName("sub_openid") + public String subOpenid; + + /** + *
+ * 字段名:支付人身份信息 + * 变量名:payer + * 必填:是 + * 类型:object + * 描述:支付人身份信息 + *+ */ + @SerializedName("payer") + @SpecEncrypt + public PersonIdentification payer; + + /** + *
+ * 字段名:是否代亲属支付 + * 变量名:pay_for_relatives + * 必填:否 + * 类型:boolean + * 描述:不传默认替本人支付 + * - true: 代亲属支付 + * - false: 本人支付 + *+ */ + @SerializedName("pay_for_relatives") + public Boolean payForRelatives; + + /** + *
+ * 字段名:亲属身份信息 + * 变量名:relative + * 必填:否 + * 类型:object + * 描述:pay_for_relatives为true时,该字段必填 + *+ */ + @SerializedName("relative") + @SpecEncrypt + public PersonIdentification relative; + + /** + *
+ * 字段名:从业机构订单号 + * 变量名:out_trade_no + * 必填:是 + * 类型:string(64) + * 描述:从业机构/服务商需要调两次接口:从业机构/服务商向微信支付下单获取微信支付凭证,请求中会带上out_trade_no。下单成功后,从业机构/服务商调用混合下单的接口(即该接口),请求中也会带上out_trade_no。 + *+ */ + @SerializedName("out_trade_no") + public String outTradeNo; + + /** + *
+ * 字段名:医疗机构订单号 + * 变量名:serial_no + * 必填:是 + * 类型:string(40) + * 描述:例如医院HIS系统订单号。传与费用明细上传中medOrgOrd字段一样的值,局端会校验,不一致将会返回错误 + *+ */ + @SerializedName("serial_no") + public String serialNo; + + /** + *
+ * 字段名:支付订单号 + * 变量名:pay_order_id + * 必填:否 + * 类型:string + * 描述:支付订单号 + *+ */ + @SerializedName("pay_order_id") + public String payOrderId; + + /** + *
+ * 字段名:支付授权号 + * 变量名:pay_auth_no + * 必填:否 + * 类型:string + * 描述:支付授权号 + *+ */ + @SerializedName("pay_auth_no") + public String payAuthNo; + + /** + *
+ * 字段名:地理位置 + * 变量名:geo_location + * 必填:否 + * 类型:string + * 描述:地理位置 + *+ */ + @SerializedName("geo_location") + public String geoLocation; + + /** + *
+ * 字段名:城市ID + * 变量名:city_id + * 必填:否 + * 类型:string + * 描述:城市ID + *+ */ + @SerializedName("city_id") + public String cityId; + + /** + *
+ * 字段名:医疗机构名称 + * 变量名:med_inst_name + * 必填:否 + * 类型:string + * 描述:医疗机构名称 + *+ */ + @SerializedName("med_inst_name") + public String medInstName; + + /** + *
+ * 字段名:医疗机构编号 + * 变量名:med_inst_no + * 必填:否 + * 类型:string + * 描述:医疗机构编号 + *+ */ + @SerializedName("med_inst_no") + public String medInstNo; + + /** + *
+ * 字段名:医保订单创建时间 + * 变量名:med_ins_order_create_time + * 必填:否 + * 类型:string + * 描述:医保订单创建时间 + *+ */ + @SerializedName("med_ins_order_create_time") + public String medInsOrderCreateTime; + + /** + *
+ * 字段名:总金额 + * 变量名:total_fee + * 必填:否 + * 类型:Integer + * 描述:总金额 + *+ */ + @SerializedName("total_fee") + public Integer totalFee; + + /** + *
+ * 字段名:医保统筹基金支付金额 + * 变量名:med_ins_gov_fee + * 必填:否 + * 类型:Integer + * 描述:医保统筹基金支付金额 + *+ */ + @SerializedName("med_ins_gov_fee") + public Integer medInsGovFee; + + /** + *
+ * 字段名:医保个人账户支付金额 + * 变量名:med_ins_self_fee + * 必填:否 + * 类型:Integer + * 描述:医保个人账户支付金额 + *+ */ + @SerializedName("med_ins_self_fee") + public Integer medInsSelfFee; + + /** + *
+ * 字段名:医保其他基金支付金额 + * 变量名:med_ins_other_fee + * 必填:否 + * 类型:Integer + * 描述:医保其他基金支付金额 + *+ */ + @SerializedName("med_ins_other_fee") + public Integer medInsOtherFee; + + /** + *
+ * 字段名:医保现金支付金额 + * 变量名:med_ins_cash_fee + * 必填:否 + * 类型:Integer + * 描述:医保现金支付金额 + *+ */ + @SerializedName("med_ins_cash_fee") + public Integer medInsCashFee; + + /** + *
+ * 字段名:微信支付现金支付金额 + * 变量名:wechat_pay_cash_fee + * 必填:否 + * 类型:Integer + * 描述:微信支付现金支付金额 + *+ */ + @SerializedName("wechat_pay_cash_fee") + public Integer wechatPayCashFee; + + /** + *
+ * 字段名:现金增加明细 + * 变量名:cash_add_detail + * 必填:否 + * 类型:list + * 描述:现金增加明细 + *+ */ + @SerializedName("cash_add_detail") + public List
+ * 字段名:现金减少明细 + * 变量名:cash_reduce_detail + * 必填:否 + * 类型:list + * 描述:现金减少明细 + *+ */ + @SerializedName("cash_reduce_detail") + public List
+ * 字段名:回调URL + * 变量名:callback_url + * 必填:否 + * 类型:string + * 描述:回调URL + *+ */ + @SerializedName("callback_url") + public String callbackUrl; + + /** + *
+ * 字段名:预支付交易会话标识 + * 变量名:prepay_id + * 必填:否 + * 类型:string + * 描述:预支付交易会话标识 + *+ */ + @SerializedName("prepay_id") + public String prepayId; + + /** + *
+ * 字段名:透传请求内容 + * 变量名:passthrough_request_content + * 必填:否 + * 类型:string + * 描述:透传请求内容 + *+ */ + @SerializedName("passthrough_request_content") + public String passthroughRequestContent; + + /** + *
+ * 字段名:扩展字段 + * 变量名:extends + * 必填:否 + * 类型:string + * 描述:扩展字段 + *+ */ + @SerializedName("extends") + public String _extends; + + /** + *
+ * 字段名:附加数据 + * 变量名:attach + * 必填:否 + * 类型:string + * 描述:附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 + *+ */ + @SerializedName("attach") + public String attach; + + /** + *
+ * 字段名:渠道编号 + * 变量名:channel_no + * 必填:否 + * 类型:string + * 描述:渠道编号 + *+ */ + @SerializedName("channel_no") + public String channelNo; + + /** + *
+ * 字段名:医保测试环境标识 + * 变量名:med_ins_test_env + * 必填:否 + * 类型:boolean + * 描述:医保测试环境标识 + *+ */ + @SerializedName("med_ins_test_env") + public Boolean medInsTestEnv; + + /** + *
+ * 支付人身份信息 + *+ */ + @Data + @Builder + @NoArgsConstructor + @AllArgsConstructor + @Accessors(chain = true) + public static class PersonIdentification { + /** + *
+ * 字段名:姓名 + * 变量名:name + * 必填:是 + * 类型:string + * 描述:姓名,需加密 + *+ */ + @SerializedName("name") + @SpecEncrypt + public String name; + + /** + *
+ * 字段名:身份证摘要 + * 变量名:id_digest + * 必填:是 + * 类型:string + * 描述:身份证摘要,需加密 + *+ */ + @SerializedName("id_digest") + @SpecEncrypt + public String idDigest; + + /** + *
+ * 字段名:证件类型 + * 变量名:card_type + * 必填:是 + * 类型:string + * 描述:证件类型 + *+ */ + @SerializedName("card_type") + public UserCardTypeEnum cardType; + } + + /** + *
+ * 现金增加明细实体 + *+ */ + @Data + @Builder + @NoArgsConstructor + @AllArgsConstructor + @Accessors(chain = true) + public static class CashAddEntity { + /** + *
+ * 字段名:现金增加金额 + * 变量名:cash_add_fee + * 必填:是 + * 类型:Integer + * 描述:现金增加金额 + *+ */ + @SerializedName("cash_add_fee") + public Integer cashAddFee; + + /** + *
+ * 字段名:现金增加类型 + * 变量名:cash_add_type + * 必填:是 + * 类型:string + * 描述:现金增加类型 + *+ */ + @SerializedName("cash_add_type") + public CashAddTypeEnum cashAddType; + } + + /** + *
+ * 现金减少明细实体 + *+ */ + @Data + @Builder + @NoArgsConstructor + @AllArgsConstructor + @Accessors(chain = true) + public static class CashReduceEntity { + /** + *
+ * 字段名:现金减少金额 + * 变量名:cash_reduce_fee + * 必填:是 + * 类型:Integer + * 描述:现金减少金额 + *+ */ + @SerializedName("cash_reduce_fee") + public Integer cashReduceFee; + + /** + *
+ * 字段名:现金减少类型 + * 变量名:cash_reduce_type + * 必填:是 + * 类型:string + * 描述:现金减少类型 + *+ */ + @SerializedName("cash_reduce_type") + public CashReduceTypeEnum cashReduceType; + } + + +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java new file mode 100644 index 0000000000..9a119d8723 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsOrdersResult.java @@ -0,0 +1,497 @@ +package com.github.binarywang.wxpay.bean.mipay; + +import com.github.binarywang.wxpay.bean.mipay.enums.MedInsPayStatusEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.MixPayStatusEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.MixPayTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.OrderTypeEnum; +import com.github.binarywang.wxpay.bean.mipay.enums.SelfPayStatusEnum; +import com.google.gson.annotations.SerializedName; +import java.util.List; +import lombok.Data; + +/** + * 医保自费混合收款下单响应 + *
+ * 从业机构调用医保自费混合收款下单接口后返回的结果 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131 + * @author xgl + * @date 2025/12/19 14:37 + */ +@Data +public class MedInsOrdersResult { + /** + *
+ * 字段名:混合交易订单号 + * 变量名:mix_trade_no + * 必填:是 + * 类型:string + * 描述:微信支付生成的混合交易订单号 + *+ */ + @SerializedName("mix_trade_no") + public String mixTradeNo; + + /** + *
+ * 字段名:混合支付状态 + * 变量名:mix_pay_status + * 必填:是 + * 类型:string + * 描述:混合支付整体状态 + *+ */ + @SerializedName("mix_pay_status") + public MixPayStatusEnum mixPayStatus; + + /** + *
+ * 字段名:自费支付状态 + * 变量名:self_pay_status + * 必填:是 + * 类型:string + * 描述:自费部分支付状态 + *+ */ + @SerializedName("self_pay_status") + public SelfPayStatusEnum selfPayStatus; + + /** + *
+ * 字段名:医保支付状态 + * 变量名:med_ins_pay_status + * 必填:是 + * 类型:string + * 描述:医保部分支付状态 + *+ */ + @SerializedName("med_ins_pay_status") + public MedInsPayStatusEnum medInsPayStatus; + + /** + *
+ * 字段名:支付完成时间 + * 变量名:paid_time + * 必填:否 + * 类型:string + * 描述:支付完成时间,格式为yyyyMMddHHmmss + *+ */ + @SerializedName("paid_time") + public String paidTime; + + /** + *
+ * 字段名:透传响应内容 + * 变量名:passthrough_response_content + * 必填:否 + * 类型:string + * 描述:透传响应内容 + *+ */ + @SerializedName("passthrough_response_content") + public String passthroughResponseContent; + + /** + *
+ * 字段名:混合支付类型 + * 变量名:mix_pay_type + * 必填:是 + * 类型:string + * 描述: + * 混合支付类型可选取值: + * - UNKNOWN_MIX_PAY_TYPE: 未知的混合支付类型,会被拦截 + * - CASH_ONLY: 只向微信支付下单,没有向医保局下单 + * - INSURANCE_ONLY: 只向医保局下单,没有向微信支付下单 + * - CASH_AND_INSURANCE: 向医保局下单,也向微信支付下单 + *+ */ + @SerializedName("mix_pay_type") + public MixPayTypeEnum mixPayType; + + /** + *
+ * 字段名:订单类型 + * 变量名:order_type + * 必填:是 + * 类型:string + * 描述: + * 订单类型可选取值: + * - UNKNOWN_ORDER_TYPE: 未知类型,会被拦截 + * - REG_PAY: 挂号支付 + * - DIAG_PAY: 诊间支付 + * - COVID_EXAM_PAY: 新冠检测费用(核酸) + * - IN_HOSP_PAY: 住院费支付 + * - PHARMACY_PAY: 药店支付 + * - INSURANCE_PAY: 保险费支付 + * - INT_REG_PAY: 互联网医院挂号支付 + * - INT_RE_DIAG_PAY: 互联网医院复诊支付 + * - INT_RX_PAY: 互联网医院处方支付 + * - COVID_ANTIGEN_PAY: 新冠抗原检测 + * - MED_PAY: 药费支付 + *+ */ + @SerializedName("order_type") + public OrderTypeEnum orderType; + + /** + *
+ * 字段名:从业机构/服务商的公众号ID + * 变量名:appid + * 必填:是 + * 类型:string(32) + * 描述:从业机构/服务商的公众号ID + *+ */ + @SerializedName("appid") + public String appid; + + /** + *
+ * 字段名:医疗机构的公众号ID + * 变量名:sub_appid + * 必填:是 + * 类型:string(32) + * 描述:医疗机构的公众号ID + *+ */ + @SerializedName("sub_appid") + public String subAppid; + + /** + *
+ * 字段名:医疗机构的商户号 + * 变量名:sub_mchid + * 必填:是 + * 类型:string(32) + * 描述:医疗机构的商户号 + *+ */ + @SerializedName("sub_mchid") + public String subMchid; + + /** + *
+ * 字段名:用户在appid下的唯一标识 + * 变量名:openid + * 必填:否 + * 类型:string(128) + * 描述:openid与sub_openid二选一,传入openid时需要使用appid调起医保自费混合支付 + *+ */ + @SerializedName("openid") + public String openid; + + /** + *
+ * 字段名:用户在sub_appid下的唯一标识 + * 变量名:sub_openid + * 必填:否 + * 类型:string(128) + * 描述:openid与sub_openid二选一,传入sub_openid时需要使用sub_appid调起医保自费混合支付 + *+ */ + @SerializedName("sub_openid") + public String subOpenid; + + /** + *
+ * 字段名:是否代亲属支付 + * 变量名:pay_for_relatives + * 必填:否 + * 类型:boolean + * 描述:不传默认替本人支付 + * - true: 代亲属支付 + * - false: 本人支付 + *+ */ + @SerializedName("pay_for_relatives") + public Boolean payForRelatives; + + /** + *
+ * 字段名:从业机构订单号 + * 变量名:out_trade_no + * 必填:是 + * 类型:string(64) + * 描述:从业机构/服务商需要调两次接口:从业机构/服务商向微信支付下单获取微信支付凭证,请求中会带上out_trade_no。下单成功后,从业机构/服务商调用混合下单的接口(即该接口),请求中也会带上out_trade_no。 + *+ */ + @SerializedName("out_trade_no") + public String outTradeNo; + + /** + *
+ * 字段名:医疗机构订单号 + * 变量名:serial_no + * 必填:是 + * 类型:string(40) + * 描述:例如医院HIS系统订单号。传与费用明细上传中medOrgOrd字段一样的值,局端会校验,不一致将会返回错误 + *+ */ + @SerializedName("serial_no") + public String serialNo; + + /** + *
+ * 字段名:支付订单号 + * 变量名:pay_order_id + * 必填:否 + * 类型:string + * 描述:支付订单号 + *+ */ + @SerializedName("pay_order_id") + public String payOrderId; + + /** + *
+ * 字段名:支付授权号 + * 变量名:pay_auth_no + * 必填:否 + * 类型:string + * 描述:支付授权号 + *+ */ + @SerializedName("pay_auth_no") + public String payAuthNo; + + /** + *
+ * 字段名:地理位置 + * 变量名:geo_location + * 必填:否 + * 类型:string + * 描述:地理位置 + *+ */ + @SerializedName("geo_location") + public String geoLocation; + + /** + *
+ * 字段名:城市ID + * 变量名:city_id + * 必填:否 + * 类型:string + * 描述:城市ID + *+ */ + @SerializedName("city_id") + public String cityId; + + /** + *
+ * 字段名:医疗机构名称 + * 变量名:med_inst_name + * 必填:否 + * 类型:string + * 描述:医疗机构名称 + *+ */ + @SerializedName("med_inst_name") + public String medInstName; + + /** + *
+ * 字段名:医疗机构编号 + * 变量名:med_inst_no + * 必填:否 + * 类型:string + * 描述:医疗机构编号 + *+ */ + @SerializedName("med_inst_no") + public String medInstNo; + + /** + *
+ * 字段名:医保订单创建时间 + * 变量名:med_ins_order_create_time + * 必填:否 + * 类型:string + * 描述:医保订单创建时间 + *+ */ + @SerializedName("med_ins_order_create_time") + public String medInsOrderCreateTime; + + /** + *
+ * 字段名:总金额 + * 变量名:total_fee + * 必填:否 + * 类型:Integer + * 描述:总金额 + *+ */ + @SerializedName("total_fee") + public Integer totalFee; + + /** + *
+ * 字段名:医保统筹基金支付金额 + * 变量名:med_ins_gov_fee + * 必填:否 + * 类型:Integer + * 描述:医保统筹基金支付金额 + *+ */ + @SerializedName("med_ins_gov_fee") + public Integer medInsGovFee; + + /** + *
+ * 字段名:医保个人账户支付金额 + * 变量名:med_ins_self_fee + * 必填:否 + * 类型:Integer + * 描述:医保个人账户支付金额 + *+ */ + @SerializedName("med_ins_self_fee") + public Integer medInsSelfFee; + + /** + *
+ * 字段名:医保其他基金支付金额 + * 变量名:med_ins_other_fee + * 必填:否 + * 类型:Integer + * 描述:医保其他基金支付金额 + *+ */ + @SerializedName("med_ins_other_fee") + public Integer medInsOtherFee; + + /** + *
+ * 字段名:医保现金支付金额 + * 变量名:med_ins_cash_fee + * 必填:否 + * 类型:Integer + * 描述:医保现金支付金额 + *+ */ + @SerializedName("med_ins_cash_fee") + public Integer medInsCashFee; + + /** + *
+ * 字段名:微信支付现金支付金额 + * 变量名:wechat_pay_cash_fee + * 必填:否 + * 类型:Integer + * 描述:微信支付现金支付金额 + *+ */ + @SerializedName("wechat_pay_cash_fee") + public Integer wechatPayCashFee; + + /** + *
+ * 字段名:现金增加明细 + * 变量名:cash_add_detail + * 必填:否 + * 类型:list + * 描述:现金增加明细 + *+ */ + @SerializedName("cash_add_detail") + public List
+ * 字段名:现金减少明细 + * 变量名:cash_reduce_detail + * 必填:否 + * 类型:list + * 描述:现金减少明细 + *+ */ + @SerializedName("cash_reduce_detail") + public List
+ * 字段名:回调URL + * 变量名:callback_url + * 必填:否 + * 类型:string + * 描述:回调URL + *+ */ + @SerializedName("callback_url") + public String callbackUrl; + + /** + *
+ * 字段名:预支付交易会话标识 + * 变量名:prepay_id + * 必填:否 + * 类型:string + * 描述:预支付交易会话标识 + *+ */ + @SerializedName("prepay_id") + public String prepayId; + + /** + *
+ * 字段名:透传请求内容 + * 变量名:passthrough_request_content + * 必填:否 + * 类型:string + * 描述:透传请求内容 + *+ */ + @SerializedName("passthrough_request_content") + public String passthroughRequestContent; + + /** + *
+ * 字段名:扩展字段 + * 变量名:extends + * 必填:否 + * 类型:string + * 描述:扩展字段 + *+ */ + @SerializedName("extends") + public String _extends; + + /** + *
+ * 字段名:附加数据 + * 变量名:attach + * 必填:否 + * 类型:string + * 描述:附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 + *+ */ + @SerializedName("attach") + public String attach; + + /** + *
+ * 字段名:渠道编号 + * 变量名:channel_no + * 必填:否 + * 类型:string + * 描述:渠道编号 + *+ */ + @SerializedName("channel_no") + public String channelNo; + + /** + *
+ * 字段名:医保测试环境标识 + * 变量名:med_ins_test_env + * 必填:否 + * 类型:boolean + * 描述:医保测试环境标识 + *+ */ + @SerializedName("med_ins_test_env") + public Boolean medInsTestEnv; +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java new file mode 100644 index 0000000000..cb935b52cd --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/MedInsRefundNotifyRequest.java @@ -0,0 +1,106 @@ +package com.github.binarywang.wxpay.bean.mipay; + +import com.google.gson.annotations.SerializedName; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +/** + * 医保退款通知请求 + *
+ * 从业机构调用该接口向微信医保后台通知医保订单的退款成功结果 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012166534 + * @author xgl + * @date 2025/12/20 + */ +@Data +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +public class MedInsRefundNotifyRequest { + + /** + *
+ * 字段名:医疗机构的商户号 + * 变量名:sub_mchid + * 必填:是 + * 类型:string(32) + * 描述:医疗机构的商户号 + *+ */ + @SerializedName("sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:医保退款的总金额 + * 变量名:med_refund_total_fee + * 必填:是 + * 类型:integer + * 描述:单位分,医保退款的总金额。 + *+ */ + @SerializedName("med_refund_total_fee") + private Integer medRefundTotalFee; + + /** + *
+ * 字段名:医保统筹退款金额 + * 变量名:med_refund_gov_fee + * 必填:是 + * 类型:integer + * 描述:单位分,医保统筹退款金额。 + *+ */ + @SerializedName("med_refund_gov_fee") + private Integer medRefundGovFee; + + /** + *
+ * 字段名:医保个账退款金额 + * 变量名:med_refund_self_fee + * 必填:是 + * 类型:integer + * 描述:单位分,医保个账退款金额。 + *+ */ + @SerializedName("med_refund_self_fee") + private Integer medRefundSelfFee; + + /** + *
+ * 字段名:医保其他退款金额 + * 变量名:med_refund_other_fee + * 必填:是 + * 类型:integer + * 描述:单位分,医保其他退款金额。 + *+ */ + @SerializedName("med_refund_other_fee") + private Integer medRefundOtherFee; + + /** + *
+ * 字段名:医保退款成功时间 + * 变量名:refund_time + * 必填:是 + * 类型:string(64) + * 描述:遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE。 + *+ */ + @SerializedName("refund_time") + private String refundTime; + + /** + *
+ * 字段名:从业机构\服务商退款单号 + * 变量名:out_refund_no + * 必填:是 + * 类型:string(64) + * 描述:有自费单时,从业机构\服务商应填与自费退款申请处一致的out_refund_no。否则从业机构透传医疗机构退款单号即可。 + *+ */ + @SerializedName("out_refund_no") + private String outRefundNo; +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java new file mode 100644 index 0000000000..b935f20410 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashAddTypeEnum.java @@ -0,0 +1,29 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 现金增加类型枚举 + *
+ * 描述医保自费混合支付中现金增加的类型 + * + * @author xgl + * @date 2025/12/20 + */ +public enum CashAddTypeEnum { + /** + * 默认增加类型 + */ + @SerializedName("DEFAULT_ADD_TYPE") + DEFAULT_ADD_TYPE, + /** + * 运费 + */ + @SerializedName("FREIGHT") + FREIGHT, + /** + * 其他医疗费用 + */ + @SerializedName("OTHER_MEDICAL_EXPENSES") + OTHER_MEDICAL_EXPENSES +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java new file mode 100644 index 0000000000..4f90b8500a --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/CashReduceTypeEnum.java @@ -0,0 +1,44 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 现金减少类型枚举 + *
+ * 描述医保自费混合支付中现金减少的类型 + * + * @author xgl + * @date 2025/12/20 + */ +public enum CashReduceTypeEnum { + /** + * 默认减少类型 + */ + @SerializedName("DEFAULT_REDUCE_TYPE") + DEFAULT_REDUCE_TYPE, + /** + * 医院减免 + */ + @SerializedName("HOSPITAL_REDUCE") + HOSPITAL_REDUCE, + /** + * 药店折扣 + */ + @SerializedName("PHARMACY_DISCOUNT") + PHARMACY_DISCOUNT, + /** + * 折扣优惠 + */ + @SerializedName("DISCOUNT") + DISCOUNT, + /** + * 预付费抵扣 + */ + @SerializedName("PRE_PAYMENT") + PRE_PAYMENT, + /** + * 押金扣除 + */ + @SerializedName("DEPOSIT_DEDUCTION") + DEPOSIT_DEDUCTION +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java new file mode 100644 index 0000000000..324530f0ff --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MedInsPayStatusEnum.java @@ -0,0 +1,44 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 医保支付状态枚举 + *
+ * 描述医保自费混合支付中医保部分的支付状态 + * + * @author xgl + * @date 2025/12/20 + */ +public enum MedInsPayStatusEnum { + /** + * 未知的医保支付状态 + */ + @SerializedName("UNKNOWN_MED_INS_PAY_STATUS") + UNKNOWN_MED_INS_PAY_STATUS, + /** + * 医保支付已创建 + */ + @SerializedName("MED_INS_PAY_CREATED") + MED_INS_PAY_CREATED, + /** + * 医保支付成功 + */ + @SerializedName("MED_INS_PAY_SUCCESS") + MED_INS_PAY_SUCCESS, + /** + * 医保支付已退款 + */ + @SerializedName("MED_INS_PAY_REFUND") + MED_INS_PAY_REFUND, + /** + * 医保支付失败 + */ + @SerializedName("MED_INS_PAY_FAIL") + MED_INS_PAY_FAIL, + /** + * 无需医保支付 + */ + @SerializedName("NO_MED_INS_PAY") + NO_MED_INS_PAY +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java new file mode 100644 index 0000000000..7360704986 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayStatusEnum.java @@ -0,0 +1,39 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 混合支付状态枚举 + *
+ * 描述医保自费混合支付的整体状态 + * + * @author xgl + * @date 2025/12/20 + */ +public enum MixPayStatusEnum { + /** + * 未知的混合支付状态 + */ + @SerializedName("UNKNOWN_MIX_PAY_STATUS") + UNKNOWN_MIX_PAY_STATUS, + /** + * 混合支付已创建 + */ + @SerializedName("MIX_PAY_CREATED") + MIX_PAY_CREATED, + /** + * 混合支付成功 + */ + @SerializedName("MIX_PAY_SUCCESS") + MIX_PAY_SUCCESS, + /** + * 混合支付已退款 + */ + @SerializedName("MIX_PAY_REFUND") + MIX_PAY_REFUND, + /** + * 混合支付失败 + */ + @SerializedName("MIX_PAY_FAIL") + MIX_PAY_FAIL +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java new file mode 100644 index 0000000000..ad62d50a66 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/MixPayTypeEnum.java @@ -0,0 +1,41 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 混合支付类型枚举 + *
+ * 描述医保自费混合支付的类型 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131 + * + * @author xgl + * @date 2025/12/20 09:21 + */ +public enum MixPayTypeEnum { + + /** + * 未知的混合支付类型,会被拦截。 + */ + @SerializedName("UNKNOWN_MIX_PAY_TYPE") + UNKNOWN_MIX_PAY_TYPE, + + /** + * 只向微信支付下单,没有向医保局下单。包括没有向医保局上传费用明细、预结算。 + */ + @SerializedName("CASH_ONLY") + CASH_ONLY, + + /** + * 只向医保局下单,没有向微信支付下单。如果医保局分账结果中有自费部份,但由于有减免抵扣,没有向微信支付下单,也是纯医保。 + */ + @SerializedName("INSURANCE_ONLY") + INSURANCE_ONLY, + + /** + * 向医保局下单,也向微信支付下单。如果医保预结算全部需自费,也属于混合类型。 + */ + @SerializedName("CASH_AND_INSURANCE") + CASH_AND_INSURANCE + + +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java new file mode 100644 index 0000000000..749b1276e7 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/OrderTypeEnum.java @@ -0,0 +1,87 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 订单类型枚举 + *
+ * 描述医保自费混合支付的订单类型 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012503131 + * + * @author xgl + * @date 2025/12/20 + */ +public enum OrderTypeEnum { + + /** + * 未知类型,会被拦截 + */ + @SerializedName("UNKNOWN_ORDER_TYPE") + UNKNOWN_ORDER_TYPE, + + /** + * 挂号支付 + */ + @SerializedName("REG_PAY") + REG_PAY, + + /** + * 诊间支付 + */ + @SerializedName("DIAG_PAY") + DIAG_PAY, + + /** + * 新冠检测费用(核酸) + */ + @SerializedName("COVID_EXAM_PAY") + COVID_EXAM_PAY, + + /** + * 住院费支付 + */ + @SerializedName("IN_HOSP_PAY") + IN_HOSP_PAY, + + /** + * 药店支付 + */ + @SerializedName("PHARMACY_PAY") + PHARMACY_PAY, + + /** + * 保险费支付 + */ + @SerializedName("INSURANCE_PAY") + INSURANCE_PAY, + + /** + * 互联网医院挂号支付 + */ + @SerializedName("INT_REG_PAY") + INT_REG_PAY, + + /** + * 互联网医院复诊支付 + */ + @SerializedName("INT_RE_DIAG_PAY") + INT_RE_DIAG_PAY, + + /** + * 互联网医院处方支付 + */ + @SerializedName("INT_RX_PAY") + INT_RX_PAY, + + /** + * 新冠抗原检测 + */ + @SerializedName("COVID_ANTIGEN_PAY") + COVID_ANTIGEN_PAY, + + /** + * 药费支付 + */ + @SerializedName("MED_PAY") + MED_PAY +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java new file mode 100644 index 0000000000..a7014b9e13 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/SelfPayStatusEnum.java @@ -0,0 +1,44 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 自费支付状态枚举 + *
+ * 描述医保自费混合支付中自费部分的支付状态 + * + * @author xgl + * @date 2025/12/20 + */ +public enum SelfPayStatusEnum { + /** + * 未知的自费支付状态 + */ + @SerializedName("UNKNOWN_SELF_PAY_STATUS") + UNKNOWN_SELF_PAY_STATUS, + /** + * 自费支付已创建 + */ + @SerializedName("SELF_PAY_CREATED") + SELF_PAY_CREATED, + /** + * 自费支付成功 + */ + @SerializedName("SELF_PAY_SUCCESS") + SELF_PAY_SUCCESS, + /** + * 自费支付已退款 + */ + @SerializedName("SELF_PAY_REFUND") + SELF_PAY_REFUND, + /** + * 自费支付失败 + */ + @SerializedName("SELF_PAY_FAIL") + SELF_PAY_FAIL, + /** + * 无需自费支付 + */ + @SerializedName("NO_SELF_PAY") + NO_SELF_PAY +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java new file mode 100644 index 0000000000..1bf97b7628 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/mipay/enums/UserCardTypeEnum.java @@ -0,0 +1,54 @@ +package com.github.binarywang.wxpay.bean.mipay.enums; + +import com.google.gson.annotations.SerializedName; + +/** + * 用户证件类型枚举 + *
+ * 描述医保自费混合支付中用户的证件类型 + * + * @author xgl + * @date 2025/12/20 + */ +public enum UserCardTypeEnum { + /** + * 未知的用户证件类型 + */ + @SerializedName("UNKNOWN_USER_CARD_TYPE") + UNKNOWN_USER_CARD_TYPE, + /** + * 居民身份证 + */ + @SerializedName("ID_CARD") + ID_CARD, + /** + * 户口本 + */ + @SerializedName("HOUSEHOLD_REGISTRATION") + HOUSEHOLD_REGISTRATION, + /** + * 外国护照 + */ + @SerializedName("FOREIGNER_PASSPORT") + FOREIGNER_PASSPORT, + /** + * 台湾居民来往大陆通行证 + */ + @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_TW") + MAINLAND_TRAVEL_PERMIT_FOR_TW, + /** + * 澳门居民来往大陆通行证 + */ + @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_MO") + MAINLAND_TRAVEL_PERMIT_FOR_MO, + /** + * 香港居民来往大陆通行证 + */ + @SerializedName("MAINLAND_TRAVEL_PERMIT_FOR_HK") + MAINLAND_TRAVEL_PERMIT_FOR_HK, + /** + * 外国人永久居留身份证 + */ + @SerializedName("FOREIGN_PERMANENT_RESIDENT") + FOREIGN_PERMANENT_RESIDENT +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java new file mode 100644 index 0000000000..346d427fc4 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/MiPayNotifyV3Result.java @@ -0,0 +1,265 @@ +package com.github.binarywang.wxpay.bean.notify; + +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.io.Serializable; + +/** + *
+ * 医保混合收款成功通知结果 + * 文档地址:https://pay.weixin.qq.com/doc/v3/partner/4012165722 + *+ * + * @author xgl + * @since 2025/12/20 + */ +@Data +@NoArgsConstructor +public class MiPayNotifyV3Result implements Serializable, WxPayBaseNotifyV3Result
+ * 字段名:应用ID + * 变量名:appid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 从业机构/服务商的公众号ID + *+ */ + @SerializedName(value = "appid") + private String appid; + + /** + *
+ * 字段名:医疗机构的公众号ID + * 变量名:sub_appid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 医疗机构的公众号ID + *+ */ + @SerializedName(value = "sub_appid") + private String subAppid; + + /** + *
+ * 字段名:医疗机构的商户号 + * 变量名:sub_mchid + * 是否必填:是 + * 类型:string(32) + * 描述: + * 医疗机构的商户号 + *+ */ + @SerializedName(value = "sub_mchid") + private String subMchid; + + /** + *
+ * 字段名:从业机构订单号 + * 变量名:out_trade_no + * 是否必填:是 + * 类型:string(64) + * 描述: + * 从业机构/服务商订单号 + *+ */ + @SerializedName(value = "out_trade_no") + private String outTradeNo; + + /** + *
+ * 字段名:医保自费混合订单号 + * 变量名:mix_trade_no + * 是否必填:是 + * 类型:string(32) + * 描述: + * 微信支付系统生成的医保自费混合订单号 + *+ */ + @SerializedName(value = "mix_trade_no") + private String mixTradeNo; + + /** + *
+ * 字段名:微信支付订单号 + * 变量名:transaction_id + * 是否必填:是 + * 类型:string(32) + * 描述: + * 微信支付系统生成的订单号 + *+ */ + @SerializedName(value = "transaction_id") + private String transactionId; + + /** + *
+ * 字段名:医保订单创建时间 + * 变量名:med_ins_order_create_time + * 是否必填:是 + * 类型:string(64) + * 描述: + * 医保订单创建时间,遵循rfc3339标准格式 + *+ */ + @SerializedName(value = "med_ins_order_create_time") + private String medInsOrderCreateTime; + + /** + *
+ * 字段名:医保订单完成时间 + * 变量名:med_ins_order_finish_time + * 是否必填:是 + * 类型:string(64) + * 描述: + * 医保订单完成时间,遵循rfc3339标准格式 + *+ */ + @SerializedName(value = "med_ins_order_finish_time") + private String medInsOrderFinishTime; + + /** + *
+ * 字段名:总金额 + * 变量名:total_fee + * 是否必填:否 + * 类型:long + * 描述: + * 总金额,单位为分 + *+ */ + @SerializedName(value = "total_fee") + private Long totalFee; + + /** + *
+ * 字段名:医保统筹基金支付金额 + * 变量名:med_ins_gov_fee + * 是否必填:否 + * 类型:long + * 描述: + * 医保统筹基金支付金额,单位为分 + *+ */ + @SerializedName(value = "med_ins_gov_fee") + private Long medInsGovFee; + + /** + *
+ * 字段名:医保个人账户支付金额 + * 变量名:med_ins_self_fee + * 是否必填:否 + * 类型:long + * 描述: + * 医保个人账户支付金额,单位为分 + *+ */ + @SerializedName(value = "med_ins_self_fee") + private Long medInsSelfFee; + + /** + *
+ * 字段名:医保其他基金支付金额 + * 变量名:med_ins_other_fee + * 是否必填:否 + * 类型:long + * 描述: + * 医保其他基金支付金额,单位为分 + *+ */ + @SerializedName(value = "med_ins_other_fee") + private Long medInsOtherFee; + + /** + *
+ * 字段名:医保现金支付金额 + * 变量名:med_ins_cash_fee + * 是否必填:否 + * 类型:long + * 描述: + * 医保现金支付金额,单位为分 + *+ */ + @SerializedName(value = "med_ins_cash_fee") + private Long medInsCashFee; + + /** + *
+ * 字段名:微信支付现金支付金额 + * 变量名:wechat_pay_cash_fee + * 是否必填:否 + * 类型:long + * 描述: + * 微信支付现金支付金额,单位为分 + *+ */ + @SerializedName(value = "wechat_pay_cash_fee") + private Long wechatPayCashFee; + + /** + *
+ * 字段名:附加数据 + * 变量名:attach + * 是否必填:否 + * 类型:string(128) + * 描述: + * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用 + *+ */ + @SerializedName(value = "attach") + private String attach; + + /** + *
+ * 字段名:支付状态 + * 变量名:trade_state + * 是否必填:是 + * 类型:string(32) + * 描述: + * 交易状态,枚举值: + * SUCCESS:支付成功 + * REFUND:转入退款 + * NOTPAY:未支付 + * CLOSED:已关闭 + * REVOKED:已撤销 + * USERPAYING:用户支付中 + * PAYERROR:支付失败 + *+ */ + @SerializedName(value = "trade_state") + private String tradeState; + + /** + *
+ * 字段名:支付状态描述 + * 变量名:trade_state_desc + * 是否必填:是 + * 类型:string(256) + * 描述: + * 交易状态描述 + *+ */ + @SerializedName(value = "trade_state_desc") + private String tradeStateDesc; + } +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java index 86915d0956..364c9080d8 100644 --- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/notify/WxPayBaseNotifyV3Result.java @@ -5,7 +5,8 @@ * * @author Pursuer * @version 1.0 - * @date 2023/6/15 + * @since 2023/6/15 + * @param
+ * 微信支付实名验证请求对象. + * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607 + *+ * + * @author Binary Wang + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class RealNameRequest extends BaseWxPayRequest { + private static final long serialVersionUID = 1L; + + /** + *
+ * 字段名:用户标识 + * 变量名:openid + * 是否必填:是 + * 类型:String(128) + * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o + * 描述:用户在商户appid下的唯一标识 + *+ */ + @Required + @XStreamAlias("openid") + private String openid; + + @Override + protected void checkConstraints() { + //do nothing + } + + @Override + protected void storeMap(Map
+ * 微信支付实名验证返回结果. + * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607 + *+ * + * @author Binary Wang + */ +@Data +@EqualsAndHashCode(callSuper = true) +@NoArgsConstructor +@XStreamAlias("xml") +public class RealNameResult extends BaseWxPayResult implements Serializable { + private static final long serialVersionUID = 1L; + + /** + *
+ * 字段名:用户标识 + * 变量名:openid + * 是否必填:否 + * 类型:String(128) + * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o + * 描述:用户在商户appid下的唯一标识 + *+ */ + @XStreamAlias("openid") + private String openid; + + /** + *
+ * 字段名:实名认证状态 + * 变量名:is_certified + * 是否必填:是 + * 类型:String(1) + * 示例值:Y + * 描述:Y-已实名认证 N-未实名认证 + *+ */ + @XStreamAlias("is_certified") + private String isCertified; + + /** + *
+ * 字段名:实名认证信息 + * 变量名:cert_info + * 是否必填:否 + * 类型:String(256) + * 示例值: + * 描述:实名认证的相关信息,如姓名等(加密) + *+ */ + @XStreamAlias("cert_info") + private String certInfo; + + /** + *
+ * 字段名:引导链接 + * 变量名:guide_url + * 是否必填:否 + * 类型:String(256) + * 示例值: + * 描述:未实名时,引导用户进行实名认证的URL + *+ */ + @XStreamAlias("guide_url") + private String guideUrl; + + /** + * 从XML结构中加载额外的属性 + * + * @param d Document + */ + @Override + protected void loadXml(Document d) { + openid = readXmlString(d, "openid"); + isCertified = readXmlString(d, "is_certified"); + certInfo = readXmlString(d, "cert_info"); + guideUrl = readXmlString(d, "guide_url"); + } +} diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxDepositConsumeRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxDepositConsumeRequest.java new file mode 100644 index 0000000000..b99093cd44 --- /dev/null +++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxDepositConsumeRequest.java @@ -0,0 +1,96 @@ +package com.github.binarywang.wxpay.bean.request; + +import com.github.binarywang.wxpay.exception.WxPayException; +import com.thoughtworks.xstream.annotations.XStreamAlias; +import lombok.*; +import me.chanjar.weixin.common.annotation.Required; + +import java.util.Map; + +/** + *
+ * 押金消费请求 + * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class WxDepositConsumeRequest extends BaseWxPayRequest { + + /** + *
+ * 微信押金订单号 + * transaction_id + * 是 + * String(32) + * 1009660380201506130728806387 + * 微信押金订单号 + *+ */ + @Required + @XStreamAlias("transaction_id") + private String transactionId; + + /** + *
+ * 商户消费单号 + * out_trade_no + * 是 + * String(32) + * 20150806125346 + * 商户系统内部的消费单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 + *+ */ + @Required + @XStreamAlias("out_trade_no") + private String outTradeNo; + + /** + *
+ * 消费金额 + * consume_fee + * 是 + * Int + * 88 + * 消费金额,单位为分,不能大于押金金额 + *+ */ + @Required + @XStreamAlias("consume_fee") + private Integer consumeFee; + + /** + *
+ * 消费描述 + * consume_desc + * 否 + * String(128) + * 单车使用费 + * 对一笔消费的具体描述信息 + *+ */ + @XStreamAlias("consume_desc") + private String consumeDesc; + + @Override + protected void checkConstraints() throws WxPayException { + // No additional constraints beyond @Required fields + } + + @Override + protected void storeMap(Map
+ * 查询押金订单请求 + * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class WxDepositOrderQueryRequest extends BaseWxPayRequest { + + /** + *
+ * 微信订单号 + * transaction_id + * 否 + * String(32) + * 1009660380201506130728806387 + * 微信的订单号,优先使用 + *+ */ + @XStreamAlias("transaction_id") + private String transactionId; + + /** + *
+ * 商户订单号 + * out_trade_no + * 否 + * String(32) + * 20150806125346 + * 商户系统内部的订单号,当没提供transaction_id时需要传这个 + *+ */ + @XStreamAlias("out_trade_no") + private String outTradeNo; + + @Override + protected void checkConstraints() throws WxPayException { + if (transactionId == null && outTradeNo == null) { + throw new WxPayException("transaction_id 和 out_trade_no 不能同时为空"); + } + } + + @Override + protected void storeMap(Map
+ * 押金退款请求 + * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class WxDepositRefundRequest extends BaseWxPayRequest { + + /** + *
+ * 微信押金订单号 + * transaction_id + * 否 + * String(32) + * 1009660380201506130728806387 + * 微信押金订单号,与out_trade_no二选一 + *+ */ + @XStreamAlias("transaction_id") + private String transactionId; + + /** + *
+ * 商户押金订单号 + * out_trade_no + * 否 + * String(32) + * 20150806125346 + * 商户系统内部的押金订单号,与transaction_id二选一 + *+ */ + @XStreamAlias("out_trade_no") + private String outTradeNo; + + /** + *
+ * 商户退款单号 + * out_refund_no + * 是 + * String(32) + * 1217752501201407033233368018 + * 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔 + *+ */ + @Required + @XStreamAlias("out_refund_no") + private String outRefundNo; + + /** + *
+ * 退款金额 + * refund_fee + * 是 + * Int + * 100 + * 退款总金额,订单总金额,单位为分,只能为整数 + *+ */ + @Required + @XStreamAlias("refund_fee") + private Integer refundFee; + + /** + *
+ * 退款原因 + * refund_desc + * 否 + * String(80) + * 商品已售完 + * 若商户传入,会在下发给用户的退款消息中体现退款原因 + *+ */ + @XStreamAlias("refund_desc") + private String refundDesc; + + @Override + protected void checkConstraints() throws WxPayException { + if (transactionId == null && outTradeNo == null) { + throw new WxPayException("transaction_id 和 out_trade_no 不能同时为空"); + } + } + + @Override + protected void storeMap(Map
+ * 押金撤销请求 + * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class WxDepositUnfreezeRequest extends BaseWxPayRequest { + + /** + *
+ * 微信押金订单号 + * transaction_id + * 是 + * String(32) + * 1009660380201506130728806387 + * 微信押金订单号 + *+ */ + @Required + @XStreamAlias("transaction_id") + private String transactionId; + + /** + *
+ * 商户撤销单号 + * out_trade_no + * 是 + * String(32) + * 20150806125346 + * 商户系统内部的撤销单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一 + *+ */ + @Required + @XStreamAlias("out_trade_no") + private String outTradeNo; + + /** + *
+ * 撤销金额 + * unfreeze_fee + * 是 + * Int + * 99 + * 撤销金额,单位为分,不能大于剩余押金金额 + *+ */ + @Required + @XStreamAlias("unfreeze_fee") + private Integer unfreezeFee; + + /** + *
+ * 撤销原因 + * unfreeze_desc + * 否 + * String(128) + * 用户主动取消 + * 对一笔撤销的具体原因描述 + *+ */ + @XStreamAlias("unfreeze_desc") + private String unfreezeDesc; + + @Override + protected void checkConstraints() throws WxPayException { + // No additional constraints beyond @Required fields + } + + @Override + protected void storeMap(Map
+ * 押金下单请求 + * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Data +@EqualsAndHashCode(callSuper = true) +@Builder(builderMethodName = "newBuilder") +@NoArgsConstructor +@AllArgsConstructor +@XStreamAlias("xml") +public class WxDepositUnifiedOrderRequest extends BaseWxPayRequest { + + /** + *
+ * 押金商品描述 + * body + * 是 + * String(128) + * 共享单车押金 + * 押金商品描述 + *+ */ + @Required + @XStreamAlias("body") + private String body; + + /** + *
+ * 商户订单号 + * out_trade_no + * 是 + * String(32) + * 20150806125346 + * 商户系统内部的订单号,32个字符内、可包含字母, 其他说明见商户订单号 + *+ */ + @Required + @XStreamAlias("out_trade_no") + private String outTradeNo; + + /** + *
+ * 押金金额 + * total_fee + * 是 + * Int + * 99 + * 押金金额,单位为分,只能为整数,详见支付金额 + *+ */ + @Required + @XStreamAlias("total_fee") + private Integer totalFee; + + /** + *
+ * 终端IP + * spbill_create_ip + * 是 + * String(16) + * 123.12.12.123 + * 用户端实际ip + *+ */ + @Required + @XStreamAlias("spbill_create_ip") + private String spbillCreateIp; + + /** + *
+ * 通知地址 + * notify_url + * 是 + * String(256) + * http://www.weixin.qq.com/wxpay/pay.php + * 接收微信支付异步通知回调地址 + *+ */ + @Required + @XStreamAlias("notify_url") + private String notifyUrl; + + /** + *
+ * 交易类型 + * trade_type + * 是 + * String(16) + * JSAPI + * 交易类型,取值如下:JSAPI,NATIVE,APP,WAP + *+ */ + @Required + @XStreamAlias("trade_type") + private String tradeType; + + /** + *
+ * 用户标识 + * openid + * 否 + * String(128) + * oUpF8uMuAJO_M2pxb1Q9zNjWeS6o + * trade_type=JSAPI时,此参数必传,用户在商户appid下的唯一标识。 + *+ */ + @XStreamAlias("openid") + private String openid; + + /** + *
+ * 商品详情 + * detail + * 否 + * String(8192) + * 详情 + * 商品名称明细列表 + *+ */ + @XStreamAlias("detail") + private String detail; + + /** + *
+ * 附加数据 + * attach + * 否 + * String(127) + * 深圳分店 + * 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据 + *+ */ + @XStreamAlias("attach") + private String attach; + + /** + *
+ * 货币类型 + * fee_type + * 否 + * String(16) + * CNY + * 符合ISO 4217标准的三位字母代码,默认人民币:CNY + *+ */ + @XStreamAlias("fee_type") + private String feeType; + + /** + *
+ * 交易起始时间 + * time_start + * 否 + * String(14) + * 20091225091010 + * 订单生成时间,格式为yyyyMMddHHmmss + *+ */ + @XStreamAlias("time_start") + private String timeStart; + + /** + *
+ * 交易结束时间 + * time_expire + * 否 + * String(14) + * 20091227091010 + * 订单失效时间,格式为yyyyMMddHHmmss + *+ */ + @XStreamAlias("time_expire") + private String timeExpire; + + @Override + protected void checkConstraints() throws WxPayException { + if ("JSAPI".equals(this.tradeType) && this.openid == null) { + throw new WxPayException("当trade_type为JSAPI时,openid为必填参数"); + } + } + + @Override + protected void storeMap(Map
+ * 字段名:服务商应用ID + * 变量名:sp_appid + * 是否必填:否 + * 类型:string[1,32] + * 描述: + * 服务商模式下使用,由微信生成的应用ID,全局唯一。 + * 示例值:wxd678efh567hg6787 + *+ */ + @SerializedName(value = "sp_appid") + protected String spAppid; + /** + *
+ * 字段名:服务商商户号 + * 变量名:sp_mchid + * 是否必填:否 + * 类型:string[1,32] + * 描述: + * 服务商模式下使用,服务商商户号,由微信支付生成并下发。 + * 示例值:1230000109 + *+ */ + @SerializedName(value = "sp_mchid") + protected String spMchid; + /** + *
+ * 字段名:子商户应用ID + * 变量名:sub_appid + * 是否必填:否 + * 类型:string[1,32] + * 描述: + * 服务商模式下使用,由微信生成的应用ID,全局唯一。 + * 示例值:wxd678efh567hg6787 + *+ */ + @SerializedName(value = "sub_appid") + protected String subAppid; + /** + *
+ * 字段名:子商户商户号 + * 变量名:sub_mchid + * 是否必填:否 + * 类型:string[1,32] + * 描述: + * 服务商模式下使用,子商户商户号,由微信支付生成并下发。 + * 示例值:1230000109 + *+ */ + @SerializedName(value = "sub_mchid") + protected String subMchid; /** *
* 字段名:商品描述
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayRefundRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayRefundRequest.java
index e145644d91..b0cbcf4e70 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayRefundRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayRefundRequest.java
@@ -230,7 +230,9 @@ public void checkAndSign(WxPayConfig config) throws WxPayException {
if (StringUtils.isBlank(this.getOpUserId())) {
this.setOpUserId(config.getMchId());
}
-
+ if (StringUtils.isBlank(this.getNotifyUrl())) {
+ this.setNotifyUrl(config.getRefundNotifyUrl());
+ }
super.checkAndSign(config);
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderV3GlobalRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderV3GlobalRequest.java
new file mode 100644
index 0000000000..296d3a8646
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/request/WxPayUnifiedOrderV3GlobalRequest.java
@@ -0,0 +1,57 @@
+package com.github.binarywang.wxpay.bean.request;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 境外微信支付统一下单请求参数对象.
+ * 参考文档:https://pay.weixin.qq.com/doc/global/v3/zh/4013014223
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = true)
+public class WxPayUnifiedOrderV3GlobalRequest extends WxPayUnifiedOrderV3Request implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:交易类型
+ * 变量名:trade_type
+ * 是否必填:是
+ * 类型:string[1,16]
+ * 描述:
+ * 交易类型,取值如下:
+ * JSAPI--JSAPI支付
+ * NATIVE--Native支付
+ * APP--APP支付
+ * H5--H5支付
+ * 示例值:JSAPI
+ *
+ */
+ @SerializedName(value = "trade_type")
+ private String tradeType;
+
+ /**
+ *
+ * 字段名:商户类目
+ * 变量名:merchant_category_code
+ * 是否必填:是
+ * 类型:string[1,32]
+ * 描述:
+ * 商户类目,境外商户必填
+ * 示例值:5812
+ *
+ */
+ @SerializedName(value = "merchant_category_code")
+ private String merchantCategoryCode;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositConsumeResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositConsumeResult.java
new file mode 100644
index 0000000000..dfb1bd3e69
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositConsumeResult.java
@@ -0,0 +1,103 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金消费结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositConsumeResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户消费单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的消费单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 消费金额
+ * consume_fee
+ * 是
+ * Int
+ * 88
+ * 本次消费的金额,单位为分
+ *
+ */
+ @XStreamAlias("consume_fee")
+ private Integer consumeFee;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 是
+ * Int
+ * 11
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ /**
+ *
+ * 消费时间
+ * time_end
+ * 是
+ * String(14)
+ * 20141030133525
+ * 消费完成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ consumeFee = readXmlInteger(d, "consume_fee");
+ remainFee = readXmlInteger(d, "remain_fee");
+ timeEnd = readXmlString(d, "time_end");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java
new file mode 100644
index 0000000000..66a5acb658
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositOrderQueryResult.java
@@ -0,0 +1,152 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 查询押金订单结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositOrderQueryResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户订单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部订单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 交易状态
+ * trade_state
+ * 是
+ * String(32)
+ * SUCCESS
+ * 交易状态:
+ * SUCCESS—支付成功
+ * REFUND—转入退款
+ * NOTPAY—未支付
+ * CLOSED—已关闭
+ * REVOKED—已撤销(付款码支付)
+ * USERPAYING—用户支付中(付款码支付)
+ * PAYERROR—支付失败(其他原因,如银行返回失败)
+ *
+ */
+ @XStreamAlias("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 交易状态描述
+ * trade_state_desc
+ * 是
+ * String(256)
+ * 支付成功
+ * 对当前查询订单状态的描述和下一步操作的指引
+ *
+ */
+ @XStreamAlias("trade_state_desc")
+ private String tradeStateDesc;
+
+ /**
+ *
+ * 押金金额
+ * total_fee
+ * 否
+ * Int
+ * 99
+ * 订单总金额,单位为分
+ *
+ */
+ @XStreamAlias("total_fee")
+ private Integer totalFee;
+
+ /**
+ *
+ * 现金支付金额
+ * cash_fee
+ * 否
+ * Int
+ * 99
+ * 现金支付金额订单现金支付金额
+ *
+ */
+ @XStreamAlias("cash_fee")
+ private Integer cashFee;
+
+ /**
+ *
+ * 支付完成时间
+ * time_end
+ * 否
+ * String(14)
+ * 20141030133525
+ * 订单支付时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 否
+ * Int
+ * 88
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ tradeState = readXmlString(d, "trade_state");
+ tradeStateDesc = readXmlString(d, "trade_state_desc");
+ totalFee = readXmlInteger(d, "total_fee");
+ cashFee = readXmlInteger(d, "cash_fee");
+ timeEnd = readXmlString(d, "time_end");
+ remainFee = readXmlInteger(d, "remain_fee");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java
new file mode 100644
index 0000000000..7c25b534a5
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositRefundResult.java
@@ -0,0 +1,103 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金退款结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositRefundResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户退款单号
+ * out_refund_no
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 商户系统内部的退款单号
+ *
+ */
+ @XStreamAlias("out_refund_no")
+ private String outRefundNo;
+
+ /**
+ *
+ * 微信退款单号
+ * refund_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信退款单号
+ *
+ */
+ @XStreamAlias("refund_id")
+ private String refundId;
+
+ /**
+ *
+ * 退款金额
+ * refund_fee
+ * 是
+ * Int
+ * 100
+ * 退款总金额,单位为分,可以做部分退款
+ *
+ */
+ @XStreamAlias("refund_fee")
+ private Integer refundFee;
+
+ /**
+ *
+ * 现金退款金额
+ * cash_refund_fee
+ * 否
+ * Int
+ * 100
+ * 现金退款金额,单位为分,只能为整数
+ *
+ */
+ @XStreamAlias("cash_refund_fee")
+ private Integer cashRefundFee;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outRefundNo = readXmlString(d, "out_refund_no");
+ refundId = readXmlString(d, "refund_id");
+ refundFee = readXmlInteger(d, "refund_fee");
+ cashRefundFee = readXmlInteger(d, "cash_refund_fee");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java
new file mode 100644
index 0000000000..98da8c878b
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnfreezeResult.java
@@ -0,0 +1,103 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金撤销结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnfreezeResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付押金订单号
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 商户撤销单号
+ * out_trade_no
+ * 是
+ * String(32)
+ * 20150806125346
+ * 商户系统内部的撤销单号
+ *
+ */
+ @XStreamAlias("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 撤销金额
+ * unfreeze_fee
+ * 是
+ * Int
+ * 99
+ * 撤销的押金金额,单位为分
+ *
+ */
+ @XStreamAlias("unfreeze_fee")
+ private Integer unfreezeFee;
+
+ /**
+ *
+ * 剩余押金
+ * remain_fee
+ * 是
+ * Int
+ * 0
+ * 剩余押金金额,单位为分
+ *
+ */
+ @XStreamAlias("remain_fee")
+ private Integer remainFee;
+
+ /**
+ *
+ * 撤销时间
+ * time_end
+ * 是
+ * String(14)
+ * 20141030133525
+ * 撤销完成时间,格式为yyyyMMddHHmmss
+ *
+ */
+ @XStreamAlias("time_end")
+ private String timeEnd;
+
+ @Override
+ protected void loadXml(Document d) {
+ transactionId = readXmlString(d, "transaction_id");
+ outTradeNo = readXmlString(d, "out_trade_no");
+ unfreezeFee = readXmlInteger(d, "unfreeze_fee");
+ remainFee = readXmlInteger(d, "remain_fee");
+ timeEnd = readXmlString(d, "time_end");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java
new file mode 100644
index 0000000000..120aeb111a
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxDepositUnifiedOrderResult.java
@@ -0,0 +1,89 @@
+package com.github.binarywang.wxpay.bean.result;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.w3c.dom.Document;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 押金下单结果
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@NoArgsConstructor
+@XStreamAlias("xml")
+public class WxDepositUnifiedOrderResult extends BaseWxPayResult implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 交易类型
+ * trade_type
+ * 是
+ * String(16)
+ * JSAPI
+ * 交易类型,取值为:JSAPI,NATIVE,APP等
+ *
+ */
+ @XStreamAlias("trade_type")
+ private String tradeType;
+
+ /**
+ *
+ * 预支付交易会话标识
+ * prepay_id
+ * 是
+ * String(64)
+ * wx201410272009395522657a690389285100
+ * 微信生成的预支付会话标识,用于后续接口调用中使用,该值有效期为2小时
+ *
+ */
+ @XStreamAlias("prepay_id")
+ private String prepayId;
+
+ /**
+ *
+ * 二维码链接
+ * code_url
+ * 否
+ * String(64)
+ * URl:weixin://wxpay/s/An4baqw
+ * trade_type 为 NATIVE 时有返回,可将该参数值生成二维码展示出来进行扫码支付
+ *
+ */
+ @XStreamAlias("code_url")
+ private String codeUrl;
+
+ /**
+ *
+ * 微信订单号
+ * transaction_id
+ * 是
+ * String(32)
+ * 1217752501201407033233368018
+ * 微信支付分配的交易会话标识
+ *
+ */
+ @XStreamAlias("transaction_id")
+ private String transactionId;
+
+ @Override
+ protected void loadXml(Document d) {
+ tradeType = readXmlString(d, "trade_type");
+ prepayId = readXmlString(d, "prepay_id");
+ codeUrl = readXmlString(d, "code_url");
+ transactionId = readXmlString(d, "transaction_id");
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
index 309fb8e752..5b60f3b520 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxPayUnifiedOrderV3Result.java
@@ -58,7 +58,7 @@ public class WxPayUnifiedOrderV3Result implements Serializable {
/**
*
* 字段名:二维码链接(NATIVE支付 会返回)
- * 变量名:h5_url
+ * 变量名:code_url
* 是否必填:是
* 类型:string[1,512]
* 描述:
@@ -81,6 +81,19 @@ public static class JsapiResult implements Serializable {
private String packageValue;
private String signType;
private String paySign;
+ /**
+ *
+ * 字段名:预支付交易会话标识
+ * 变量名:prepay_id
+ * 是否必填:否(用户可选存储)
+ * 类型:string[1,64]
+ * 描述:
+ * 预支付交易会话标识。用于后续接口调用中使用,该值有效期为2小时
+ * 此字段用于支持用户存储prepay_id,以便复用和重新生成支付签名
+ * 示例值:wx201410272009395522657a690389285100
+ *
+ */
+ private String prepayId;
private String getSignStr() {
return String.format("%s\n%s\n%s\n%s\n", appId, timeStamp, nonceStr, packageValue);
@@ -106,30 +119,123 @@ private String getSignStr() {
}
public T getPayInfo(TradeTypeEnum tradeType, String appId, String mchId, PrivateKey privateKey) {
- String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
- String nonceStr = SignUtils.genRandomStr();
switch (tradeType) {
case JSAPI:
- JsapiResult jsapiResult = new JsapiResult();
- jsapiResult.setAppId(appId).setTimeStamp(timestamp)
- .setPackageValue("prepay_id=" + this.prepayId).setNonceStr(nonceStr)
- //签名类型,默认为RSA,仅支持RSA。
- .setSignType("RSA").setPaySign(SignUtils.sign(jsapiResult.getSignStr(), privateKey));
- return (T) jsapiResult;
+ return (T) buildJsapiResult(this.prepayId, appId, privateKey);
case H5:
return (T) this.h5Url;
case APP:
- AppResult appResult = new AppResult();
- appResult.setAppid(appId).setPrepayId(this.prepayId).setPartnerId(mchId)
- .setNoncestr(nonceStr).setTimestamp(timestamp)
- //暂填写固定值Sign=WXPay
- .setPackageValue("Sign=WXPay")
- .setSign(SignUtils.sign(appResult.getSignStr(), privateKey));
- return (T) appResult;
+ return (T) buildAppResult(this.prepayId, appId, mchId, privateKey);
case NATIVE:
return (T) this.codeUrl;
default:
throw new WxRuntimeException("不支持的支付类型");
}
}
+
+ /**
+ *
+ * 根据已有的prepay_id生成JSAPI支付所需的参数对象(解耦版本)
+ * 应用场景:
+ * 1. 用户已经通过createPartnerOrderV3或unifiedPartnerOrderV3获取了prepay_id
+ * 2. 用户希望存储prepay_id用于后续复用
+ * 3. 支付失败后,使用存储的prepay_id重新生成支付签名信息
+ *
+ * 使用示例:
+ * // 步骤1:创建订单并获取prepay_id
+ * WxPayUnifiedOrderV3Result result = wxPayService.unifiedPartnerOrderV3(TradeTypeEnum.JSAPI, request);
+ * String prepayId = result.getPrepayId();
+ * // 存储prepayId到数据库...
+ *
+ * // 步骤2:需要支付时,使用存储的prepay_id生成支付信息
+ * WxPayUnifiedOrderV3Result.JsapiResult payInfo = WxPayUnifiedOrderV3Result.getJsapiPayInfo(
+ * prepayId, appId, wxPayService.getConfig().getPrivateKey()
+ * );
+ *
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param privateKey 商户私钥,用于签名
+ * @return JSAPI支付所需的参数对象
+ */
+ public static JsapiResult getJsapiPayInfo(String prepayId, String appId, PrivateKey privateKey) {
+ if (prepayId == null || appId == null || privateKey == null) {
+ throw new IllegalArgumentException("prepayId, appId 和 privateKey 不能为空");
+ }
+ return buildJsapiResult(prepayId, appId, privateKey);
+ }
+
+ /**
+ *
+ * 根据已有的prepay_id生成APP支付所需的参数对象(解耦版本)
+ * 应用场景:
+ * 1. 用户已经通过createPartnerOrderV3或unifiedPartnerOrderV3获取了prepay_id
+ * 2. 用户希望存储prepay_id用于后续复用
+ * 3. 支付失败后,使用存储的prepay_id重新生成支付签名信息
+ *
+ * 使用示例:
+ * // 步骤1:创建订单并获取prepay_id
+ * WxPayUnifiedOrderV3Result result = wxPayService.unifiedPartnerOrderV3(TradeTypeEnum.APP, request);
+ * String prepayId = result.getPrepayId();
+ * // 存储prepayId到数据库...
+ *
+ * // 步骤2:需要支付时,使用存储的prepay_id生成支付信息
+ * WxPayUnifiedOrderV3Result.AppResult payInfo = WxPayUnifiedOrderV3Result.getAppPayInfo(
+ * prepayId, appId, mchId, wxPayService.getConfig().getPrivateKey()
+ * );
+ *
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param mchId 商户号
+ * @param privateKey 商户私钥,用于签名
+ * @return APP支付所需的参数对象
+ */
+ public static AppResult getAppPayInfo(String prepayId, String appId, String mchId, PrivateKey privateKey) {
+ if (prepayId == null || appId == null || mchId == null || privateKey == null) {
+ throw new IllegalArgumentException("prepayId, appId, mchId 和 privateKey 不能为空");
+ }
+ return buildAppResult(prepayId, appId, mchId, privateKey);
+ }
+
+ /**
+ * 构建JSAPI支付结果对象
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param privateKey 商户私钥,用于签名
+ * @return JSAPI支付所需的参数对象
+ */
+ private static JsapiResult buildJsapiResult(String prepayId, String appId, PrivateKey privateKey) {
+ String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
+ String nonceStr = SignUtils.genRandomStr();
+ JsapiResult jsapiResult = new JsapiResult();
+ jsapiResult.setAppId(appId).setTimeStamp(timestamp)
+ .setPackageValue("prepay_id=" + prepayId).setNonceStr(nonceStr)
+ .setPrepayId(prepayId)
+ //签名类型,默认为RSA,仅支持RSA。
+ .setSignType("RSA").setPaySign(SignUtils.sign(jsapiResult.getSignStr(), privateKey));
+ return jsapiResult;
+ }
+
+ /**
+ * 构建APP支付结果对象
+ *
+ * @param prepayId 预支付交易会话标识
+ * @param appId 应用ID
+ * @param mchId 商户号
+ * @param privateKey 商户私钥,用于签名
+ * @return APP支付所需的参数对象
+ */
+ private static AppResult buildAppResult(String prepayId, String appId, String mchId, PrivateKey privateKey) {
+ String timestamp = String.valueOf(System.currentTimeMillis() / 1000);
+ String nonceStr = SignUtils.genRandomStr();
+ AppResult appResult = new AppResult();
+ appResult.setAppid(appId).setPrepayId(prepayId).setPartnerId(mchId)
+ .setNoncestr(nonceStr).setTimestamp(timestamp)
+ //暂填写固定值Sign=WXPay
+ .setPackageValue("Sign=WXPay")
+ .setSign(SignUtils.sign(appResult.getSignStr(), privateKey));
+ return appResult;
+ }
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
index 808b9d7ddf..af19aec60a 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResult.java
@@ -86,7 +86,7 @@ public class WxSignQueryResult extends BaseWxPayResult implements Serializable {
* 协议解约方式
* 非必传
*/
- @XStreamAlias("contract_terminated_mode")
+ @XStreamAlias("contract_termination_mode")
private Integer contractTerminatedMode;
/**
@@ -112,9 +112,9 @@ protected void loadXml(Document d) {
contractDisplayAccount = readXmlString(d, "contract_display_account");
contractState = readXmlInteger(d, "contract_state");
contractSignedTime = readXmlString(d, "contract_signed_time");
- contractExpiredTime = readXmlString(d, "contrace_Expired_time");
+ contractExpiredTime = readXmlString(d, "contract_expired_time");
contractTerminatedTime = readXmlString(d, "contract_terminated_time");
- contractTerminatedMode = readXmlInteger(d, "contract_terminate_mode");
+ contractTerminatedMode = readXmlInteger(d, "contract_termination_mode");
contractTerminationRemark = readXmlString(d, "contract_termination_remark");
openId = readXmlString(d, "openid");
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/enums/GlobalTradeTypeEnum.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/enums/GlobalTradeTypeEnum.java
new file mode 100644
index 0000000000..fd33b240f1
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/result/enums/GlobalTradeTypeEnum.java
@@ -0,0 +1,36 @@
+package com.github.binarywang.wxpay.bean.result.enums;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * 境外微信支付方式
+ * Overseas WeChat Pay trade types with global endpoints
+ *
+ * @author Binary Wang
+ */
+@Getter
+@AllArgsConstructor
+public enum GlobalTradeTypeEnum {
+ /**
+ * APP
+ */
+ APP("/global/v3/transactions/app"),
+ /**
+ * JSAPI 或 小程序
+ */
+ JSAPI("/global/v3/transactions/jsapi"),
+ /**
+ * NATIVE
+ */
+ NATIVE("/global/v3/transactions/native"),
+ /**
+ * H5
+ */
+ H5("/global/v3/transactions/h5");
+
+ /**
+ * 境外下单url
+ */
+ private final String url;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java
new file mode 100644
index 0000000000..b664f4cb7b
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/BillingPlan.java
@@ -0,0 +1,110 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 扣费计划信息
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class BillingPlan implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:计划类型
+ * 变量名:plan_type
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 扣费计划类型
+ * MONTHLY:按月扣费
+ * WEEKLY:按周扣费
+ * DAILY:按日扣费
+ * YEARLY:按年扣费
+ * 示例值:MONTHLY
+ *
+ */
+ @SerializedName("plan_type")
+ private String planType;
+
+ /**
+ *
+ * 字段名:扣费周期
+ * 变量名:period
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 扣费周期,配合plan_type使用
+ * 例如:plan_type为MONTHLY,period为1,表示每1个月扣费一次
+ * 示例值:1
+ *
+ */
+ @SerializedName("period")
+ private Integer period;
+
+ /**
+ *
+ * 字段名:总扣费次数
+ * 变量名:total_count
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 总扣费次数,不填表示无限次扣费
+ * 示例值:12
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ *
+ * 字段名:已扣费次数
+ * 变量名:executed_count
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 已扣费次数,查询时返回
+ * 示例值:2
+ *
+ */
+ @SerializedName("executed_count")
+ private Integer executedCount;
+
+ /**
+ *
+ * 字段名:计划开始时间
+ * 变量名:start_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 计划开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("start_time")
+ private String startTime;
+
+ /**
+ *
+ * 字段名:计划结束时间
+ * 变量名:end_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 计划结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2019-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("end_time")
+ private String endTime;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java
new file mode 100644
index 0000000000..c778a8ecb6
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionAmount.java
@@ -0,0 +1,49 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费金额信息
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionAmount implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:总金额
+ * 变量名:total
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 订单总金额,单位为分
+ * 示例值:100
+ *
+ */
+ @SerializedName("total")
+ private Integer total;
+
+ /**
+ *
+ * 字段名:货币类型
+ * 变量名:currency
+ * 是否必填:否
+ * 类型:string(16)
+ * 描述:
+ * CNY:人民币,境内商户号仅支持人民币
+ * 示例值:CNY
+ *
+ */
+ @SerializedName("currency")
+ private String currency;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java
new file mode 100644
index 0000000000..233d756f03
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelRequest.java
@@ -0,0 +1,49 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 取消预约扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionCancelRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:取消原因
+ * 变量名:cancel_reason
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 取消原因描述
+ * 示例值:用户主动取消
+ *
+ */
+ @SerializedName("cancel_reason")
+ private String cancelReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java
new file mode 100644
index 0000000000..74ca22f130
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionCancelResult.java
@@ -0,0 +1,77 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 取消预约扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionCancelResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态,取消后应为CANCELLED
+ * 示例值:CANCELLED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:取消时间
+ * 变量名:cancel_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 取消时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("cancel_time")
+ private String cancelTime;
+
+ /**
+ *
+ * 字段名:取消原因
+ * 变量名:cancel_reason
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 取消原因描述
+ * 示例值:用户主动取消
+ *
+ */
+ @SerializedName("cancel_reason")
+ private String cancelReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java
new file mode 100644
index 0000000000..2b5a3dec37
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingRequest.java
@@ -0,0 +1,104 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 立即扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionInstantBillingRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收微信支付结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java
new file mode 100644
index 0000000000..ac34307cd4
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionInstantBillingResult.java
@@ -0,0 +1,111 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 立即扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionInstantBillingResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:微信支付订单号
+ * 变量名:transaction_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:交易状态
+ * 变量名:trade_state
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 交易状态
+ * SUCCESS:支付成功
+ * REFUND:转入退款
+ * NOTPAY:未支付
+ * CLOSED:已关闭
+ * REVOKED:已撤销(刷卡支付)
+ * USERPAYING:用户支付中
+ * PAYERROR:支付失败
+ * 示例值:SUCCESS
+ *
+ */
+ @SerializedName("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 字段名:交易状态描述
+ * 变量名:trade_state_desc
+ * 是否必填:是
+ * 类型:string(256)
+ * 描述:
+ * 交易状态描述
+ * 示例值:支付成功
+ *
+ */
+ @SerializedName("trade_state_desc")
+ private String tradeStateDesc;
+
+ /**
+ *
+ * 字段名:支付完成时间
+ * 变量名:success_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 支付完成时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("success_time")
+ private String successTime;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java
new file mode 100644
index 0000000000..17e2c7dc19
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionQueryResult.java
@@ -0,0 +1,177 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费查询结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionQueryResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态
+ * SCHEDULED:已预约
+ * CANCELLED:已取消
+ * EXECUTED:已执行
+ * FAILED:执行失败
+ * 示例值:SCHEDULED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:创建时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约创建时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:更新时间
+ * 变量名:update_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 预约更新时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java
new file mode 100644
index 0000000000..51cf5aebd1
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleRequest.java
@@ -0,0 +1,131 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionScheduleRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号,只能是数字、大小写字母_-*且在同一个商户号下唯一
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息,用于连续包月等场景
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+
+ /**
+ *
+ * 字段名:通知地址
+ * 变量名:notify_url
+ * 是否必填:否
+ * 类型:string(256)
+ * 描述:
+ * 异步接收微信支付结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数
+ * 示例值:https://www.weixin.qq.com/wxpay/pay.php
+ *
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java
new file mode 100644
index 0000000000..fc0f9f6615
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionScheduleResult.java
@@ -0,0 +1,121 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 预约扣费响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionScheduleResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:是
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:预约状态
+ * 变量名:status
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约状态
+ * SCHEDULED:已预约
+ * CANCELLED:已取消
+ * EXECUTED:已执行
+ * FAILED:执行失败
+ * 示例值:SCHEDULED
+ *
+ */
+ @SerializedName("status")
+ private String status;
+
+ /**
+ *
+ * 字段名:预约扣费时间
+ * 变量名:schedule_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约扣费的时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("schedule_time")
+ private String scheduleTime;
+
+ /**
+ *
+ * 字段名:创建时间
+ * 变量名:create_time
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 预约创建时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ *
+ * 字段名:预约扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 预约扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:扣费计划
+ * 变量名:billing_plan
+ * 是否必填:否
+ * 类型:object
+ * 描述:
+ * 扣费计划信息
+ *
+ */
+ @SerializedName("billing_plan")
+ private BillingPlan billingPlan;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java
new file mode 100644
index 0000000000..17b3681cea
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryRequest.java
@@ -0,0 +1,91 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 查询扣费记录请求参数
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionTransactionQueryRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:开始时间
+ * 变量名:begin_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 查询开始时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("begin_time")
+ private String beginTime;
+
+ /**
+ *
+ * 字段名:结束时间
+ * 变量名:end_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 查询结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("end_time")
+ private String endTime;
+
+ /**
+ *
+ * 字段名:分页大小
+ * 变量名:limit
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 分页大小,不超过50
+ * 示例值:20
+ *
+ */
+ @SerializedName("limit")
+ private Integer limit;
+
+ /**
+ *
+ * 字段名:分页偏移量
+ * 变量名:offset
+ * 是否必填:否
+ * 类型:int
+ * 描述:
+ * 分页偏移量
+ * 示例值:0
+ *
+ */
+ @SerializedName("offset")
+ private Integer offset;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java
new file mode 100644
index 0000000000..75fff11a22
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/subscriptionbilling/SubscriptionTransactionQueryResult.java
@@ -0,0 +1,190 @@
+package com.github.binarywang.wxpay.bean.subscriptionbilling;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 查询扣费记录响应结果
+ *
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ */
+@Data
+@NoArgsConstructor
+public class SubscriptionTransactionQueryResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:总数量
+ * 变量名:total_count
+ * 是否必填:是
+ * 类型:int
+ * 描述:
+ * 符合条件的记录总数量
+ * 示例值:100
+ *
+ */
+ @SerializedName("total_count")
+ private Integer totalCount;
+
+ /**
+ *
+ * 字段名:扣费记录列表
+ * 变量名:data
+ * 是否必填:是
+ * 类型:array
+ * 描述:
+ * 扣费记录列表
+ *
+ */
+ @SerializedName("data")
+ private List data;
+
+ /**
+ * 扣费记录
+ */
+ @Data
+ @NoArgsConstructor
+ public static class SubscriptionTransaction implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * 字段名:微信支付订单号
+ * 变量名:transaction_id
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 微信支付系统生成的订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("transaction_id")
+ private String transactionId;
+
+ /**
+ *
+ * 字段名:商户订单号
+ * 变量名:out_trade_no
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 商户系统内部订单号
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("out_trade_no")
+ private String outTradeNo;
+
+ /**
+ *
+ * 字段名:预约扣费ID
+ * 变量名:subscription_id
+ * 是否必填:否
+ * 类型:string(64)
+ * 描述:
+ * 微信支付预约扣费ID,预约扣费产生的交易才有此字段
+ * 示例值:1217752501201407033233368018
+ *
+ */
+ @SerializedName("subscription_id")
+ private String subscriptionId;
+
+ /**
+ *
+ * 字段名:交易状态
+ * 变量名:trade_state
+ * 是否必填:是
+ * 类型:string(32)
+ * 描述:
+ * 交易状态
+ * SUCCESS:支付成功
+ * REFUND:转入退款
+ * NOTPAY:未支付
+ * CLOSED:已关闭
+ * REVOKED:已撤销(刷卡支付)
+ * USERPAYING:用户支付中
+ * PAYERROR:支付失败
+ * 示例值:SUCCESS
+ *
+ */
+ @SerializedName("trade_state")
+ private String tradeState;
+
+ /**
+ *
+ * 字段名:支付完成时间
+ * 变量名:success_time
+ * 是否必填:否
+ * 类型:string(32)
+ * 描述:
+ * 支付完成时间,遵循rfc3339标准格式
+ * 示例值:2018-06-08T10:34:56+08:00
+ *
+ */
+ @SerializedName("success_time")
+ private String successTime;
+
+ /**
+ *
+ * 字段名:扣费金额
+ * 变量名:amount
+ * 是否必填:是
+ * 类型:object
+ * 描述:
+ * 扣费金额信息
+ *
+ */
+ @SerializedName("amount")
+ private SubscriptionAmount amount;
+
+ /**
+ *
+ * 字段名:用户标识
+ * 变量名:openid
+ * 是否必填:是
+ * 类型:string(128)
+ * 描述:
+ * 用户在直连商户appid下的唯一标识
+ * 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
+ *
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ *
+ * 字段名:订单描述
+ * 变量名:description
+ * 是否必填:是
+ * 类型:string(127)
+ * 描述:
+ * 订单描述
+ * 示例值:腾讯充值中心-QQ会员充值
+ *
+ */
+ @SerializedName("description")
+ private String description;
+
+ /**
+ *
+ * 字段名:附加数据
+ * 变量名:attach
+ * 是否必填:否
+ * 类型:string(128)
+ * 描述:
+ * 附加数据
+ * 示例值:自定义数据
+ *
+ */
+ @SerializedName("attach")
+ private String attach;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryRequest.java
new file mode 100644
index 0000000000..f1323655a1
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryRequest.java
@@ -0,0 +1,44 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 运营工具-商家转账查询请求参数
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class BusinessOperationTransferQueryRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 商户系统内部的商家单号
+ * 与transfer_bill_no二选一
+ */
+ @SerializedName("out_bill_no")
+ private String outBillNo;
+
+ /**
+ * 微信转账单号
+ * 与out_bill_no二选一
+ */
+ @SerializedName("transfer_bill_no")
+ private String transferBillNo;
+
+ /**
+ * 直连商户的appid
+ * 可选
+ */
+ @SerializedName("appid")
+ private String appid;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryResult.java
new file mode 100644
index 0000000000..0cfd8f8570
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferQueryResult.java
@@ -0,0 +1,101 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 运营工具-商家转账查询结果
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+@Data
+@NoArgsConstructor
+public class BusinessOperationTransferQueryResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 直连商户的appid
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 商户系统内部的商家单号
+ */
+ @SerializedName("out_bill_no")
+ private String outBillNo;
+
+ /**
+ * 微信转账单号
+ */
+ @SerializedName("transfer_bill_no")
+ private String transferBillNo;
+
+ /**
+ * 运营工具转账场景ID
+ */
+ @SerializedName("operation_scene_id")
+ private String operationSceneId;
+
+ /**
+ * 用户在直连商户应用下的用户标示
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 收款用户姓名
+ * 已脱敏
+ */
+ @SerializedName("user_name")
+ private String userName;
+
+ /**
+ * 转账金额
+ * 单位为"分"
+ */
+ @SerializedName("transfer_amount")
+ private Integer transferAmount;
+
+ /**
+ * 转账备注
+ */
+ @SerializedName("transfer_remark")
+ private String transferRemark;
+
+ /**
+ * 转账状态
+ * WAIT_PAY:等待确认
+ * PROCESSING:转账中
+ * SUCCESS:转账成功
+ * FAIL:转账失败
+ * REFUND:已退款
+ */
+ @SerializedName("transfer_state")
+ private String transferState;
+
+ /**
+ * 发起转账的时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 转账更新时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ * 失败原因
+ * 当transfer_state为FAIL时返回
+ */
+ @SerializedName("fail_reason")
+ private String failReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferRequest.java
new file mode 100644
index 0000000000..0129798ed9
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferRequest.java
@@ -0,0 +1,125 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.github.binarywang.wxpay.v3.SpecEncrypt;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import lombok.experimental.Accessors;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 运营工具-商家转账请求参数
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class BusinessOperationTransferRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 直连商户的appid
+ * 必须
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 商户系统内部的商家单号
+ * 必须,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
+ */
+ @SerializedName("out_bill_no")
+ private String outBillNo;
+
+ /**
+ * 转账场景ID
+ * 必须,该笔转账使用的转账场景,可前往"商户平台-产品中心-商家转账"中申请。
+ * 运营工具场景ID如:2001(现金营销)、2002(佣金报酬)、2003(推广奖励)等
+ * 可使用 {@link com.github.binarywang.wxpay.constant.WxPayConstants.OperationSceneId} 中定义的常量
+ */
+ @SerializedName("transfer_scene_id")
+ private String transferSceneId;
+
+ /**
+ * 用户在直连商户应用下的用户标示
+ * 必须
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 收款用户姓名
+ * 可选,传入则校验收款用户姓名
+ * 使用RSA加密,使用OAEP填充方式
+ */
+ @SpecEncrypt
+ @SerializedName("user_name")
+ private String userName;
+
+ /**
+ * 转账金额
+ * 必须,单位为"分"
+ */
+ @SerializedName("transfer_amount")
+ private Integer transferAmount;
+
+ /**
+ * 转账备注
+ * 必须,会在转账成功消息和转账详情页向用户展示
+ */
+ @SerializedName("transfer_remark")
+ private String transferRemark;
+
+ /**
+ * 用户收款感知
+ * 可选,用于在转账成功消息中向用户展示特定内容
+ */
+ @SerializedName("user_recv_perception")
+ private String userRecvPerception;
+
+ /**
+ * 异步接收微信支付转账结果通知的回调地址
+ * 可选,通知URL必须为外网可以正常访问的地址,不能携带查询参数
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ * 转账场景报备信息
+ * 必须,需按转账场景准确填写报备信息,参考 转账场景报备信息字段说明
+ */
+ @SerializedName("transfer_scene_report_infos")
+ private List transferSceneReportInfos;
+
+ /**
+ * 转账场景报备信息
+ */
+ @Data
+ @Accessors(chain = true)
+ public static class TransferSceneReportInfo implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 信息类型
+ * 必须,不能超过15个字符,商户所属转账场景下的信息类型,此字段内容为固定值,需严格按照 转账场景报备信息字段说明 传参。
+ */
+ @SerializedName("info_type")
+ private String infoType;
+
+ /**
+ * 信息内容
+ * 必须,不能超过32个字符,商户所属转账场景下的信息内容,商户可按实际业务场景自定义传参,需严格按照 转账场景报备信息字段说明 传参。
+ */
+ @SerializedName("info_content")
+ private String infoContent;
+
+ }
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferResult.java
new file mode 100644
index 0000000000..91771b43e1
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/BusinessOperationTransferResult.java
@@ -0,0 +1,76 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ * 运营工具-商家转账结果
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+@Data
+@NoArgsConstructor
+public class BusinessOperationTransferResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 商户系统内部的商家单号
+ */
+ @SerializedName("out_bill_no")
+ private String outBillNo;
+
+ /**
+ * 微信转账单号
+ * 微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("transfer_bill_no")
+ private String transferBillNo;
+
+ /**
+ * 单据状态
+ * 商家转账订单状态
+ * ACCEPTED:转账已受理,可原单重试(非终态)。
+ * PROCESSING: 转账锁定资金中。如果一直停留在该状态,建议检查账户余额是否足够,如余额不足,可充值后再原单重试(非终态)。
+ * WAIT_USER_CONFIRM: 待收款用户确认,当前转账单据资金已锁定,可拉起微信收款确认页面进行收款确认(非终态)。
+ * TRANSFERING: 转账中,可拉起微信收款确认页面再次重试确认收款(非终态)。
+ * SUCCESS: 转账成功,表示转账单据已成功(终态)。
+ * FAIL: 转账失败,表示该笔转账单据已失败。若需重新向用户转账,请重新生成单据并再次发起(终态)。
+ * CANCELING: 转账撤销中,商户撤销请求受理成功,该笔转账正在撤销中,需查单确认撤销的转账单据状态(非终态)。
+ * CANCELLED: 转账撤销完成,代表转账单据已撤销成功(终态)。
+ */
+ @SerializedName("state")
+ private String state;
+
+ /**
+ * 跳转领取页面的package信息
+ * 跳转微信支付收款页的package信息, APP调起用户确认收款 或者 JSAPI调起用户确认收款 时需要使用的参数。仅当转账单据状态为WAIT_USER_CONFIRM时返回。
+ * 单据创建后,用户24小时内不领取将过期关闭,建议拉起用户确认收款页面前,先查单据状态:如单据状态为WAIT_USER_CONFIRM,可用之前的package信息拉起;单据到终态时需更换单号重新发起转账。
+ */
+ @SerializedName("package_info")
+ private String packageInfo;
+
+ /**
+ * 发起转账的时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 转账更新时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ * 失败原因
+ * 当transfer_state为FAIL时返回
+ */
+ @SerializedName("fail_reason")
+ private String failReason;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchGetResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchGetResult.java
new file mode 100644
index 0000000000..d32db8c7c2
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchGetResult.java
@@ -0,0 +1,170 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ *
+ * 预约转账批次单号查询接口响应结果
+ * 通过预约批次单号查询批量预约商家转账批次单基本信息。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class ReservationTransferBatchGetResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户号】 微信支付分配的商户号
+ */
+ @SerializedName("mch_id")
+ private String mchId;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【微信预约批次单号】 微信预约批次单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("reservation_batch_no")
+ private String reservationBatchNo;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【批次备注】 批次备注
+ */
+ @SerializedName("batch_remark")
+ private String batchRemark;
+
+ /**
+ * 【转账场景ID】 商户在商户平台-产品中心-商家转账中申请的转账场景ID
+ */
+ @SerializedName("transfer_scene_id")
+ private String transferSceneId;
+
+ /**
+ * 【批次状态】
+ * ACCEPTED: 批次已受理
+ * PROCESSING: 批次处理中
+ * FINISHED: 批次处理完成
+ * CLOSED: 批次已关闭
+ */
+ @SerializedName("batch_state")
+ private String batchState;
+
+ /**
+ * 【转账总金额】 转账金额单位为"分"
+ */
+ @SerializedName("total_amount")
+ private Integer totalAmount;
+
+ /**
+ * 【转账总笔数】 转账总笔数
+ */
+ @SerializedName("total_num")
+ private Integer totalNum;
+
+ /**
+ * 【转账成功金额】 转账成功金额单位为"分"
+ */
+ @SerializedName("success_amount")
+ private Integer successAmount;
+
+ /**
+ * 【转账成功笔数】 转账成功笔数
+ */
+ @SerializedName("success_num")
+ private Integer successNum;
+
+ /**
+ * 【转账失败金额】 转账失败金额单位为"分"
+ */
+ @SerializedName("fail_amount")
+ private Integer failAmount;
+
+ /**
+ * 【转账失败笔数】 转账失败笔数
+ */
+ @SerializedName("fail_num")
+ private Integer failNum;
+
+ /**
+ * 【批次创建时间】 批次受理成功时返回
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 【批次更新时间】 批次最后更新时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ * 【批次关闭原因】 批次关闭原因
+ * MERCHANT_REVOCATION: 商户主动撤销
+ * OVERDUE_CLOSE: 系统超时关闭
+ */
+ @SerializedName("close_reason")
+ private String closeReason;
+
+ /**
+ * 【是否需要查询明细】
+ */
+ @SerializedName("need_query_detail")
+ private Boolean needQueryDetail;
+
+ /**
+ * 【转账明细列表】
+ */
+ @SerializedName("transfer_detail_list")
+ private List transferDetailList;
+
+ /**
+ * 转账明细
+ */
+ @Data
+ @NoArgsConstructor
+ public static class TransferDetail implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户明细单号】 商户系统内部区分转账批次单下不同转账明细单的唯一标识
+ */
+ @SerializedName("out_detail_no")
+ private String outDetailNo;
+
+ /**
+ * 【微信转账单号】 微信转账单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("transfer_bill_no")
+ private String transferBillNo;
+
+ /**
+ * 【明细状态】
+ * PROCESSING: 转账处理中
+ * SUCCESS: 转账成功
+ * FAIL: 转账失败
+ */
+ @SerializedName("detail_state")
+ private String detailState;
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchRequest.java
new file mode 100644
index 0000000000..82e3d6f328
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchRequest.java
@@ -0,0 +1,148 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.github.binarywang.wxpay.v3.SpecEncrypt;
+import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ *
+ * 批量预约商家转账请求参数
+ * 商户可以通过批量预约接口一次发起批量转账请求,最多可以同时向50个用户发起转账。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@Builder(builderMethodName = "newBuilder")
+@NoArgsConstructor
+@AllArgsConstructor
+public class ReservationTransferBatchRequest implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【转账场景ID】 商户在商户平台-产品中心-商家转账中申请的转账场景ID
+ */
+ @SerializedName("transfer_scene_id")
+ private String transferSceneId;
+
+ /**
+ * 【批次备注】 批次备注
+ */
+ @SerializedName("batch_remark")
+ private String batchRemark;
+
+ /**
+ * 【转账总金额】 转账金额单位为"分",转账总金额必须与批次内所有转账明细金额之和保持一致,否则无法发起转账操作
+ */
+ @SerializedName("total_amount")
+ private Integer totalAmount;
+
+ /**
+ * 【转账总笔数】 转账总笔数,需要与批次内所有转账明细笔数保持一致,否则无法发起转账操作
+ */
+ @SerializedName("total_num")
+ private Integer totalNum;
+
+ /**
+ * 【转账明细列表】 转账明细列表,最多50条
+ */
+ @SerializedName("transfer_detail_list")
+ private List transferDetailList;
+
+ /**
+ * 【异步回调地址】 异步接收微信支付结果通知的回调地址,通知url必须为公网可访问的url,必须为https,不能携带参数
+ */
+ @SerializedName("notify_url")
+ private String notifyUrl;
+
+ /**
+ * 转账明细
+ */
+ @Data
+ @Builder(builderMethodName = "newBuilder")
+ @NoArgsConstructor
+ @AllArgsConstructor
+ public static class TransferDetail implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户明细单号】 商户系统内部区分转账批次单下不同转账明细单的唯一标识,要求此参数只能由数字、大小写字母组成
+ */
+ @SerializedName("out_detail_no")
+ private String outDetailNo;
+
+ /**
+ * 【转账金额】 转账金额单位为"分"
+ */
+ @SerializedName("transfer_amount")
+ private Integer transferAmount;
+
+ /**
+ * 【转账备注】 单条转账备注(微信用户会收到该备注),UTF8编码,最多允许32个字符
+ */
+ @SerializedName("transfer_remark")
+ private String transferRemark;
+
+ /**
+ * 【收款用户OpenID】 商户AppID下,某用户的OpenID
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 【收款用户姓名】 收款方真实姓名。支持标准RSA算法和国密算法,公钥由微信侧提供
+ */
+ @SpecEncrypt
+ @SerializedName("user_name")
+ private String userName;
+
+ /**
+ * 【转账场景报备信息】
+ */
+ @SerializedName("transfer_scene_report_infos")
+ private List transferSceneReportInfos;
+ }
+
+ /**
+ * 转账场景报备信息
+ */
+ @Data
+ @Builder(builderMethodName = "newBuilder")
+ @NoArgsConstructor
+ @AllArgsConstructor
+ public static class TransferSceneReportInfo implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【信息类型】 信息类型编码
+ */
+ @SerializedName("info_type")
+ private String infoType;
+
+ /**
+ * 【信息内容】 信息内容
+ */
+ @SerializedName("info_content")
+ private String infoContent;
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchResult.java
new file mode 100644
index 0000000000..ef762cee5b
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferBatchResult.java
@@ -0,0 +1,51 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 批量预约商家转账响应结果
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class ReservationTransferBatchResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【微信预约批次单号】 微信预约批次单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("reservation_batch_no")
+ private String reservationBatchNo;
+
+ /**
+ * 【批次创建时间】 批次受理成功时返回
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 【批次状态】
+ * ACCEPTED: 批次已受理
+ * PROCESSING: 批次处理中
+ * FINISHED: 批次处理完成
+ * CLOSED: 批次已关闭
+ */
+ @SerializedName("batch_state")
+ private String batchState;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java
new file mode 100644
index 0000000000..438354e7bd
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/ReservationTransferNotifyResult.java
@@ -0,0 +1,173 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.github.binarywang.wxpay.bean.notify.OriginNotifyResponse;
+import com.github.binarywang.wxpay.bean.notify.WxPayBaseNotifyV3Result;
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ *
+ * 预约商家转账通知回调结果
+ * 预约批次单中的明细单在转账成功或转账失败时,微信会把相关结果信息发送给商户。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+public class ReservationTransferNotifyResult implements Serializable, WxPayBaseNotifyV3Result {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 源数据
+ */
+ private OriginNotifyResponse rawData;
+
+ /**
+ * 解密后的数据
+ */
+ private ReservationTransferNotifyResult.DecryptNotifyResult result;
+
+ @Data
+ @NoArgsConstructor
+ public static class DecryptNotifyResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户号】 微信支付分配的商户号
+ */
+ @SerializedName("mch_id")
+ private String mchId;
+
+ /**
+ * 【商户预约批次单号】 商户系统内部的商家预约批次单号
+ */
+ @SerializedName("out_batch_no")
+ private String outBatchNo;
+
+ /**
+ * 【微信预约批次单号】 微信预约批次单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("reservation_batch_no")
+ private String reservationBatchNo;
+
+ /**
+ * 【批次状态】
+ * ACCEPTED: 批次已受理
+ * PROCESSING: 批次处理中
+ * FINISHED: 批次处理完成
+ * CLOSED: 批次已关闭
+ */
+ @SerializedName("batch_state")
+ private String batchState;
+
+ /**
+ * 【转账总金额】 转账金额单位为"分"
+ */
+ @SerializedName("total_amount")
+ private Integer totalAmount;
+
+ /**
+ * 【转账总笔数】 转账总笔数
+ */
+ @SerializedName("total_num")
+ private Integer totalNum;
+
+ /**
+ * 【转账成功金额】 转账成功金额单位为"分"
+ */
+ @SerializedName("success_amount")
+ private Integer successAmount;
+
+ /**
+ * 【转账成功笔数】 转账成功笔数
+ */
+ @SerializedName("success_num")
+ private Integer successNum;
+
+ /**
+ * 【转账失败金额】 转账失败金额单位为"分"
+ */
+ @SerializedName("fail_amount")
+ private Integer failAmount;
+
+ /**
+ * 【转账失败笔数】 转账失败笔数
+ */
+ @SerializedName("fail_num")
+ private Integer failNum;
+
+ /**
+ * 【批次创建时间】 批次受理成功时返回
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("create_time")
+ private String createTime;
+
+ /**
+ * 【批次更新时间】 批次最后更新时间
+ * 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("update_time")
+ private String updateTime;
+
+ /**
+ * 【转账明细列表】
+ */
+ @SerializedName("transfer_detail_list")
+ private List transferDetailList;
+ }
+
+ /**
+ * 转账明细通知
+ */
+ @Data
+ @NoArgsConstructor
+ public static class TransferDetailNotify implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户明细单号】 商户系统内部区分转账批次单下不同转账明细单的唯一标识
+ */
+ @SerializedName("out_detail_no")
+ private String outDetailNo;
+
+ /**
+ * 【微信转账单号】 微信转账单号,微信商家转账系统返回的唯一标识
+ */
+ @SerializedName("transfer_bill_no")
+ private String transferBillNo;
+
+ /**
+ * 【明细状态】
+ * PROCESSING: 转账处理中
+ * SUCCESS: 转账成功
+ * FAIL: 转账失败
+ */
+ @SerializedName("detail_state")
+ private String detailState;
+
+ /**
+ * 【收款用户OpenID】 商户AppID下,某用户的OpenID
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 【转账金额】 转账金额单位为"分"
+ */
+ @SerializedName("transfer_amount")
+ private Integer transferAmount;
+
+ /**
+ * 【失败原因】 转账失败原因
+ */
+ @SerializedName("fail_reason")
+ private String failReason;
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
index 230e564e4b..2ac4b08c93 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/TransferBillsRequest.java
@@ -87,6 +87,26 @@ public class TransferBillsRequest implements Serializable {
@SerializedName("transfer_scene_report_infos")
private List transferSceneReportInfos;
+ /**
+ * 收款授权模式
+ *
+ * 字段名:收款授权模式
+ * 变量名:receipt_authorization_mode
+ * 是否必填:否
+ * 类型:string
+ * 描述:
+ * 控制收款方式的授权模式,可选值:
+ * - CONFIRM_RECEIPT_AUTHORIZATION:需确认收款授权模式(默认值)
+ * - NO_CONFIRM_RECEIPT_AUTHORIZATION:免确认收款授权模式(需要用户事先授权)
+ * 为空时,默认为需确认收款授权模式
+ * 示例值:NO_CONFIRM_RECEIPT_AUTHORIZATION
+ *
+ *
+ * @see com.github.binarywang.wxpay.constant.WxPayConstants.ReceiptAuthorizationMode
+ */
+ @SerializedName("receipt_authorization_mode")
+ private String receiptAuthorizationMode;
+
@Data
@Builder(builderMethodName = "newBuilder")
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/UserAuthorizationStatusResult.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/UserAuthorizationStatusResult.java
new file mode 100644
index 0000000000..e0bab82150
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/bean/transfer/UserAuthorizationStatusResult.java
@@ -0,0 +1,63 @@
+package com.github.binarywang.wxpay.bean.transfer;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+
+/**
+ *
+ * 商户查询用户授权信息接口响应结果
+ * 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。
+ * 文档地址:https://pay.weixin.qq.com/doc/v3/merchant/4015901167
+ *
+ *
+ * @author wanggang
+ * created on 2025/11/28
+ */
+@Data
+@NoArgsConstructor
+public class UserAuthorizationStatusResult implements Serializable {
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * 【商户AppID】 商户在微信申请公众号或移动应用成功后分配的账号ID
+ */
+ @SerializedName("appid")
+ private String appid;
+
+ /**
+ * 【商户号】 微信支付分配的商户号
+ */
+ @SerializedName("mch_id")
+ private String mchId;
+
+ /**
+ * 【用户标识】 用户在直连商户应用下的用户标识
+ */
+ @SerializedName("openid")
+ private String openid;
+
+ /**
+ * 【授权状态】 用户授权状态
+ * UNAUTHORIZED: 未授权
+ * AUTHORIZED: 已授权
+ */
+ @SerializedName("authorization_state")
+ private String authorizationState;
+
+ /**
+ * 【授权时间】 用户授权时间,遵循rfc3339标准格式
+ * 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("authorize_time")
+ private String authorizeTime;
+
+ /**
+ * 【取消授权时间】 用户取消授权时间,遵循rfc3339标准格式
+ * 格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE
+ */
+ @SerializedName("deauthorize_time")
+ private String deauthorizeTime;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
index ee44780590..88e544e675 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/config/WxPayConfig.java
@@ -18,6 +18,10 @@
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
+import org.apache.http.config.Registry;
+import org.apache.http.config.RegistryBuilder;
+import org.apache.http.conn.socket.ConnectionSocketFactory;
+import org.apache.http.conn.socket.PlainConnectionSocketFactory;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
@@ -29,6 +33,7 @@
import javax.net.ssl.SSLContext;
import java.io.*;
import java.net.URL;
+import java.nio.charset.StandardCharsets;
import java.security.KeyStore;
import java.security.PrivateKey;
import java.security.PublicKey;
@@ -50,6 +55,7 @@ public class WxPayConfig {
private static final String DEFAULT_PAY_BASE_URL = "https://api.mch.weixin.qq.com";
private static final String PROBLEM_MSG = "证书文件【%s】有问题,请核实!";
private static final String NOT_FOUND_MSG = "证书文件【%s】不存在,请核实!";
+ private static final String CERT_NAME_P12 = "p12证书";
/**
* 微信支付接口请求地址域名部分.
@@ -91,9 +97,13 @@ public class WxPayConfig {
*/
private String subMchId;
/**
- * 微信支付异步回掉地址,通知url必须为直接可访问的url,不能携带参数.
+ * 微信支付异步回调地址,通知url必须为直接可访问的url,不能携带参数.
*/
private String notifyUrl;
+ /**
+ * 退款结果异步回调地址,通知url必须为直接可访问的url,不能携带参数.
+ */
+ private String refundNotifyUrl;
/**
* 交易类型.
*
@@ -301,7 +311,7 @@ public SSLContext initSSLContext() throws WxPayException {
}
try (InputStream inputStream = this.loadConfigInputStream(this.keyString, this.getKeyPath(),
- this.keyContent, "p12证书")) {
+ this.keyContent, CERT_NAME_P12)) {
KeyStore keystore = KeyStore.getInstance("PKCS12");
char[] partnerId2charArray = this.getMchId().toCharArray();
keystore.load(inputStream, partnerId2charArray);
@@ -319,7 +329,8 @@ public SSLContext initSSLContext() throws WxPayException {
*
* @return org.apache.http.impl.client.CloseableHttpClient
* @author doger.wang
- **/
+ * @throws WxPayException 微信支付异常
+ */
public CloseableHttpClient initApiV3HttpClient() throws WxPayException {
if (StringUtils.isBlank(this.getApiV3Key())) {
throw new WxPayException("请确保apiV3Key值已设置");
@@ -337,7 +348,7 @@ public CloseableHttpClient initApiV3HttpClient() throws WxPayException {
certificate = (X509Certificate) objects[1];
this.certSerialNo = certificate.getSerialNumber().toString(16).toUpperCase();
}
- if (certificate == null && StringUtils.isBlank(this.getCertSerialNo()) && StringUtils.isNotBlank(this.getPrivateCertPath())) {
+ if (certificate == null && StringUtils.isBlank(this.getCertSerialNo()) && (StringUtils.isNotBlank(this.getPrivateCertPath()) || StringUtils.isNotBlank(this.getPrivateCertString()) || this.getPrivateCertContent() != null)) {
try (InputStream certInputStream = this.loadConfigInputStream(this.getPrivateCertString(), this.getPrivateCertPath(),
this.privateCertContent, "privateCertPath")) {
certificate = PemUtils.loadCertificate(certInputStream);
@@ -345,7 +356,7 @@ public CloseableHttpClient initApiV3HttpClient() throws WxPayException {
this.certSerialNo = certificate.getSerialNumber().toString(16).toUpperCase();
}
- if (this.getPublicKeyString() != null || this.getPublicKeyPath() != null || this.publicKeyContent != null) {
+ if (StringUtils.isNotBlank(this.getPublicKeyString()) || StringUtils.isNotBlank(this.getPublicKeyPath()) || this.publicKeyContent != null) {
if (StringUtils.isBlank(this.getPublicKeyId())) {
throw new WxPayException("请确保和publicKeyId配套使用");
}
@@ -371,6 +382,9 @@ public CloseableHttpClient initApiV3HttpClient() throws WxPayException {
Verifier certificatesVerifier;
if (this.fullPublicKeyModel) {
// 使用完全公钥模式时,只加载公钥相关配置,避免下载平台证书使灰度切换无法达到100%覆盖
+ if (publicKey == null) {
+ throw new WxPayException("完全公钥模式下,请确保公钥配置(publicKeyPath/publicKeyString/publicKeyContent)及publicKeyId已设置");
+ }
certificatesVerifier = VerifierBuilder.buildPublicCertVerifier(this.publicKeyId, publicKey);
} else {
certificatesVerifier = VerifierBuilder.build(
@@ -431,7 +445,36 @@ private InputStream loadConfigInputStream(String configString, String configPath
}
if (StringUtils.isNotEmpty(configString)) {
- configContent = Base64.getDecoder().decode(configString);
+ // 判断是否为PEM格式的字符串(包含-----BEGIN和-----END标记)
+ if (isPemFormat(configString)) {
+ // PEM格式直接转为字节流,让PemUtils处理
+ configContent = configString.getBytes(StandardCharsets.UTF_8);
+ } else {
+ // 尝试Base64解码
+ try {
+ byte[] decoded = Base64.getDecoder().decode(configString);
+ // 检查解码后的内容是否为PEM格式(即用户传入的是base64编码的完整PEM文件)
+ String decodedString = new String(decoded, StandardCharsets.UTF_8);
+ if (isPemFormat(decodedString)) {
+ // 解码后是PEM格式,使用解码后的内容
+ configContent = decoded;
+ } else {
+ // 解码后不是PEM格式,可能是:
+ // 1. p12证书的二进制内容 - 应该返回解码后的二进制数据
+ // 2. 私钥/公钥的纯base64内容(不含PEM头尾) - 应该返回原始字符串,让PemUtils处理
+ // 通过certName区分:p12证书使用解码后的数据,其他情况返回原始字符串
+ if (CERT_NAME_P12.equals(certName)) {
+ configContent = decoded;
+ } else {
+ // 对于私钥/公钥/证书,返回原始字符串字节,让PemUtils处理base64解码
+ configContent = configString.getBytes(StandardCharsets.UTF_8);
+ }
+ }
+ } catch (IllegalArgumentException e) {
+ // Base64解码失败,可能是格式不正确,抛出异常
+ throw new WxPayException(String.format("【%s】的Base64格式不正确", certName), e);
+ }
+ }
return new ByteArrayInputStream(configContent);
}
@@ -442,6 +485,16 @@ private InputStream loadConfigInputStream(String configString, String configPath
return this.loadConfigInputStream(configPath);
}
+ /**
+ * 判断字符串是否为PEM格式(包含-----BEGIN和-----END标记)
+ *
+ * @param content 要检查的字符串
+ * @return 是否为PEM格式
+ */
+ private boolean isPemFormat(String content) {
+ return content != null && content.contains("-----BEGIN") && content.contains("-----END");
+ }
+
/**
* 从配置路径 加载配置 信息(支持 classpath、本地路径、网络url)
@@ -511,7 +564,7 @@ private Object[] p12ToPem() {
// 分解p12证书文件
try (InputStream inputStream = this.loadConfigInputStream(this.keyString, this.getKeyPath(),
- this.keyContent, "p12证书")) {
+ this.keyContent, CERT_NAME_P12)) {
KeyStore keyStore = KeyStore.getInstance("PKCS12");
keyStore.load(inputStream, key.toCharArray());
@@ -579,7 +632,20 @@ public CloseableHttpClient initSslHttpClient() throws WxPayException {
}
// 创建支持SSL的连接池管理器
- PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
+ SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(
+ sslContext,
+ new DefaultHostnameVerifier()
+ );
+
+ Registry socketFactoryRegistry = RegistryBuilder
+ .create()
+ .register("https", sslsf)
+ .register("http", PlainConnectionSocketFactory.getSocketFactory())
+ .build();
+ PoolingHttpClientConnectionManager connectionManager =
+ new PoolingHttpClientConnectionManager(socketFactoryRegistry);
+
+ // PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
connectionManager.setMaxTotal(this.maxConnTotal);
connectionManager.setDefaultMaxPerRoute(this.maxConnPerRoute);
@@ -602,6 +668,8 @@ public CloseableHttpClient initSslHttpClient() throws WxPayException {
/**
* 配置HTTP代理
+ *
+ * @param httpClientBuilder HttpClient构建器
*/
private void configureProxy(org.apache.http.impl.client.HttpClientBuilder httpClientBuilder) {
if (StringUtils.isNotBlank(this.getHttpProxyHost()) && this.getHttpProxyPort() > 0) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
index e8a6b6acb3..2b736691b7 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/constant/WxPayConstants.java
@@ -401,6 +401,71 @@ public static class TransformBillState {
}
+
+ /**
+ * 用户授权状态
+ *
+ * @see 商户查询用户授权信息
+ */
+ @UtilityClass
+ public static class AuthorizationState {
+ /**
+ * 未授权
+ */
+ public static final String UNAUTHORIZED = "UNAUTHORIZED";
+
+ /**
+ * 已授权
+ */
+ public static final String AUTHORIZED = "AUTHORIZED";
+ }
+
+ /**
+ * 预约转账批次状态
+ *
+ * @see 批量预约商家转账
+ */
+ @UtilityClass
+ public static class ReservationBatchState {
+ /**
+ * 批次已受理
+ */
+ public static final String ACCEPTED = "ACCEPTED";
+
+ /**
+ * 批次处理中
+ */
+ public static final String PROCESSING = "PROCESSING";
+
+ /**
+ * 批次处理完成
+ */
+ public static final String FINISHED = "FINISHED";
+
+ /**
+ * 批次已关闭
+ */
+ public static final String CLOSED = "CLOSED";
+ }
+
+ /**
+ * 预约转账批次关闭原因
+ *
+ * @see 预约转账批次单号查询
+ */
+ @UtilityClass
+ public static class ReservationBatchCloseReason {
+ /**
+ * 商户主动撤销
+ */
+ public static final String MERCHANT_REVOCATION = "MERCHANT_REVOCATION";
+
+ /**
+ * 系统超时关闭
+ */
+ public static final String OVERDUE_CLOSE = "OVERDUE_CLOSE";
+ }
+
/**
* 【转账场景ID】 该笔转账使用的转账场景,可前往“商户平台-产品中心-商家转账”中申请。
*/
@@ -412,6 +477,29 @@ public static class TransformSceneId {
public static final String CASH_MARKETING = "1001";
}
+ /**
+ * 【运营工具转账场景ID】 运营工具专用转账场景,用于商户日常运营活动
+ *
+ * @see 运营工具-商家转账API
+ */
+ @UtilityClass
+ public static class OperationSceneId {
+ /**
+ * 运营工具现金营销
+ */
+ public static final String OPERATION_CASH_MARKETING = "2001";
+
+ /**
+ * 运营工具佣金报酬
+ */
+ public static final String OPERATION_COMMISSION = "2002";
+
+ /**
+ * 运营工具推广奖励
+ */
+ public static final String OPERATION_PROMOTION = "2003";
+ }
+
/**
* 用户收款感知
*
@@ -436,4 +524,25 @@ public static class CASH_MARKETING {
}
}
+
+ /**
+ * 收款授权模式
+ *
+ * @see 官方文档
+ */
+ @UtilityClass
+ public static class ReceiptAuthorizationMode {
+ /**
+ * 需确认收款授权模式(默认值)
+ * 用户需要手动确认才能收款
+ */
+ public static final String CONFIRM_RECEIPT_AUTHORIZATION = "CONFIRM_RECEIPT_AUTHORIZATION";
+
+ /**
+ * 免确认收款授权模式
+ * 用户授权后,收款不需要确认,转账直接到账
+ */
+ public static final String NO_CONFIRM_RECEIPT_AUTHORIZATION = "NO_CONFIRM_RECEIPT_AUTHORIZATION";
+ }
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java
new file mode 100644
index 0000000000..117395ba62
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/BusinessOperationTransferExample.java
@@ -0,0 +1,143 @@
+package com.github.binarywang.wxpay.example;
+
+import com.github.binarywang.wxpay.bean.transfer.*;
+import com.github.binarywang.wxpay.config.WxPayConfig;
+import com.github.binarywang.wxpay.constant.WxPayConstants;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.BusinessOperationTransferService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.service.impl.WxPayServiceImpl;
+
+import java.util.Arrays;
+
+/**
+ * 运营工具-商家转账API使用示例
+ *
+ * 微信支付为商户提供的运营工具转账能力,用于商户的日常运营活动中进行转账操作
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+public class BusinessOperationTransferExample {
+
+ private WxPayService wxPayService;
+ private BusinessOperationTransferService businessOperationTransferService;
+
+ public void init() {
+ // 初始化配置
+ WxPayConfig config = new WxPayConfig();
+ config.setAppId("your_app_id");
+ config.setMchId("your_mch_id");
+ config.setMchKey("your_mch_key");
+ config.setKeyPath("path_to_your_cert.p12");
+
+ // 初始化服务
+ wxPayService = new WxPayServiceImpl();
+ wxPayService.setConfig(config);
+ businessOperationTransferService = wxPayService.getBusinessOperationTransferService();
+ }
+
+ /**
+ * 发起运营工具转账示例
+ */
+ public void createOperationTransferExample() {
+ try {
+ // 构建转账请求
+ BusinessOperationTransferRequest.TransferSceneReportInfo reportInfo = new BusinessOperationTransferRequest.TransferSceneReportInfo();
+ reportInfo.setInfoType("活动名称");
+ reportInfo.setInfoContent("新会员有礼");
+
+ BusinessOperationTransferRequest request = BusinessOperationTransferRequest.newBuilder()
+ .appid("your_app_id") // 应用ID
+ .outBillNo("OT" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId(WxPayConstants.OperationSceneId.OPERATION_CASH_MARKETING) // 运营工具转账场景ID
+ .transferSceneReportInfos(Arrays.asList(reportInfo)) // 转账场景报备信息
+ .openid("user_openid") // 用户openid
+ .userName("张三") // 用户姓名(可选)
+ .transferAmount(100) // 转账金额,单位分
+ .transferRemark("运营活动奖励") // 转账备注
+ .userRecvPerception(WxPayConstants.UserRecvPerception.CASH_MARKETING.CASH) // 用户收款感知
+ .notifyUrl("https://your-domain.com/notify") // 回调通知地址
+ .build();
+
+ // 发起转账
+ BusinessOperationTransferResult result = businessOperationTransferService.createOperationTransfer(request);
+
+ System.out.println("转账成功!");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("单据状态: " + result.getState());
+ System.out.println("跳转领取页面的package信息: " + result.getPackageInfo());
+ System.out.println("创建时间: " + result.getCreateTime());
+
+ } catch (WxPayException e) {
+ System.err.println("转账失败: " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * 通过商户单号查询转账结果示例
+ */
+ public void queryByOutBillNoExample() {
+ try {
+ String outBillNo = "OT1640995200000"; // 商户转账单号
+
+ BusinessOperationTransferQueryResult result = businessOperationTransferService
+ .queryOperationTransferByOutBillNo(outBillNo);
+
+ System.out.println("查询成功!");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("转账状态: " + result.getTransferState());
+ System.out.println("转账金额: " + result.getTransferAmount() + "分");
+ System.out.println("创建时间: " + result.getCreateTime());
+ System.out.println("更新时间: " + result.getUpdateTime());
+
+ } catch (WxPayException e) {
+ System.err.println("查询失败: " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * 通过微信转账单号查询转账结果示例
+ */
+ public void queryByTransferBillNoExample() {
+ try {
+ String transferBillNo = "1040000071100999991182020050700019480001"; // 微信转账单号
+
+ BusinessOperationTransferQueryResult result = businessOperationTransferService
+ .queryOperationTransferByTransferBillNo(transferBillNo);
+
+ System.out.println("查询成功!");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("运营场景ID: " + result.getOperationSceneId());
+ System.out.println("转账状态: " + result.getTransferState());
+
+ } catch (WxPayException e) {
+ System.err.println("查询失败: " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * 使用配置示例
+ */
+ public static void main(String[] args) {
+ BusinessOperationTransferExample example = new BusinessOperationTransferExample();
+
+ // 初始化配置
+ example.init();
+
+ // 1. 发起运营工具转账
+ example.createOperationTransferExample();
+
+ // 2. 查询转账结果
+ // example.queryByOutBillNoExample();
+
+ // 3. 通过微信转账单号查询
+ // example.queryByTransferBillNoExample();
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
index 8d74e5a4ef..228234d589 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/example/NewTransferApiExample.java
@@ -3,6 +3,7 @@
import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
import com.github.binarywang.wxpay.bean.transfer.*;
import com.github.binarywang.wxpay.config.WxPayConfig;
+import com.github.binarywang.wxpay.constant.WxPayConstants;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.service.TransferService;
import com.github.binarywang.wxpay.service.WxPayService;
@@ -215,6 +216,100 @@ public void batchTransferExample() {
}
}
+ /**
+ * 使用免确认收款授权模式进行转账示例
+ * 注意:使用此模式前,用户需要先进行授权
+ */
+ public void transferWithNoConfirmAuthModeExample() {
+ try {
+ // 构建转账请求,使用免确认收款授权模式
+ TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("wx1234567890123456")
+ .outBillNo("NO_CONFIRM_" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID(佣金报酬)
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 收款用户的openid
+ .transferAmount(200) // 转账金额,单位:分(此处为2元)
+ .transferRemark("免确认收款转账") // 转账备注
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.NO_CONFIRM_RECEIPT_AUTHORIZATION)
+ .userRecvPerception("Y") // 用户收款感知
+ .build();
+
+ // 发起转账
+ TransferBillsResult result = transferService.transferBills(request);
+
+ System.out.println("=== 免确认授权模式转账成功 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("说明: 使用免确认授权模式,转账直接到账,无需用户确认");
+
+ } catch (WxPayException e) {
+ System.err.println("免确认授权转账失败: " + e.getMessage());
+ System.err.println("错误代码: " + e.getErrCode());
+
+ // 可能的错误原因
+ if ("USER_NOT_AUTHORIZED".equals(e.getErrCode())) {
+ System.err.println("用户未授权免确认收款,请先引导用户进行授权");
+ }
+ }
+ }
+
+ /**
+ * 使用需确认收款授权模式进行转账示例(默认模式)
+ */
+ public void transferWithConfirmAuthModeExample() {
+ try {
+ // 构建转账请求,显式设置为需确认收款授权模式
+ TransferBillsRequest request = TransferBillsRequest.newBuilder()
+ .appid("wx1234567890123456")
+ .outBillNo("CONFIRM_" + System.currentTimeMillis()) // 商户转账单号
+ .transferSceneId("1005") // 转账场景ID
+ .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") // 收款用户的openid
+ .transferAmount(150) // 转账金额,单位:分(此处为1.5元)
+ .transferRemark("需确认收款转账") // 转账备注
+ .receiptAuthorizationMode(WxPayConstants.ReceiptAuthorizationMode.CONFIRM_RECEIPT_AUTHORIZATION)
+ .userRecvPerception("Y") // 用户收款感知
+ .build();
+
+ // 发起转账
+ TransferBillsResult result = transferService.transferBills(request);
+
+ System.out.println("=== 需确认授权模式转账成功 ===");
+ System.out.println("商户单号: " + result.getOutBillNo());
+ System.out.println("微信转账单号: " + result.getTransferBillNo());
+ System.out.println("状态: " + result.getState());
+ System.out.println("packageInfo: " + result.getPackageInfo());
+ System.out.println("说明: 使用需确认授权模式,用户需要手动确认才能收款");
+
+ } catch (WxPayException e) {
+ System.err.println("需确认授权转账失败: " + e.getMessage());
+ }
+ }
+
+ /**
+ * 权限模式对比示例
+ * 展示两种权限模式的区别和使用场景
+ */
+ public void authModeComparisonExample() {
+ System.out.println("\n=== 收款授权模式对比 ===");
+ System.out.println("1. 需确认收款授权模式 (CONFIRM_RECEIPT_AUTHORIZATION):");
+ System.out.println(" - 这是默认模式");
+ System.out.println(" - 用户收到转账后需要手动点击确认才能到账");
+ System.out.println(" - 适用于一般的转账场景");
+ System.out.println(" - 转账状态可能包含 WAIT_USER_CONFIRM 等待确认状态");
+
+ System.out.println("\n2. 免确认收款授权模式 (NO_CONFIRM_RECEIPT_AUTHORIZATION):");
+ System.out.println(" - 用户事先授权后,转账直接到账,无需确认");
+ System.out.println(" - 提升用户体验,减少操作步骤");
+ System.out.println(" - 适用于高频转账场景,如佣金发放等");
+ System.out.println(" - 需要用户先进行授权,否则会返回授权错误");
+
+ System.out.println("\n使用建议:");
+ System.out.println("- 高频业务场景推荐使用免确认模式,提升用户体验");
+ System.out.println("- 首次使用需引导用户进行授权");
+ System.out.println("- 处理授权相关异常,提供友好的错误提示");
+ }
+
/**
* 使用配置示例
*/
@@ -230,20 +325,29 @@ public static void main(String[] args) {
// 创建示例实例
NewTransferApiExample example = new NewTransferApiExample(config);
+ // 权限模式对比说明
+ example.authModeComparisonExample();
+
// 运行示例
System.out.println("新版商户转账API使用示例");
System.out.println("===============================");
- // 1. 发起单笔转账
+ // 1. 发起转账(使用免确认授权模式)
+ // example.transferWithNoConfirmAuthModeExample();
+
+ // 2. 发起转账(使用需确认授权模式)
+ // example.transferWithConfirmAuthModeExample();
+
+ // 3. 发起单笔转账(默认模式)
example.transferExample();
- // 2. 查询转账结果
+ // 4. 查询转账结果
// example.queryByOutBillNoExample();
- // 3. 撤销转账
+ // 5. 撤销转账
// example.cancelTransferExample();
- // 4. 批量转账(传统API)
+ // 6. 批量转账(传统API)
// example.batchTransferExample();
}
}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/BusinessOperationTransferService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/BusinessOperationTransferService.java
new file mode 100644
index 0000000000..195d3a8409
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/BusinessOperationTransferService.java
@@ -0,0 +1,82 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.transfer.BusinessOperationTransferRequest;
+import com.github.binarywang.wxpay.bean.transfer.BusinessOperationTransferResult;
+import com.github.binarywang.wxpay.bean.transfer.BusinessOperationTransferQueryRequest;
+import com.github.binarywang.wxpay.bean.transfer.BusinessOperationTransferQueryResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ * 运营工具-商家转账API
+ *
+ * 微信支付为商户提供的运营工具转账能力,用于商户的日常运营活动中进行转账操作
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+public interface BusinessOperationTransferService {
+
+ /**
+ *
+ * 发起运营工具商家转账
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/transfer-bills
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param request 运营工具转账请求参数
+ * @return BusinessOperationTransferResult 转账结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferResult createOperationTransfer(BusinessOperationTransferRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param request 查询请求参数
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransfer(BusinessOperationTransferQueryRequest request) throws WxPayException;
+
+ /**
+ *
+ * 通过商户单号查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param outBillNo 商户单号
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransferByOutBillNo(String outBillNo) throws WxPayException;
+
+ /**
+ *
+ * 通过微信转账单号查询运营工具转账结果
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/transfer-bills/transfer-bill-no/{transfer_bill_no}
+ *
+ * 文档地址:运营工具-商家转账API
+ *
+ *
+ * @param transferBillNo 微信转账单号
+ * @return BusinessOperationTransferQueryResult 查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ BusinessOperationTransferQueryResult queryOperationTransferByTransferBillNo(String transferBillNo) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
index 2dbb2906c3..b630ce1785 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/EcommerceService.java
@@ -417,10 +417,23 @@ public interface EcommerceService {
*/
RefundNotifyResult parseRefundNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+ /**
+ *
+ * 提现状态变更通知回调数据处理
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013049135
+ *
+ *
+ * @param notifyData 通知数据
+ * @param header 通知头部数据,不传则表示不校验头
+ * @return 解密后通知数据 withdraw notify result
+ * @throws WxPayException the wx pay exception
+ */
+ WithdrawNotifyResult parseWithdrawNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
/**
*
* 二级商户账户余额提现API
- * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_2.shtml
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476652
*
*
* @param request 提现请求
@@ -432,7 +445,7 @@ public interface EcommerceService {
/**
*
* 电商平台提现API
- * 文档地址: https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/fund/chapter3_5.shtml
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476670
*
*
* @param request 提现请求
@@ -466,6 +479,43 @@ public interface EcommerceService {
*/
SpWithdrawStatusResult querySpWithdrawByOutRequestNo(String outRequestNo) throws WxPayException;
+ /**
+ *
+ * 平台查询预约提现状态(根据微信支付预约提现单号查询)
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4012476674
+ *
+ *
+ * @param withdrawId 微信支付提现单号
+ * @return 返回数据 return sp withdraw status result
+ * @throws WxPayException the wx pay exception
+ */
+ SpWithdrawStatusResult querySpWithdrawByWithdrawId(String withdrawId) throws WxPayException;
+
+ /**
+ *
+ * 二级商户按日终余额预约提现
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013328143
+ *
+ *
+ * @param request 提现请求
+ * @return 返回数据 return day-end balance withdraw result
+ * @throws WxPayException the wx pay exception
+ */
+ SubDayEndBalanceWithdrawResult subDayEndBalanceWithdraw(SubDayEndBalanceWithdrawRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询二级商户按日终余额预约提现状态
+ * 文档地址: https://pay.weixin.qq.com/doc/v3/partner/4013328163
+ *
+ *
+ * @param subMchid 二级商户号
+ * @param outRequestNo 商户提现单号
+ * @return 返回数据 return day-end balance withdraw status result
+ * @throws WxPayException the wx pay exception
+ */
+ SubDayEndBalanceWithdrawStatusResult querySubDayEndBalanceWithdraw(String subMchid, String outRequestNo) throws WxPayException;
+
/**
*
* 修改结算账号API
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
new file mode 100644
index 0000000000..5e2f678c16
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/MiPayService.java
@@ -0,0 +1,95 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersRequest;
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersResult;
+import com.github.binarywang.wxpay.bean.mipay.MedInsRefundNotifyRequest;
+import com.github.binarywang.wxpay.bean.notify.MiPayNotifyV3Result;
+import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ * 医保相关接口
+ * 医保相关接口
+ * @author xgl
+ * @date 2025/12/20
+ */
+public interface MiPayService {
+
+ /**
+ *
+ * 医保自费混合收款下单
+ *
+ * 从业机构调用该接口向微信医保后台下单
+ *
+ * 文档地址:医保自费混合收款下单
+ *
+ *
+ * @param request 下单参数
+ * @return ReservationTransferNotifyResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult medInsOrders(MedInsOrdersRequest request) throws WxPayException;
+
+ /**
+ *
+ * 使用医保自费混合订单号查看下单结果
+ *
+ * 从业机构使用混合下单订单号,通过该接口主动查询订单状态,完成下一步的业务逻辑。
+ *
+ * 文档地址:使用医保自费混合订单号查看下单结果
+ *
+ *
+ * @param mixTradeNo 医保自费混合订单号
+ * @param subMchid 医疗机构的商户号
+ * @return MedInsOrdersResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult getMedInsOrderByMixTradeNo(String mixTradeNo, String subMchid) throws WxPayException;
+
+ /**
+ *
+ * 使用从业机构订单号查看下单结果
+ *
+ * 从业机构使用从业机构订单号、医疗机构商户号,通过该接口主动查询订单状态,完成下一步的业务逻辑。
+ *
+ * 文档地址:使用从业机构订单号查看下单结果
+ *
+ *
+ * @param outTradeNo 从业机构订单号
+ * @param subMchid 医疗机构的商户号
+ * @return MedInsOrdersResult 下单结果
+ * @throws WxPayException the wx pay exception
+ */
+ MedInsOrdersResult getMedInsOrderByOutTradeNo(String outTradeNo, String subMchid) throws WxPayException;
+
+ /**
+ *
+ * 解析医保混合收款成功通知
+ *
+ * 微信支付会通过POST请求向商户设置的回调URL推送医保混合收款成功通知,商户需要接收处理该消息,并返回应答。
+ *
+ * 文档地址:医保混合收款成功通知
+ *
+ *
+ * @param notifyData 通知数据字符串
+ * @return MiPayNotifyV3Result 医保混合收款成功通知结果
+ * @throws WxPayException the wx pay exception
+ */
+ MiPayNotifyV3Result parseMiPayNotifyV3Result(String notifyData, SignatureHeader header) throws WxPayException;
+
+ /**
+ *
+ * 医保退款通知
+ *
+ * 从业机构调用该接口向微信医保后台通知医保订单的退款成功结果
+ *
+ * 文档地址:医保退款通知
+ *
+ *
+ * @param request 医保退款通知请求参数
+ * @param mixTradeNo 【医保自费混合订单号】 医保自费混合订单号
+ * @throws WxPayException the wx pay exception
+ */
+ void medInsRefundNotify(MedInsRefundNotifyRequest request, String mixTradeNo) throws WxPayException;
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java
new file mode 100644
index 0000000000..d69bda7d33
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/RealNameService.java
@@ -0,0 +1,43 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ *
+ * 微信支付实名验证相关服务类.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+public interface RealNameService {
+ /**
+ *
+ * 获取用户实名认证信息API.
+ * 用于商户查询用户的实名认证状态,如果用户未实名认证,会返回引导用户实名认证的URL
+ * 文档详见:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ * 接口链接:https://api.mch.weixin.qq.com/userinfo/realnameauth/query
+ *
+ *
+ * @param request 请求对象
+ * @return 实名认证查询结果
+ * @throws WxPayException the wx pay exception
+ */
+ RealNameResult queryRealName(RealNameRequest request) throws WxPayException;
+
+ /**
+ *
+ * 获取用户实名认证信息API(简化方法).
+ * 用于商户查询用户的实名认证状态,如果用户未实名认证,会返回引导用户实名认证的URL
+ * 文档详见:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ * 接口链接:https://api.mch.weixin.qq.com/userinfo/realnameauth/query
+ *
+ *
+ * @param openid 用户openid
+ * @return 实名认证查询结果
+ * @throws WxPayException the wx pay exception
+ */
+ RealNameResult queryRealName(String openid) throws WxPayException;
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java
new file mode 100644
index 0000000000..e662e4dd4f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/SubscriptionBillingService.java
@@ -0,0 +1,105 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ * 微信支付-预约扣费服务 (连续包月功能)
+ *
+ * 微信支付预约扣费功能,支持商户在用户授权的情况下,
+ * 按照约定的时间和金额,自动从用户的支付账户中扣取费用。
+ * 主要用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-08-31
+ */
+public interface SubscriptionBillingService {
+
+ /**
+ * 预约扣费
+ *
+ * 商户可以通过该接口预约未来某个时间点的扣费。
+ * 适用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 预约扣费请求参数
+ * @return 预约扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionScheduleResult scheduleSubscription(SubscriptionScheduleRequest request) throws WxPayException;
+
+ /**
+ * 查询预约扣费
+ *
+ * 商户可以通过该接口查询已预约的扣费信息。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}
+ * 请求方式: GET
+ *
+ *
+ * @param subscriptionId 预约扣费ID
+ * @return 预约扣费查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionQueryResult querySubscription(String subscriptionId) throws WxPayException;
+
+ /**
+ * 取消预约扣费
+ *
+ * 商户可以通过该接口取消已预约的扣费。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/schedule/{subscription_id}/cancel
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 取消预约扣费请求参数
+ * @return 取消预约扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionCancelResult cancelSubscription(SubscriptionCancelRequest request) throws WxPayException;
+
+ /**
+ * 立即扣费
+ *
+ * 商户可以通过该接口立即执行扣费操作。
+ * 通常用于补扣失败的费用或者特殊情况下的即时扣费。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/instant-billing
+ * 请求方式: POST
+ * 是否需要证书: 是
+ *
+ *
+ * @param request 立即扣费请求参数
+ * @return 立即扣费结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionInstantBillingResult instantBilling(SubscriptionInstantBillingRequest request) throws WxPayException;
+
+ /**
+ * 查询扣费记录
+ *
+ * 商户可以通过该接口查询扣费记录。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ * 请求URL: https://api.mch.weixin.qq.com/v3/subscription-billing/transactions
+ * 请求方式: GET
+ *
+ *
+ * @param request 查询扣费记录请求参数
+ * @return 扣费记录查询结果
+ * @throws WxPayException 微信支付异常
+ */
+ SubscriptionTransactionQueryResult queryTransactions(SubscriptionTransactionQueryRequest request) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
index 01113c9506..e48e327505 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/TransferService.java
@@ -189,4 +189,123 @@ public interface TransferService {
* @throws WxPayException the wx pay exception
*/
TransferBillsNotifyResult parseTransferBillsNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
+ // ===================== 用户授权免确认模式相关接口 =====================
+
+ /**
+ *
+ * 商户查询用户授权信息接口
+ *
+ * 商户通过此接口可查询用户是否对商户的商家转账场景进行了授权。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:商户查询用户授权信息
+ *
+ *
+ * @param openid 用户在直连商户应用下的用户标识
+ * @param transferSceneId 转账场景ID
+ * @return UserAuthorizationStatusResult 用户授权信息
+ * @throws WxPayException .
+ */
+ UserAuthorizationStatusResult getUserAuthorizationStatus(String openid, String transferSceneId) throws WxPayException;
+
+ /**
+ *
+ * 批量预约商家转账接口
+ *
+ * 商户可以通过批量预约接口一次发起批量转账请求,最多可以同时向50个用户发起转账。
+ * 批量预约接口适用于用户已授权免确认的场景,在转账时无需用户确认即可完成转账。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:批量预约商家转账
+ *
+ *
+ * @param request 批量预约商家转账请求参数
+ * @return ReservationTransferBatchResult 批量预约商家转账结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchResult reservationTransferBatch(ReservationTransferBatchRequest request) throws WxPayException;
+
+ /**
+ *
+ * 商户预约批次单号查询批次单接口
+ *
+ * 通过商户预约批次单号查询批量预约商家转账批次单基本信息。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:商户预约批次单号查询批次单
+ *
+ *
+ * @param outBatchNo 商户预约批次单号
+ * @param needQueryDetail 是否需要查询明细
+ * @param offset 分页偏移量
+ * @param limit 分页大小
+ * @param detailState 明细状态(PROCESSING/SUCCESS/FAIL)
+ * @return ReservationTransferBatchGetResult 批量预约商家转账批次查询结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchGetResult getReservationTransferBatchByOutBatchNo(String outBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException;
+
+ /**
+ *
+ * 微信预约批次单号查询批次单接口
+ *
+ * 通过微信预约批次单号查询批量预约商家转账批次单基本信息。
+ *
+ * 请求方式:GET(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:微信预约批次单号查询批次单
+ *
+ *
+ * @param reservationBatchNo 微信预约批次单号
+ * @param needQueryDetail 是否需要查询明细
+ * @param offset 分页偏移量
+ * @param limit 分页大小
+ * @param detailState 明细状态(PROCESSING/SUCCESS/FAIL)
+ * @return ReservationTransferBatchGetResult 批量预约商家转账批次查询结果
+ * @throws WxPayException .
+ */
+ ReservationTransferBatchGetResult getReservationTransferBatchByReservationBatchNo(String reservationBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException;
+
+ /**
+ *
+ * 解析预约商家转账通知回调结果
+ *
+ * 预约批次单中的明细单在转账成功或转账失败时,微信会把相关结果信息发送给商户。
+ *
+ * 文档地址:预约商家转账通知
+ *
+ *
+ * @param notifyData 通知数据
+ * @param header 通知头部数据,不传则表示不校验头
+ * @return ReservationTransferNotifyResult 预约商家转账通知结果
+ * @throws WxPayException the wx pay exception
+ */
+ ReservationTransferNotifyResult parseReservationTransferNotifyResult(String notifyData, SignatureHeader header) throws WxPayException;
+
+ /**
+ *
+ * 关闭预约商家转账批次接口
+ *
+ * 商户可以通过此接口关闭预约商家转账批次单。关闭后,该批次内所有未成功的转账将被取消。
+ *
+ * 请求方式:POST(HTTPS)
+ * 请求地址:请求地址
+ *
+ * 文档地址:关闭预约商家转账批次
+ *
+ *
+ * @param outBatchNo 商户预约批次单号
+ * @throws WxPayException .
+ */
+ void closeReservationTransferBatch(String outBatchNo) throws WxPayException;
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java
new file mode 100644
index 0000000000..cb0bc3b062
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxDepositService.java
@@ -0,0 +1,90 @@
+package com.github.binarywang.wxpay.service;
+
+import com.github.binarywang.wxpay.bean.request.WxDepositConsumeRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositOrderQueryRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositRefundRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositUnfreezeRequest;
+import com.github.binarywang.wxpay.bean.request.WxDepositUnifiedOrderRequest;
+import com.github.binarywang.wxpay.bean.result.WxDepositConsumeResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositOrderQueryResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositRefundResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositUnfreezeResult;
+import com.github.binarywang.wxpay.bean.result.WxDepositUnifiedOrderResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+
+/**
+ *
+ * 微信押金支付相关接口.
+ * https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=1
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+public interface WxDepositService {
+
+ /**
+ *
+ * 押金下单
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=2
+ * 用于商户发起押金支付,支持JSAPI、NATIVE、APP等支付方式
+ *
+ *
+ * @param request 押金下单请求对象
+ * @return wx deposit unified order result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositUnifiedOrderResult unifiedOrder(WxDepositUnifiedOrderRequest request) throws WxPayException;
+
+ /**
+ *
+ * 查询押金订单
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=3
+ * 通过商户订单号或微信订单号查询押金订单状态
+ *
+ *
+ * @param request 查询押金订单请求对象
+ * @return wx deposit order query result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositOrderQueryResult queryOrder(WxDepositOrderQueryRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金消费
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=4
+ * 用于对已支付的押金进行消费扣减
+ *
+ *
+ * @param request 押金消费请求对象
+ * @return wx deposit consume result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositConsumeResult consume(WxDepositConsumeRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金撤销
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=5
+ * 用于对已支付的押金进行撤销退还
+ *
+ *
+ * @param request 押金撤销请求对象
+ * @return wx deposit unfreeze result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositUnfreezeResult unfreeze(WxDepositUnfreezeRequest request) throws WxPayException;
+
+ /**
+ *
+ * 押金退款
+ * 详见:https://pay.weixin.qq.com/wiki/doc/api/deposit_sl.php?chapter=27_7&index=6
+ * 用于对已消费的押金进行退款
+ *
+ *
+ * @param request 押金退款请求对象
+ * @return wx deposit refund result
+ * @throws WxPayException wx pay exception
+ */
+ WxDepositRefundResult refund(WxDepositRefundRequest request) throws WxPayException;
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
index 8ceac2b6ba..2db2987d12 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/WxPayService.java
@@ -6,6 +6,7 @@
import com.github.binarywang.wxpay.bean.request.*;
import com.github.binarywang.wxpay.bean.result.*;
import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
+import com.github.binarywang.wxpay.bean.result.enums.GlobalTradeTypeEnum;
import com.github.binarywang.wxpay.bean.transfer.TransferBillsNotifyResult;
import com.github.binarywang.wxpay.config.WxPayConfig;
import com.github.binarywang.wxpay.constant.WxPayConstants;
@@ -77,6 +78,18 @@ public interface WxPayService {
*/
boolean switchover(String mchId, String appId);
+ /**
+ * 仅根据商户号进行切换.
+ * 适用于一个商户号对应多个appId的场景,切换时会匹配符合该商户号的配置.
+ * 注意:由于HashMap迭代顺序不确定,当存在多个匹配项时返回的配置是不可预测的,建议使用精确匹配方式.
+ *
+ * @param mchId 商户标识
+ * @return 切换是否成功,如果找不到匹配的配置则返回false
+ */
+ default boolean switchover(String mchId) {
+ return false;
+ }
+
/**
* 进行相应的商户切换.
*
@@ -86,6 +99,19 @@ public interface WxPayService {
*/
WxPayService switchoverTo(String mchId, String appId);
+ /**
+ * 仅根据商户号进行切换.
+ * 适用于一个商户号对应多个appId的场景,切换时会匹配符合该商户号的配置.
+ * 注意:由于HashMap迭代顺序不确定,当存在多个匹配项时返回的配置是不可预测的,建议使用精确匹配方式.
+ *
+ * @param mchId 商户标识
+ * @return 切换成功,则返回当前对象,方便链式调用
+ * @throws me.chanjar.weixin.common.error.WxRuntimeException 如果找不到匹配的配置
+ */
+ default WxPayService switchoverTo(String mchId) {
+ throw new me.chanjar.weixin.common.error.WxRuntimeException("子类需要实现此方法");
+ }
+
/**
* 发送post请求,得到响应字节数组.
*
@@ -108,6 +134,19 @@ public interface WxPayService {
*/
String post(String url, String requestStr, boolean useKey) throws WxPayException;
+
+ /**
+ * 发送post请求,得到响应字符串.
+ *
+ * @param url 请求地址
+ * @param requestStr 请求信息
+ * @param useKey 是否使用证书
+ * @param mimeType Content-Type请求头
+ * @return 返回请求结果字符串 string
+ * @throws WxPayException the wx pay exception
+ */
+ String post(String url, String requestStr, boolean useKey, String mimeType) throws WxPayException;
+
/**
* 发送post请求,得到响应字符串.
*
@@ -215,6 +254,13 @@ public interface WxPayService {
*/
WxEntrustPapService getWxEntrustPapService();
+ /**
+ * 获取微信押金支付服务类
+ *
+ * @return deposit service
+ */
+ WxDepositService getWxDepositService();
+
/**
* 获取批量转账到零钱服务类.
*
@@ -316,6 +362,13 @@ public interface WxPayService {
*/
BrandMerchantTransferService getBrandMerchantTransferService();
+ /**
+ * 获取微信支付预约扣费服务类 (连续包月功能)
+ *
+ * @return the subscription billing service
+ */
+ SubscriptionBillingService getSubscriptionBillingService();
+
/**
* 设置企业付款服务类,允许开发者自定义实现类.
*
@@ -640,6 +693,17 @@ public interface WxPayService {
*/
T createPartnerOrderV3(TradeTypeEnum tradeType, WxPayPartnerUnifiedOrderV3Request request) throws WxPayException;
+ /**
+ * 境外微信支付调用统一下单接口,并组装生成支付所需参数对象.
+ *
+ * @param 请使用{@link WxPayUnifiedOrderV3Result}里的内部类或字段
+ * @param tradeType the global trade type
+ * @param request 境外统一下单请求参数
+ * @return 返回 {@link WxPayUnifiedOrderV3Result}里的内部类或字段
+ * @throws WxPayException the wx pay exception
+ */
+ T createOrderV3Global(GlobalTradeTypeEnum tradeType, WxPayUnifiedOrderV3GlobalRequest request) throws WxPayException;
+
/**
* 在发起微信支付前,需要调用统一下单接口,获取"预支付交易会话标识"
*
@@ -660,6 +724,16 @@ public interface WxPayService {
*/
WxPayUnifiedOrderV3Result unifiedOrderV3(TradeTypeEnum tradeType, WxPayUnifiedOrderV3Request request) throws WxPayException;
+ /**
+ * 境外微信支付在发起支付前,需要调用统一下单接口,获取"预支付交易会话标识"
+ *
+ * @param tradeType the global trade type
+ * @param request 境外请求对象,注意一些参数如appid、mchid等不用设置,方法内会自动从配置对象中获取到(前提是对应配置中已经设置)
+ * @return the wx pay unified order result
+ * @throws WxPayException the wx pay exception
+ */
+ WxPayUnifiedOrderV3Result unifiedOrderV3Global(GlobalTradeTypeEnum tradeType, WxPayUnifiedOrderV3GlobalRequest request) throws WxPayException;
+
/**
*
* 合单支付API(APP支付、JSAPI支付、H5支付、NATIVE支付).
@@ -790,6 +864,32 @@ public interface WxPayService {
*/
WxPayRefundV3Result refundV3(WxPayRefundV3Request request) throws WxPayException;
+ /**
+ *
+ * 微信支付-服务商申请退款.
+ * 应用场景
+ * 当交易发生之后一年内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付金额退还给买家,微信支付将在收到退款请求并且验证成功之后,将支付款按原路退还至买家账号上。
+ *
+ * 注意:
+ * 1、交易时间超过一年的订单无法提交退款
+ * 2、微信支付退款支持单笔交易分多次退款(不超50次),多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号
+ * 3、错误或无效请求频率限制:6qps,即每秒钟异常或错误的退款申请请求不超过6次
+ * 4、每个支付订单的部分退款次数不能超过50次
+ * 5、如果同一个用户有多笔退款,建议分不同批次进行退款,避免并发退款导致退款失败
+ * 6、申请退款接口的返回仅代表业务的受理情况,具体退款是否成功,需要通过退款查询接口获取结果
+ * 7、一个月之前的订单申请退款频率限制为:5000/min
+ *
+ * 详见 https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_9.shtml
+ * 接口地址
+ * https://api.mch.weixin.qq.com/v3/refund/domestic/refunds
+ *
+ *
+ * @param request 请求对象
+ * @return 退款操作结果 wx pay refund result
+ * @throws WxPayException the wx pay exception
+ */
+ WxPayRefundV3Result partnerRefundV3(WxPayPartnerRefundV3Request request) throws WxPayException;
+
/**
*
* 微信支付-查询退款.
@@ -1435,6 +1535,7 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
* 是否需要证书: 否
* 请求方式: POST
* 文档地址:https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=23_1
+ * 注意: 微信暂不支持api v3
*
*
* @return the sandbox sign key
@@ -1610,6 +1711,13 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
*/
TransferService getTransferService();
+ /**
+ * 获取运营工具-商家转账服务类
+ *
+ * @return the business operation transfer service
+ */
+ BusinessOperationTransferService getBusinessOperationTransferService();
+
/**
* 获取服务商支付分服务类
*
@@ -1623,4 +1731,19 @@ WxPayRefundQueryResult refundQuery(String transactionId, String outTradeNo, Stri
* @return the partner pay score sign plan service
*/
PartnerPayScoreSignPlanService getPartnerPayScoreSignPlanService();
+
+ /**
+ * 获取实名验证服务类
+ *
+ * @return the real name service
+ */
+ RealNameService getRealNameService();
+
+ /**
+ * 获取医保支付服务类
+ *
+ * @return the merchant transfer service
+ */
+ MiPayService getMiPayService();
+
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
index 0df3530a31..4b51c498d2 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BaseWxPayServiceImpl.java
@@ -1,16 +1,21 @@
package com.github.binarywang.wxpay.service.impl;
-import com.github.binarywang.utils.qrcode.QrcodeUtils;
-import com.github.binarywang.wxpay.bean.WxPayApiData;
+import static com.github.binarywang.wxpay.constant.WxPayConstants.QUERY_COMMENT_DATE_FORMAT;
+import static com.github.binarywang.wxpay.constant.WxPayConstants.TarType;
import com.github.binarywang.wxpay.bean.coupon.*;
import com.github.binarywang.wxpay.bean.notify.*;
+import com.github.binarywang.wxpay.bean.request.*;
+import com.github.binarywang.wxpay.bean.result.*;
+import com.github.binarywang.wxpay.service.*;
+import java.util.*;
+import com.github.binarywang.wxpay.bean.result.enums.GlobalTradeTypeEnum;
+import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
+import com.github.binarywang.utils.qrcode.QrcodeUtils;
+import com.github.binarywang.wxpay.bean.WxPayApiData;
import com.github.binarywang.wxpay.bean.order.WxPayAppOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayMpOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayMwebOrderResult;
import com.github.binarywang.wxpay.bean.order.WxPayNativeOrderResult;
-import com.github.binarywang.wxpay.bean.request.*;
-import com.github.binarywang.wxpay.bean.result.*;
-import com.github.binarywang.wxpay.bean.result.enums.TradeTypeEnum;
import com.github.binarywang.wxpay.bean.transfer.TransferBillsNotifyResult;
import com.github.binarywang.wxpay.config.WxPayConfig;
import com.github.binarywang.wxpay.config.WxPayConfigHolder;
@@ -18,7 +23,6 @@
import com.github.binarywang.wxpay.constant.WxPayConstants.TradeType;
import com.github.binarywang.wxpay.exception.WxPayException;
import com.github.binarywang.wxpay.exception.WxSignTestException;
-import com.github.binarywang.wxpay.service.*;
import com.github.binarywang.wxpay.util.SignUtils;
import com.github.binarywang.wxpay.util.XmlConfig;
import com.github.binarywang.wxpay.util.ZipUtils;
@@ -28,13 +32,6 @@
import com.google.common.collect.Maps;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import lombok.Getter;
-import lombok.Setter;
-import lombok.extern.slf4j.Slf4j;
-import me.chanjar.weixin.common.error.WxRuntimeException;
-import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.reflect.ConstructorUtils;
-
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
@@ -43,12 +40,15 @@
import java.nio.file.Path;
import java.nio.file.Paths;
import java.security.GeneralSecurityException;
-import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.zip.ZipException;
-
-import static com.github.binarywang.wxpay.constant.WxPayConstants.QUERY_COMMENT_DATE_FORMAT;
-import static com.github.binarywang.wxpay.constant.WxPayConstants.TarType;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+import me.chanjar.weixin.common.error.WxRuntimeException;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.reflect.ConstructorUtils;
+import org.apache.http.entity.ContentType;
/**
*
@@ -101,6 +101,9 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final WxEntrustPapService wxEntrustPapService = new WxEntrustPapServiceImpl(this);
+ @Getter
+ private final WxDepositService wxDepositService = new WxDepositServiceImpl(this);
+
@Getter
private final PartnerTransferService partnerTransferService = new PartnerTransferServiceImpl(this);
@@ -128,6 +131,18 @@ public abstract class BaseWxPayServiceImpl implements WxPayService {
@Getter
private final BrandMerchantTransferService brandMerchantTransferService = new BrandMerchantTransferServiceImpl(this);
+ @Getter
+ private final SubscriptionBillingService subscriptionBillingService = new SubscriptionBillingServiceImpl(this);
+
+ @Getter
+ private final BusinessOperationTransferService businessOperationTransferService = new BusinessOperationTransferServiceImpl(this);
+
+ @Getter
+ private final RealNameService realNameService = new RealNameServiceImpl(this);
+
+ @Getter
+ private final MiPayService miPayService = new MiPayServiceImpl(this);
+
protected Map configMap = new ConcurrentHashMap<>();
@Override
@@ -197,6 +212,34 @@ public boolean switchover(String mchId, String appId) {
return false;
}
+ @Override
+ public boolean switchover(String mchId) {
+ // 参数校验
+ if (StringUtils.isBlank(mchId)) {
+ log.error("商户号mchId不能为空");
+ return false;
+ }
+
+ // 先尝试精确匹配(针对只有mchId没有appId的配置)
+ if (this.configMap.containsKey(mchId)) {
+ WxPayConfigHolder.set(mchId);
+ return true;
+ }
+
+ // 尝试前缀匹配(查找以 mchId_ 开头的配置)
+ String prefix = mchId + "_";
+ for (String key : this.configMap.keySet()) {
+ if (key.startsWith(prefix)) {
+ WxPayConfigHolder.set(key);
+ log.debug("根据mchId=【{}】找到配置key=【{}】", mchId, key);
+ return true;
+ }
+ }
+
+ log.error("无法找到对应mchId=【{}】的商户号配置信息,请核实!", mchId);
+ return false;
+ }
+
@Override
public WxPayService switchoverTo(String mchId, String appId) {
String configKey = this.getConfigKey(mchId, appId);
@@ -207,6 +250,32 @@ public WxPayService switchoverTo(String mchId, String appId) {
throw new WxRuntimeException(String.format("无法找到对应mchId=【%s】,appId=【%s】的商户号配置信息,请核实!", mchId, appId));
}
+ @Override
+ public WxPayService switchoverTo(String mchId) {
+ // 参数校验
+ if (StringUtils.isBlank(mchId)) {
+ throw new WxRuntimeException("商户号mchId不能为空");
+ }
+
+ // 先尝试精确匹配(针对只有mchId没有appId的配置)
+ if (this.configMap.containsKey(mchId)) {
+ WxPayConfigHolder.set(mchId);
+ return this;
+ }
+
+ // 尝试前缀匹配(查找以 mchId_ 开头的配置)
+ String prefix = mchId + "_";
+ for (String key : this.configMap.keySet()) {
+ if (key.startsWith(prefix)) {
+ WxPayConfigHolder.set(key);
+ log.debug("根据mchId=【{}】找到配置key=【{}】", mchId, key);
+ return this;
+ }
+ }
+
+ throw new WxRuntimeException(String.format("无法找到对应mchId=【%s】的商户号配置信息,请核实!", mchId));
+ }
+
public String getConfigKey(String mchId, String appId) {
return mchId + "_" + appId;
}
@@ -248,6 +317,22 @@ public WxPayRefundResult refundV2(WxPayRefundRequest request) throws WxPayExcept
@Override
public WxPayRefundV3Result refundV3(WxPayRefundV3Request request) throws WxPayException {
+ if (StringUtils.isBlank(request.getNotifyUrl())) {
+ request.setNotifyUrl(this.getConfig().getRefundNotifyUrl());
+ }
+ String url = String.format("%s/v3/refund/domestic/refunds", this.getPayBaseUrl());
+ String response = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(response, WxPayRefundV3Result.class);
+ }
+
+ @Override
+ public WxPayRefundV3Result partnerRefundV3(WxPayPartnerRefundV3Request request) throws WxPayException {
+ if (StringUtils.isBlank(request.getNotifyUrl())) {
+ request.setNotifyUrl(this.getConfig().getRefundNotifyUrl());
+ }
+ if (StringUtils.isBlank(request.getSubMchid())) {
+ request.setSubMchid(this.getConfig().getSubMchId());
+ }
String url = String.format("%s/v3/refund/domestic/refunds", this.getPayBaseUrl());
String response = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
return GSON.fromJson(response, WxPayRefundV3Result.class);
@@ -319,6 +404,13 @@ public WxPayOrderNotifyResult parseOrderNotifyResult(String xmlData) throws WxPa
public WxPayOrderNotifyResult parseOrderNotifyResult(String xmlData, String signType) throws WxPayException {
try {
log.debug("微信支付异步通知请求参数:{}", xmlData);
+
+ // 检测数据格式并给出适当的处理建议
+ if (xmlData != null && xmlData.trim().startsWith("{")) {
+ throw new WxPayException("检测到V3版本的JSON格式通知数据,请使用parseOrderNotifyV3Result方法解析。" +
+ " V3 API需要传入SignatureHeader参数进行签名验证。");
+ }
+
WxPayOrderNotifyResult result = WxPayOrderNotifyResult.fromXML(xmlData);
if (signType == null) {
this.switchover(result.getMchId(), result.getAppid());
@@ -746,6 +838,14 @@ public T createPartnerOrderV3(TradeTypeEnum tradeType, WxPayPartnerUnifiedOr
return result.getPayInfo(tradeType, appId, request.getSubMchId(), this.getConfig().getPrivateKey());
}
+ @Override
+ public T createOrderV3Global(GlobalTradeTypeEnum tradeType, WxPayUnifiedOrderV3GlobalRequest request) throws WxPayException {
+ WxPayUnifiedOrderV3Result result = this.unifiedOrderV3Global(tradeType, request);
+ // Convert GlobalTradeTypeEnum to TradeTypeEnum for getPayInfo method
+ TradeTypeEnum domesticTradeType = TradeTypeEnum.valueOf(tradeType.name());
+ return result.getPayInfo(domesticTradeType, request.getAppid(), request.getMchid(), this.getConfig().getPrivateKey());
+ }
+
@Override
public WxPayUnifiedOrderV3Result unifiedPartnerOrderV3(TradeTypeEnum tradeType, WxPayPartnerUnifiedOrderV3Request request) throws WxPayException {
if (StringUtils.isBlank(request.getSpAppid())) {
@@ -790,6 +890,28 @@ public WxPayUnifiedOrderV3Result unifiedOrderV3(TradeTypeEnum tradeType, WxPayUn
return GSON.fromJson(response, WxPayUnifiedOrderV3Result.class);
}
+ @Override
+ public WxPayUnifiedOrderV3Result unifiedOrderV3Global(GlobalTradeTypeEnum tradeType, WxPayUnifiedOrderV3GlobalRequest request) throws WxPayException {
+ if (StringUtils.isBlank(request.getAppid())) {
+ request.setAppid(this.getConfig().getAppId());
+ }
+ if (StringUtils.isBlank(request.getMchid())) {
+ request.setMchid(this.getConfig().getMchId());
+ }
+ if (StringUtils.isBlank(request.getNotifyUrl())) {
+ request.setNotifyUrl(this.getConfig().getNotifyUrl());
+ }
+ if (StringUtils.isBlank(request.getTradeType())) {
+ request.setTradeType(tradeType.name());
+ }
+
+ // Use global WeChat Pay base URL for overseas payments
+ String globalBaseUrl = "https://apihk.mch.weixin.qq.com";
+ String url = globalBaseUrl + tradeType.getUrl();
+ String response = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(response, WxPayUnifiedOrderV3Result.class);
+ }
+
@Override
public CombineTransactionsResult combine(TradeTypeEnum tradeType, CombineTransactionsRequest request) throws WxPayException {
if (StringUtils.isBlank(request.getCombineAppid())) {
@@ -1146,15 +1268,40 @@ public WxPayMicropayResult micropay(WxPayMicropayRequest request) throws WxPayEx
@Override
public WxPayCodepayResult codepay(WxPayCodepayRequest request) throws WxPayException {
- if (StringUtils.isBlank(request.getAppid())) {
- request.setAppid(this.getConfig().getAppId());
- }
- if (StringUtils.isBlank(request.getMchid())) {
- request.setMchid(this.getConfig().getMchId());
+ // 判断是否为服务商模式:如果设置了sp_appid或sp_mchid或sub_mchid中的任何一个,则认为是服务商模式
+ boolean isPartnerMode = StringUtils.isNotBlank(request.getSpAppid())
+ || StringUtils.isNotBlank(request.getSpMchid())
+ || StringUtils.isNotBlank(request.getSubMchid());
+
+ if (isPartnerMode) {
+ // 服务商模式
+ if (StringUtils.isBlank(request.getSpAppid())) {
+ request.setSpAppid(this.getConfig().getAppId());
+ }
+ if (StringUtils.isBlank(request.getSpMchid())) {
+ request.setSpMchid(this.getConfig().getMchId());
+ }
+ if (StringUtils.isBlank(request.getSubAppid())) {
+ request.setSubAppid(this.getConfig().getSubAppId());
+ }
+ if (StringUtils.isBlank(request.getSubMchid())) {
+ request.setSubMchid(this.getConfig().getSubMchId());
+ }
+ String url = String.format("%s/v3/pay/partner/transactions/codepay", this.getPayBaseUrl());
+ String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(body, WxPayCodepayResult.class);
+ } else {
+ // 直连商户模式
+ if (StringUtils.isBlank(request.getAppid())) {
+ request.setAppid(this.getConfig().getAppId());
+ }
+ if (StringUtils.isBlank(request.getMchid())) {
+ request.setMchid(this.getConfig().getMchId());
+ }
+ String url = String.format("%s/v3/pay/transactions/codepay", this.getPayBaseUrl());
+ String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(body, WxPayCodepayResult.class);
}
- String url = String.format("%s/v3/pay/transactions/codepay", this.getPayBaseUrl());
- String body = this.postV3WithWechatpaySerial(url, GSON.toJson(request));
- return GSON.fromJson(body, WxPayCodepayResult.class);
}
@Override
@@ -1231,7 +1378,7 @@ public String getSandboxSignKey() throws WxPayException {
request.checkAndSign(this.getConfig());
String url = "https://api.mch.weixin.qq.com/xdc/apiv2getsignkey/sign/getsignkey";
- String responseContent = this.post(url, request.toXML(), false);
+ String responseContent = this.post(url, request.toXML(), false, ContentType.APPLICATION_XML.getMimeType());
WxPaySandboxSignKeyResult result = BaseWxPayResult.fromXML(responseContent, WxPaySandboxSignKeyResult.class);
result.checkResult(this, request.getSignType(), true);
return result.getSandboxSignKey();
@@ -1383,4 +1530,9 @@ public BankService getBankService() {
public TransferService getTransferService() {
return transferService;
}
+
+ @Override
+ public BusinessOperationTransferService getBusinessOperationTransferService() {
+ return businessOperationTransferService;
+ }
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BusinessOperationTransferServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BusinessOperationTransferServiceImpl.java
new file mode 100644
index 0000000000..098db127e3
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/BusinessOperationTransferServiceImpl.java
@@ -0,0 +1,74 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.transfer.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.BusinessOperationTransferService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.v3.util.RsaCryptoUtil;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+
+import java.security.cert.X509Certificate;
+
+/**
+ * 运营工具-商家转账API实现
+ *
+ * @author WxJava Team
+ * @see 运营工具-商家转账API
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class BusinessOperationTransferServiceImpl implements BusinessOperationTransferService {
+
+ private static final Gson GSON = new GsonBuilder().create();
+ private final WxPayService wxPayService;
+
+ @Override
+ public BusinessOperationTransferResult createOperationTransfer(BusinessOperationTransferRequest request) throws WxPayException {
+ // 设置默认appid
+ if (StringUtils.isEmpty(request.getAppid())) {
+ request.setAppid(this.wxPayService.getConfig().getAppId());
+ }
+
+ String url = String.format("%s/v3/fund-app/mch-transfer/transfer-bills", this.wxPayService.getPayBaseUrl());
+
+ // 如果传入了用户姓名,需要进行RSA加密
+ if (StringUtils.isNotEmpty(request.getUserName())) {
+ X509Certificate validCertificate = this.wxPayService.getConfig().getVerifier().getValidCertificate();
+ RsaCryptoUtil.encryptFields(request, validCertificate);
+ }
+
+ String response = wxPayService.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(response, BusinessOperationTransferResult.class);
+ }
+
+ @Override
+ public BusinessOperationTransferQueryResult queryOperationTransfer(BusinessOperationTransferQueryRequest request) throws WxPayException {
+ if (StringUtils.isNotEmpty(request.getOutBillNo())) {
+ return queryOperationTransferByOutBillNo(request.getOutBillNo());
+ } else if (StringUtils.isNotEmpty(request.getTransferBillNo())) {
+ return queryOperationTransferByTransferBillNo(request.getTransferBillNo());
+ } else {
+ throw new WxPayException("商户单号(out_bill_no)和微信转账单号(transfer_bill_no)必须提供其中一个");
+ }
+ }
+
+ @Override
+ public BusinessOperationTransferQueryResult queryOperationTransferByOutBillNo(String outBillNo) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/transfer-bills/out-bill-no/%s",
+ this.wxPayService.getPayBaseUrl(), outBillNo);
+ String response = wxPayService.getV3(url);
+ return GSON.fromJson(response, BusinessOperationTransferQueryResult.class);
+ }
+
+ @Override
+ public BusinessOperationTransferQueryResult queryOperationTransferByTransferBillNo(String transferBillNo) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/transfer-bills/transfer-bill-no/%s",
+ this.wxPayService.getPayBaseUrl(), transferBillNo);
+ String response = wxPayService.getV3(url);
+ return GSON.fromJson(response, BusinessOperationTransferQueryResult.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
index 479520d7f7..171535c992 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/EcommerceServiceImpl.java
@@ -337,6 +337,27 @@ public RefundNotifyResult parseRefundNotifyResult(String notifyData, SignatureHe
}
}
+ @Override
+ public WithdrawNotifyResult parseWithdrawNotifyResult(String notifyData, SignatureHeader header) throws WxPayException {
+ if (Objects.nonNull(header) && !this.verifyNotifySign(header, notifyData)) {
+ throw new WxPayException("非法请求,头部信息验证失败");
+ }
+ NotifyResponse response = GSON.fromJson(notifyData, NotifyResponse.class);
+ NotifyResponse.Resource resource = response.getResource();
+ String cipherText = resource.getCiphertext();
+ String associatedData = resource.getAssociatedData();
+ String nonce = resource.getNonce();
+ String apiV3Key = this.payService.getConfig().getApiV3Key();
+ try {
+ String result = AesUtils.decryptToString(associatedData, nonce, cipherText, apiV3Key);
+ WithdrawNotifyResult notifyResult = GSON.fromJson(result, WithdrawNotifyResult.class);
+ notifyResult.setRawData(response);
+ return notifyResult;
+ } catch (GeneralSecurityException | IOException e) {
+ throw new WxPayException("解析报文异常!", e);
+ }
+ }
+
@Override
public SubWithdrawResult subWithdraw(SubWithdrawRequest request) throws WxPayException {
String url = String.format("%s/v3/ecommerce/fund/withdraw", this.payService.getPayBaseUrl());
@@ -365,6 +386,27 @@ public SpWithdrawStatusResult querySpWithdrawByOutRequestNo(String outRequestNo)
return GSON.fromJson(response, SpWithdrawStatusResult.class);
}
+ @Override
+ public SpWithdrawStatusResult querySpWithdrawByWithdrawId(String withdrawId) throws WxPayException {
+ String url = String.format("%s/v3/merchant/fund/withdraw/withdraw-id/%s", this.payService.getPayBaseUrl(), withdrawId);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SpWithdrawStatusResult.class);
+ }
+
+ @Override
+ public SubDayEndBalanceWithdrawResult subDayEndBalanceWithdraw(SubDayEndBalanceWithdrawRequest request) throws WxPayException {
+ String url = String.format("%s/v3/ecommerce/fund/balance-withdraw", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubDayEndBalanceWithdrawResult.class);
+ }
+
+ @Override
+ public SubDayEndBalanceWithdrawStatusResult querySubDayEndBalanceWithdraw(String subMchid, String outRequestNo) throws WxPayException {
+ String url = String.format("%s/v3/ecommerce/fund/balance-withdraw/out-request-no/%s?sub_mchid=%s", this.payService.getPayBaseUrl(), outRequestNo, subMchid);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubDayEndBalanceWithdrawStatusResult.class);
+ }
+
@Override
public void modifySettlement(String subMchid, SettlementRequest request) throws WxPayException {
String url = String.format("%s/v3/apply4sub/sub_merchants/%s/modify-settlement", this.payService.getPayBaseUrl(), subMchid);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java
new file mode 100644
index 0000000000..769b789fa3
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/MiPayServiceImpl.java
@@ -0,0 +1,68 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersRequest;
+import com.github.binarywang.wxpay.bean.mipay.MedInsOrdersResult;
+import com.github.binarywang.wxpay.bean.mipay.MedInsRefundNotifyRequest;
+import com.github.binarywang.wxpay.bean.notify.MiPayNotifyV3Result;
+import com.github.binarywang.wxpay.bean.notify.SignatureHeader;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.MiPayService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.github.binarywang.wxpay.v3.util.RsaCryptoUtil;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import java.security.cert.X509Certificate;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * 医保相关接口
+ * 医保相关接口
+ * @author xgl
+ * @date 2025/12/20
+ */
+@RequiredArgsConstructor
+public class MiPayServiceImpl implements MiPayService {
+
+ private final WxPayService payService;
+ private static final Gson GSON = new GsonBuilder().create();
+
+
+ @Override
+ public MedInsOrdersResult medInsOrders(MedInsOrdersRequest request) throws WxPayException {
+
+ String url = String.format("%s/v3/med-ins/orders", this.payService.getPayBaseUrl());
+ X509Certificate validCertificate = this.payService.getConfig().getVerifier().getValidCertificate();
+
+ RsaCryptoUtil.encryptFields(request, validCertificate);
+
+ String result = this.payService.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(result, MedInsOrdersResult.class);
+ }
+
+ @Override
+ public MedInsOrdersResult getMedInsOrderByMixTradeNo(String mixTradeNo, String subMchid) throws WxPayException {
+ String url = String.format("%s/v3/med-ins/orders/mix-trade-no/%s?sub_mchid=%s", this.payService.getPayBaseUrl(), mixTradeNo, subMchid);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, MedInsOrdersResult.class);
+ }
+
+ @Override
+ public MedInsOrdersResult getMedInsOrderByOutTradeNo(String outTradeNo, String subMchid) throws WxPayException {
+ String url = String.format("%s/v3/med-ins/orders/out-trade-no/%s?sub_mchid=%s", this.payService.getPayBaseUrl(), outTradeNo, subMchid);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, MedInsOrdersResult.class);
+ }
+
+ @Override
+ public MiPayNotifyV3Result parseMiPayNotifyV3Result(String notifyData, SignatureHeader header) throws WxPayException {
+ return this.payService.baseParseOrderNotifyV3Result(notifyData, header, MiPayNotifyV3Result.class, MiPayNotifyV3Result.DecryptNotifyResult.class);
+ }
+
+ @Override
+ public void medInsRefundNotify(MedInsRefundNotifyRequest request, String mixTradeNo) throws WxPayException {
+ String url = String.format("%s/v3/med-ins/refunds/notify?mix_trade_no=%s", this.payService.getPayBaseUrl(), mixTradeNo);
+ this.payService.postV3(url, GSON.toJson(request));
+ }
+
+
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayScoreServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayScoreServiceImpl.java
index 249cfa3f56..ee92c6611a 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayScoreServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/PayScoreServiceImpl.java
@@ -230,7 +230,7 @@ public WxPayScoreResult modifyServiceOrder(WxPayScoreRequest request) throws WxP
if(Strings.isNullOrEmpty(request.getAppid())){
request.setAppid(config.getAppId());
}
- if(Strings.isNullOrEmpty(config.getServiceId())){
+ if(Strings.isNullOrEmpty(request.getServiceId())){
request.setServiceId(config.getServiceId());
}
request.setOutOrderNo(null);
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/ProfitSharingServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/ProfitSharingServiceImpl.java
index 6be5ffc8c1..afaa45440a 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/ProfitSharingServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/ProfitSharingServiceImpl.java
@@ -7,6 +7,7 @@
import com.github.binarywang.wxpay.bean.profitsharing.result.*;
import com.github.binarywang.wxpay.bean.result.BaseWxPayResult;
import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.exception.WxSignTestException;
import com.github.binarywang.wxpay.service.ProfitSharingService;
import com.github.binarywang.wxpay.service.WxPayService;
import com.github.binarywang.wxpay.v3.auth.Verifier;
@@ -293,7 +294,11 @@ private ProfitSharingNotifyV3Response parseNotifyData(String data, SignatureHead
* @return true:校验通过 false:校验不通过
*/
private boolean verifyNotifySign(SignatureHeader header, String data) throws WxPayException {
- String beforeSign = String.format("%s%n%s%n%s%n", header.getTimeStamp(), header.getNonce(), data);
+ String wxPaySign = header.getSignature();
+ if (wxPaySign.startsWith("WECHATPAY/SIGNTEST/")) {
+ throw new WxSignTestException("微信支付签名探测流量");
+ }
+ String beforeSign = String.format("%s\n%s\n%s\n", header.getTimeStamp(), header.getNonce(), data);
Verifier verifier = this.payService.getConfig().getVerifier();
if (verifier == null) {
throw new WxPayException("证书检验对象为空");
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java
new file mode 100644
index 0000000000..9a1c57fe0f
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/RealNameServiceImpl.java
@@ -0,0 +1,41 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.realname.RealNameRequest;
+import com.github.binarywang.wxpay.bean.realname.RealNameResult;
+import com.github.binarywang.wxpay.bean.result.BaseWxPayResult;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.RealNameService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import lombok.RequiredArgsConstructor;
+
+/**
+ *
+ * 微信支付实名验证相关服务实现类.
+ * 详见文档:https://pay.wechatpay.cn/doc/v2/merchant/4011987607
+ *
+ *
+ * @author Binary Wang
+ */
+@RequiredArgsConstructor
+public class RealNameServiceImpl implements RealNameService {
+ private final WxPayService payService;
+
+ @Override
+ public RealNameResult queryRealName(RealNameRequest request) throws WxPayException {
+ request.checkAndSign(this.payService.getConfig());
+ String url = this.payService.getPayBaseUrl() + "/userinfo/realnameauth/query";
+
+ String responseContent = this.payService.post(url, request.toXML(), true);
+ RealNameResult result = BaseWxPayResult.fromXML(responseContent, RealNameResult.class);
+ result.checkResult(this.payService, request.getSignType(), true);
+ return result;
+ }
+
+ @Override
+ public RealNameResult queryRealName(String openid) throws WxPayException {
+ RealNameRequest request = RealNameRequest.newBuilder()
+ .openid(openid)
+ .build();
+ return this.queryRealName(request);
+ }
+}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java
new file mode 100644
index 0000000000..45c1a9f0d2
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImpl.java
@@ -0,0 +1,91 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.subscriptionbilling.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.SubscriptionBillingService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * 微信支付-预约扣费服务实现 (连续包月功能)
+ *
+ * 微信支付预约扣费功能,支持商户在用户授权的情况下,
+ * 按照约定的时间和金额,自动从用户的支付账户中扣取费用。
+ * 主要用于连续包月、订阅服务等场景。
+ *
+ * 文档详见: https://pay.weixin.qq.com/doc/v3/merchant/4012161105
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-08-31
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class SubscriptionBillingServiceImpl implements SubscriptionBillingService {
+
+ private static final Gson GSON = new GsonBuilder().create();
+ private final WxPayService payService;
+
+ @Override
+ public SubscriptionScheduleResult scheduleSubscription(SubscriptionScheduleRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionScheduleResult.class);
+ }
+
+ @Override
+ public SubscriptionQueryResult querySubscription(String subscriptionId) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule/%s", this.payService.getPayBaseUrl(), subscriptionId);
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubscriptionQueryResult.class);
+ }
+
+ @Override
+ public SubscriptionCancelResult cancelSubscription(SubscriptionCancelRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/schedule/%s/cancel",
+ this.payService.getPayBaseUrl(), request.getSubscriptionId());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionCancelResult.class);
+ }
+
+ @Override
+ public SubscriptionInstantBillingResult instantBilling(SubscriptionInstantBillingRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/instant-billing", this.payService.getPayBaseUrl());
+ String response = this.payService.postV3(url, GSON.toJson(request));
+ return GSON.fromJson(response, SubscriptionInstantBillingResult.class);
+ }
+
+ @Override
+ public SubscriptionTransactionQueryResult queryTransactions(SubscriptionTransactionQueryRequest request) throws WxPayException {
+ String url = String.format("%s/v3/subscription-billing/transactions", this.payService.getPayBaseUrl());
+
+ StringBuilder queryString = new StringBuilder();
+ if (request.getOpenid() != null) {
+ queryString.append("openid=").append(request.getOpenid()).append("&");
+ }
+ if (request.getBeginTime() != null) {
+ queryString.append("begin_time=").append(request.getBeginTime()).append("&");
+ }
+ if (request.getEndTime() != null) {
+ queryString.append("end_time=").append(request.getEndTime()).append("&");
+ }
+ if (request.getLimit() != null) {
+ queryString.append("limit=").append(request.getLimit()).append("&");
+ }
+ if (request.getOffset() != null) {
+ queryString.append("offset=").append(request.getOffset()).append("&");
+ }
+
+ if (queryString.length() > 0) {
+ // Remove trailing &
+ queryString.setLength(queryString.length() - 1);
+ url += "?" + queryString.toString();
+ }
+
+ String response = this.payService.getV3(url);
+ return GSON.fromJson(response, SubscriptionTransactionQueryResult.class);
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
index 038af32b87..fe05ab89ad 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/TransferServiceImpl.java
@@ -124,4 +124,85 @@ public TransferBillsGetResult getBillsByTransferBillNo(String transferBillNo) th
public TransferBillsNotifyResult parseTransferBillsNotifyResult(String notifyData, SignatureHeader header) throws WxPayException {
return this.payService.baseParseOrderNotifyV3Result(notifyData, header, TransferBillsNotifyResult.class, TransferBillsNotifyResult.DecryptNotifyResult.class);
}
+
+ // ===================== 用户授权免确认模式相关接口实现 =====================
+
+ @Override
+ public UserAuthorizationStatusResult getUserAuthorizationStatus(String openid, String transferSceneId) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/authorization/openid/%s?transfer_scene_id=%s",
+ this.payService.getPayBaseUrl(), openid, transferSceneId);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, UserAuthorizationStatusResult.class);
+ }
+
+ @Override
+ public ReservationTransferBatchResult reservationTransferBatch(ReservationTransferBatchRequest request) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/reservation/transfer-batches", this.payService.getPayBaseUrl());
+ List transferDetailList = request.getTransferDetailList();
+ if (transferDetailList != null && !transferDetailList.isEmpty()) {
+ X509Certificate validCertificate = this.payService.getConfig().getVerifier().getValidCertificate();
+ for (ReservationTransferBatchRequest.TransferDetail detail : transferDetailList) {
+ if (detail.getUserName() != null && !detail.getUserName().isEmpty()) {
+ RsaCryptoUtil.encryptFields(detail, validCertificate);
+ }
+ }
+ }
+ String result = this.payService.postV3WithWechatpaySerial(url, GSON.toJson(request));
+ return GSON.fromJson(result, ReservationTransferBatchResult.class);
+ }
+
+ @Override
+ public ReservationTransferBatchGetResult getReservationTransferBatchByOutBatchNo(String outBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException {
+ String url = buildReservationBatchQueryUrl("out-batch-no", outBatchNo, needQueryDetail, offset, limit, detailState);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, ReservationTransferBatchGetResult.class);
+ }
+
+ @Override
+ public ReservationTransferBatchGetResult getReservationTransferBatchByReservationBatchNo(String reservationBatchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) throws WxPayException {
+ String url = buildReservationBatchQueryUrl("reservation-batch-no", reservationBatchNo, needQueryDetail, offset, limit, detailState);
+ String result = this.payService.getV3(url);
+ return GSON.fromJson(result, ReservationTransferBatchGetResult.class);
+ }
+
+ private String buildReservationBatchQueryUrl(String batchNoType, String batchNo, Boolean needQueryDetail,
+ Integer offset, Integer limit, String detailState) {
+ StringBuilder url = new StringBuilder();
+ url.append(this.payService.getPayBaseUrl())
+ .append("/v3/fund-app/mch-transfer/reservation/transfer-batches/")
+ .append(batchNoType).append("/").append(batchNo);
+
+ boolean hasParams = false;
+ if (needQueryDetail != null) {
+ url.append("?need_query_detail=").append(needQueryDetail);
+ hasParams = true;
+ }
+ if (offset != null) {
+ url.append(hasParams ? "&" : "?").append("offset=").append(offset);
+ hasParams = true;
+ }
+ if (limit != null) {
+ url.append(hasParams ? "&" : "?").append("limit=").append(limit);
+ hasParams = true;
+ }
+ if (detailState != null && !detailState.isEmpty()) {
+ url.append(hasParams ? "&" : "?").append("detail_state=").append(detailState);
+ }
+ return url.toString();
+ }
+
+ @Override
+ public ReservationTransferNotifyResult parseReservationTransferNotifyResult(String notifyData, SignatureHeader header) throws WxPayException {
+ return this.payService.baseParseOrderNotifyV3Result(notifyData, header, ReservationTransferNotifyResult.class,
+ ReservationTransferNotifyResult.DecryptNotifyResult.class);
+ }
+
+ @Override
+ public void closeReservationTransferBatch(String outBatchNo) throws WxPayException {
+ String url = String.format("%s/v3/fund-app/mch-transfer/reservation/transfer-batches/out-batch-no/%s/close",
+ this.payService.getPayBaseUrl(), outBatchNo);
+ this.payService.postV3(url, "");
+ }
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java
new file mode 100644
index 0000000000..70bc5a5162
--- /dev/null
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceImpl.java
@@ -0,0 +1,84 @@
+package com.github.binarywang.wxpay.service.impl;
+
+import com.github.binarywang.wxpay.bean.request.*;
+import com.github.binarywang.wxpay.bean.result.*;
+import com.github.binarywang.wxpay.exception.WxPayException;
+import com.github.binarywang.wxpay.service.WxDepositService;
+import com.github.binarywang.wxpay.service.WxPayService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ *
+ * 微信押金支付服务实现
+ *
+ *
+ * @author Binary Wang
+ * created on 2024-09-24
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class WxDepositServiceImpl implements WxDepositService {
+
+ private final WxPayService payService;
+
+ @Override
+ public WxDepositUnifiedOrderResult unifiedOrder(WxDepositUnifiedOrderRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositpay";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositUnifiedOrderResult result = BaseWxPayResult.fromXML(responseContent, WxDepositUnifiedOrderResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositOrderQueryResult queryOrder(WxDepositOrderQueryRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositorderquery";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositOrderQueryResult result = BaseWxPayResult.fromXML(responseContent, WxDepositOrderQueryResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositConsumeResult consume(WxDepositConsumeRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositconsume";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositConsumeResult result = BaseWxPayResult.fromXML(responseContent, WxDepositConsumeResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositUnfreezeResult unfreeze(WxDepositUnfreezeRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositreverse";
+ String responseContent = payService.post(url, request.toXML(), false);
+ WxDepositUnfreezeResult result = BaseWxPayResult.fromXML(responseContent, WxDepositUnfreezeResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+
+ @Override
+ public WxDepositRefundResult refund(WxDepositRefundRequest request) throws WxPayException {
+ request.checkAndSign(payService.getConfig());
+
+ String url = payService.getPayBaseUrl() + "/pay/depositrefund";
+ String responseContent = payService.post(url, request.toXML(), true);
+ WxDepositRefundResult result = BaseWxPayResult.fromXML(responseContent, WxDepositRefundResult.class);
+ result.checkResult(payService, request.getSignType(), true);
+
+ return result;
+ }
+}
\ No newline at end of file
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
index 977a2856fe..96454e5c08 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceApacheHttpImpl.java
@@ -54,7 +54,7 @@ public byte[] postForBytes(String url, String requestStr, boolean useKey) throws
try {
HttpPost httpPost = this.createHttpPost(url, requestStr);
CloseableHttpClient httpClient = this.createHttpClient(useKey);
-
+
// 使用连接池的客户端,不需要手动关闭
final byte[] bytes = httpClient.execute(httpPost, ByteArrayResponseHandler.INSTANCE);
final String responseData = Base64.getEncoder().encodeToString(bytes);
@@ -73,7 +73,33 @@ public String post(String url, String requestStr, boolean useKey) throws WxPayEx
try {
HttpPost httpPost = this.createHttpPost(url, requestStr);
CloseableHttpClient httpClient = this.createHttpClient(useKey);
-
+
+ // 使用连接池的客户端,不需要手动关闭
+ try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
+ String responseString = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
+ this.logRequestAndResponse(url, requestStr, responseString);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, responseString, null));
+ }
+ return responseString;
+ } finally {
+ httpPost.releaseConnection();
+ }
+ } catch (Exception e) {
+ this.logError(url, requestStr, e);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, null, e.getMessage()));
+ }
+ throw new WxPayException(e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public String post(String url, String requestStr, boolean useKey, String mimeType) throws WxPayException {
+ try {
+ HttpPost httpPost = this.createHttpPost(url, requestStr, mimeType);
+ CloseableHttpClient httpClient = this.createHttpClient(useKey);
+
// 使用连接池的客户端,不需要手动关闭
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
String responseString = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
@@ -306,6 +332,10 @@ private static StringEntity createEntry(String requestStr) {
//return new StringEntity(new String(requestStr.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
}
+ private static StringEntity createEntry(String requestStr, String mimeType) {
+ return new StringEntity(requestStr, ContentType.create(mimeType, StandardCharsets.UTF_8));
+ //return new StringEntity(new String(requestStr.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
+ }
private HttpClientBuilder createHttpClientBuilder(boolean useKey) throws WxPayException {
HttpClientBuilder httpClientBuilder = HttpClients.custom();
if (useKey) {
@@ -348,6 +378,19 @@ private HttpPost createHttpPost(String url, String requestStr) {
return httpPost;
}
+ private HttpPost createHttpPost(String url, String requestStr, String mimeType) throws WxPayException {
+ HttpPost httpPost = new HttpPost(url);
+ httpPost.setEntity(createEntry(requestStr, mimeType));
+
+ httpPost.setConfig(RequestConfig.custom()
+ .setConnectionRequestTimeout(this.getConfig().getHttpConnectionTimeout())
+ .setConnectTimeout(this.getConfig().getHttpConnectionTimeout())
+ .setSocketTimeout(this.getConfig().getHttpTimeout())
+ .build());
+
+ return httpPost;
+ }
+
private void initSSLContext(HttpClientBuilder httpClientBuilder) throws WxPayException {
SSLContext sslContext = this.getConfig().getSslContext();
if (null == sslContext) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceHttpComponentsImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceHttpComponentsImpl.java
index 1c558f711b..5c21a06a8e 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceHttpComponentsImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceHttpComponentsImpl.java
@@ -91,6 +91,32 @@ public String post(String url, String requestStr, boolean useKey) throws WxPayEx
}
}
+ @Override
+ public String post(String url, String requestStr, boolean useKey, String mimeType) throws WxPayException {
+ try {
+ HttpClientBuilder httpClientBuilder = this.createHttpClientBuilder(useKey);
+ HttpPost httpPost = this.createHttpPost(url, requestStr, mimeType);
+ try (CloseableHttpClient httpClient = httpClientBuilder.build()) {
+ try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
+ String responseString = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8);
+ this.logRequestAndResponse(url, requestStr, responseString);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, responseString, null));
+ }
+ return responseString;
+ }
+ } finally {
+ httpPost.releaseConnection();
+ }
+ } catch (Exception e) {
+ this.logError(url, requestStr, e);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, null, e.getMessage()));
+ }
+ throw new WxPayException(e.getMessage(), e);
+ }
+ }
+
@Override
public String postV3(String url, String requestStr) throws WxPayException {
HttpPost httpPost = this.createHttpPost(url, requestStr);
@@ -283,6 +309,11 @@ private static StringEntity createEntry(String requestStr) {
//return new StringEntity(new String(requestStr.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
}
+ private static StringEntity createEntry(String requestStr, String mimeType) {
+ return new StringEntity(requestStr, ContentType.create(mimeType, StandardCharsets.UTF_8));
+ //return new StringEntity(new String(requestStr.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
+ }
+
private HttpClientBuilder createHttpClientBuilder(boolean useKey) throws WxPayException {
HttpClientBuilder httpClientBuilder = HttpClients.custom();
if (useKey) {
@@ -325,6 +356,19 @@ private HttpPost createHttpPost(String url, String requestStr) {
return httpPost;
}
+ private HttpPost createHttpPost(String url, String requestStr, String mimeType) throws WxPayException {
+ HttpPost httpPost = new HttpPost(url);
+ httpPost.setEntity(createEntry(requestStr, mimeType));
+
+ httpPost.setConfig(RequestConfig.custom()
+ .setConnectionRequestTimeout(this.getConfig().getHttpConnectionTimeout())
+ .setConnectTimeout(this.getConfig().getHttpConnectionTimeout())
+ .setSocketTimeout(this.getConfig().getHttpTimeout())
+ .build());
+
+ return httpPost;
+ }
+
private void initSSLContext(HttpClientBuilder httpClientBuilder) throws WxPayException {
SSLContext sslContext = this.getConfig().getSslContext();
if (null == sslContext) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceImpl.java
index 8e795966f4..4316bafa40 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceImpl.java
@@ -2,11 +2,11 @@
/**
*
- * 微信支付接口请求实现类,默认使用Apache HttpClient实现
+ * 微信支付接口请求实现类,默认使用Apache HttpClient 5实现
* Created by Binary Wang on 2017-7-8.
*
*
* @author Binary Wang
*/
-public class WxPayServiceImpl extends WxPayServiceApacheHttpImpl {
+public class WxPayServiceImpl extends WxPayServiceHttpComponentsImpl {
}
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceJoddHttpImpl.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceJoddHttpImpl.java
index 7c2f1e82c0..6c8bcec899 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceJoddHttpImpl.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/service/impl/WxPayServiceJoddHttpImpl.java
@@ -63,6 +63,24 @@ public String post(String url, String requestStr, boolean useKey) throws WxPayEx
}
}
+ @Override
+ public String post(String url, String requestStr, boolean useKey, String mimeType) throws WxPayException {
+ try {
+ HttpRequest request = this.buildHttpRequest(url, requestStr, useKey, mimeType);
+ String responseString = this.getResponseString(request.send());
+
+ log.info("\n【请求地址】:{}\n【请求数据】:{}\n【响应数据】:{}", url, requestStr, responseString);
+ if (this.getConfig().isIfSaveApiData()) {
+ wxApiData.set(new WxPayApiData(url, requestStr, responseString, null));
+ }
+ return responseString;
+ } catch (Exception e) {
+ log.error("\n【请求地址】:{}\n【请求数据】:{}\n【异常信息】:{}", url, requestStr, e.getMessage());
+ wxApiData.set(new WxPayApiData(url, requestStr, null, e.getMessage()));
+ throw new WxPayException(e.getMessage(), e);
+ }
+ }
+
@Override
public String postV3(String url, String requestStr) throws WxPayException {
return null;
@@ -146,6 +164,40 @@ private HttpRequest buildHttpRequest(String url, String requestStr, boolean useK
return request;
}
+ private HttpRequest buildHttpRequest(String url, String requestStr, boolean useKey, String mimeType) throws WxPayException {
+ HttpRequest request = HttpRequest
+ .post(url)
+ .contentType(mimeType)
+ .timeout(this.getConfig().getHttpTimeout())
+ .connectionTimeout(this.getConfig().getHttpConnectionTimeout())
+ .bodyText(requestStr);
+
+ if (useKey) {
+ SSLContext sslContext = this.getConfig().getSslContext();
+ if (null == sslContext) {
+ sslContext = this.getConfig().initSSLContext();
+ }
+ final SSLSocketHttpConnectionProvider provider = new SSLSocketHttpConnectionProvider(sslContext);
+ request.withConnectionProvider(provider);
+ }
+
+ if (StringUtils.isNotBlank(this.getConfig().getHttpProxyHost()) && this.getConfig().getHttpProxyPort() > 0) {
+ if (StringUtils.isEmpty(this.getConfig().getHttpProxyUsername())) {
+ this.getConfig().setHttpProxyUsername("whatever");
+ }
+
+ ProxyInfo httpProxy = new ProxyInfo(ProxyType.HTTP, this.getConfig().getHttpProxyHost(), this.getConfig().getHttpProxyPort(),
+ this.getConfig().getHttpProxyUsername(), this.getConfig().getHttpProxyPassword());
+ HttpConnectionProvider provider = request.connectionProvider();
+ if (null == provider) {
+ provider = new SocketHttpConnectionProvider();
+ }
+ provider.useProxy(httpProxy);
+ request.withConnectionProvider(provider);
+ }
+ return request;
+ }
+
private String getResponseString(HttpResponse response) throws WxPayException {
try {
log.debug("【微信服务器响应头信息】:\n{}", response.toString(false));
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
index b641cbe537..c4ad966415 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/RequestUtils.java
@@ -17,7 +17,7 @@ public class RequestUtils {
/**
* 获取请求头数据,微信V3版本回调使用
*
- * @param request
+ * @param request HTTP请求对象
* @return 字符串
*/
public static String readData(HttpServletRequest request) {
diff --git a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
index ac68b00bb4..51dd8fbbb6 100644
--- a/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
+++ b/weixin-java-pay/src/main/java/com/github/binarywang/wxpay/util/ResourcesUtils.java
@@ -23,6 +23,10 @@ public class ResourcesUtils {
* - {@link Class#getClassLoader() ClassLoaderUtil.class.getClassLoader()}
* - if
callingClass is provided: {@link Class#getClassLoader() callingClass.getClassLoader()}
* + * 问题背景:当微信返回的 XML 包含某些未在 WxPayOrderNotifyResult 中定义的字段时, + * 这些字段会被微信服务器用于签名计算。如果 toMap() 方法丢失了这些字段, + * 则签名验证会失败,抛出 "参数格式校验错误!" 异常。 + *
+ *+ * 解决方案:修改 WxPayOrderNotifyResult.toMap() 方法,使用父类的 toMap() 方法 + * 直接从原始 XML 解析所有字段,而不是使用 SignUtils.xmlBean2Map(this)。 + *
+ * + * @see Issue #3750 + */ +public class WxPayOrderNotifyUnknownFieldTest { + + private static final String MCH_KEY = "testmchkey1234567890123456789012"; + private static final List+ * WxPayUnifiedOrderV3Result 测试类 + * 主要测试prepayId字段和静态工厂方法的解耦功能 + *+ * + * @author copilot + */ +public class WxPayUnifiedOrderV3ResultTest { + + /** + * 生成测试用的RSA密钥对 + */ + private KeyPair generateKeyPair() throws Exception { + KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("RSA"); + keyPairGenerator.initialize(2048); + return keyPairGenerator.generateKeyPair(); + } + + /** + * 测试JsapiResult中的prepayId字段是否正确设置 + */ + @Test + public void testJsapiResultWithPrepayId() throws Exception { + // 准备测试数据 + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + // 创建WxPayUnifiedOrderV3Result对象 + WxPayUnifiedOrderV3Result result = new WxPayUnifiedOrderV3Result(); + result.setPrepayId(testPrepayId); + + // 调用getPayInfo生成JsapiResult + WxPayUnifiedOrderV3Result.JsapiResult jsapiResult = + result.getPayInfo(TradeTypeEnum.JSAPI, testAppId, null, privateKey); + + // 验证prepayId字段是否正确设置 + Assert.assertNotNull(jsapiResult.getPrepayId(), "prepayId不应为null"); + Assert.assertEquals(jsapiResult.getPrepayId(), testPrepayId, "prepayId应该与设置的值相同"); + + // 验证其他字段 + Assert.assertEquals(jsapiResult.getAppId(), testAppId); + Assert.assertNotNull(jsapiResult.getTimeStamp()); + Assert.assertNotNull(jsapiResult.getNonceStr()); + Assert.assertEquals(jsapiResult.getPackageValue(), "prepay_id=" + testPrepayId); + Assert.assertEquals(jsapiResult.getSignType(), "RSA"); + Assert.assertNotNull(jsapiResult.getPaySign()); + } + + /** + * 测试使用静态工厂方法生成JsapiResult(解耦场景) + */ + @Test + public void testGetJsapiPayInfoStaticMethod() throws Exception { + // 准备测试数据 + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + // 使用静态工厂方法生成JsapiResult + WxPayUnifiedOrderV3Result.JsapiResult jsapiResult = + WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey); + + // 验证prepayId字段 + Assert.assertNotNull(jsapiResult.getPrepayId(), "prepayId不应为null"); + Assert.assertEquals(jsapiResult.getPrepayId(), testPrepayId, "prepayId应该与输入的值相同"); + + // 验证其他字段 + Assert.assertEquals(jsapiResult.getAppId(), testAppId); + Assert.assertNotNull(jsapiResult.getTimeStamp()); + Assert.assertNotNull(jsapiResult.getNonceStr()); + Assert.assertEquals(jsapiResult.getPackageValue(), "prepay_id=" + testPrepayId); + Assert.assertEquals(jsapiResult.getSignType(), "RSA"); + Assert.assertNotNull(jsapiResult.getPaySign()); + } + + /** + * 测试使用静态工厂方法生成AppResult(解耦场景) + */ + @Test + public void testGetAppPayInfoStaticMethod() throws Exception { + // 准备测试数据 + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + String testMchId = "1900000109"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + // 使用静态工厂方法生成AppResult + WxPayUnifiedOrderV3Result.AppResult appResult = + WxPayUnifiedOrderV3Result.getAppPayInfo(testPrepayId, testAppId, testMchId, privateKey); + + // 验证prepayId字段 + Assert.assertNotNull(appResult.getPrepayId(), "prepayId不应为null"); + Assert.assertEquals(appResult.getPrepayId(), testPrepayId, "prepayId应该与输入的值相同"); + + // 验证其他字段 + Assert.assertEquals(appResult.getAppid(), testAppId); + Assert.assertEquals(appResult.getPartnerId(), testMchId); + Assert.assertNotNull(appResult.getTimestamp()); + Assert.assertNotNull(appResult.getNoncestr()); + Assert.assertEquals(appResult.getPackageValue(), "Sign=WXPay"); + Assert.assertNotNull(appResult.getSign()); + } + + /** + * 测试解耦场景:先获取prepayId,后续再生成支付信息 + */ + @Test + public void testDecoupledScenario() throws Exception { + // 模拟场景:先创建订单获取prepayId + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + // 步骤1:模拟从创建订单接口获取prepayId + WxPayUnifiedOrderV3Result orderResult = new WxPayUnifiedOrderV3Result(); + orderResult.setPrepayId(testPrepayId); + + // 获取prepayId用于存储 + String storedPrepayId = orderResult.getPrepayId(); + Assert.assertEquals(storedPrepayId, testPrepayId); + + // 步骤2:后续支付失败时,使用存储的prepayId重新生成支付信息 + WxPayUnifiedOrderV3Result.JsapiResult newPayInfo = + WxPayUnifiedOrderV3Result.getJsapiPayInfo(storedPrepayId, testAppId, privateKey); + + // 验证重新生成的支付信息 + Assert.assertEquals(newPayInfo.getPrepayId(), storedPrepayId); + Assert.assertEquals(newPayInfo.getPackageValue(), "prepay_id=" + storedPrepayId); + Assert.assertNotNull(newPayInfo.getPaySign()); + } + + /** + * 测试多次生成支付信息,签名应该不同(因为timestamp和nonceStr每次都不同) + */ + @Test + public void testMultipleGenerationsHaveDifferentSignatures() throws Exception { + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + // 生成第一次支付信息 + WxPayUnifiedOrderV3Result.JsapiResult result1 = + WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey); + + // 等待一秒确保timestamp不同 + Thread.sleep(1000); + + // 生成第二次支付信息 + WxPayUnifiedOrderV3Result.JsapiResult result2 = + WxPayUnifiedOrderV3Result.getJsapiPayInfo(testPrepayId, testAppId, privateKey); + + // prepayId应该相同 + Assert.assertEquals(result1.getPrepayId(), result2.getPrepayId()); + + // 但是timestamp、nonceStr和签名应该不同 + Assert.assertNotEquals(result1.getTimeStamp(), result2.getTimeStamp(), "timestamp应该不同"); + Assert.assertNotEquals(result1.getNonceStr(), result2.getNonceStr(), "nonceStr应该不同"); + Assert.assertNotEquals(result1.getPaySign(), result2.getPaySign(), "签名应该不同"); + } + + /** + * 测试AppResult中的prepayId字段 + */ + @Test + public void testAppResultWithPrepayId() throws Exception { + String testPrepayId = "wx201410272009395522657a690389285100"; + String testAppId = "wx8888888888888888"; + String testMchId = "1900000109"; + KeyPair keyPair = generateKeyPair(); + PrivateKey privateKey = keyPair.getPrivate(); + + WxPayUnifiedOrderV3Result result = new WxPayUnifiedOrderV3Result(); + result.setPrepayId(testPrepayId); + + // 调用getPayInfo生成AppResult + WxPayUnifiedOrderV3Result.AppResult appResult = + result.getPayInfo(TradeTypeEnum.APP, testAppId, testMchId, privateKey); + + // 验证prepayId字段 + Assert.assertNotNull(appResult.getPrepayId(), "prepayId不应为null"); + Assert.assertEquals(appResult.getPrepayId(), testPrepayId, "prepayId应该与设置的值相同"); + } + + /** + * 测试getJsapiPayInfo方法的空值验证 + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空") + public void testGetJsapiPayInfoWithNullPrepayId() { + WxPayUnifiedOrderV3Result.getJsapiPayInfo(null, "appId", null); + } + + /** + * 测试getJsapiPayInfo方法的空值验证 - appId为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空") + public void testGetJsapiPayInfoWithNullAppId() throws Exception { + KeyPair keyPair = generateKeyPair(); + WxPayUnifiedOrderV3Result.getJsapiPayInfo("prepayId", null, keyPair.getPrivate()); + } + + /** + * 测试getJsapiPayInfo方法的空值验证 - privateKey为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId 和 privateKey 不能为空") + public void testGetJsapiPayInfoWithNullPrivateKey() { + WxPayUnifiedOrderV3Result.getJsapiPayInfo("prepayId", "appId", null); + } + + /** + * 测试getAppPayInfo方法的空值验证 - prepayId为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空") + public void testGetAppPayInfoWithNullPrepayId() { + WxPayUnifiedOrderV3Result.getAppPayInfo(null, "appId", "mchId", null); + } + + /** + * 测试getAppPayInfo方法的空值验证 - appId为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空") + public void testGetAppPayInfoWithNullAppId() throws Exception { + KeyPair keyPair = generateKeyPair(); + WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", null, "mchId", keyPair.getPrivate()); + } + + /** + * 测试getAppPayInfo方法的空值验证 - mchId为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空") + public void testGetAppPayInfoWithNullMchId() throws Exception { + KeyPair keyPair = generateKeyPair(); + WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", "appId", null, keyPair.getPrivate()); + } + + /** + * 测试getAppPayInfo方法的空值验证 - privateKey为null + */ + @Test(expectedExceptions = IllegalArgumentException.class, + expectedExceptionsMessageRegExp = "prepayId, appId, mchId 和 privateKey 不能为空") + public void testGetAppPayInfoWithNullPrivateKey() { + WxPayUnifiedOrderV3Result.getAppPayInfo("prepayId", "appId", "mchId", null); + } +} diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResultTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResultTest.java new file mode 100644 index 0000000000..52df2b6e2b --- /dev/null +++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/bean/result/WxSignQueryResultTest.java @@ -0,0 +1,125 @@ +package com.github.binarywang.wxpay.bean.result; + +import com.github.binarywang.wxpay.util.XmlConfig; +import org.testng.Assert; +import org.testng.annotations.Test; + +/** + * WxSignQueryResult 单元测试 + * + * @author Binary Wang + */ +public class WxSignQueryResultTest { + + /** + * 测试 XML 解析,特别是 contract_expired_time 字段 + */ + @Test + public void testFromXML() { + /* + * xml样例字符串来自于官方文档 + * https://pay.weixin.qq.com/doc/v2/merchant/4011987640 + */ + String xmlString = "
+ * 实名验证测试类. + *+ * + * @author Binary Wang + */ +@Test +@Guice(modules = ApiTestModule.class) +@Slf4j +public class RealNameServiceImplTest { + + @Inject + private WxPayService payService; + + /** + * 测试查询用户实名认证信息. + * + * @throws WxPayException the wx pay exception + */ + @Test + public void testQueryRealName() throws WxPayException { + RealNameRequest request = RealNameRequest.newBuilder() + .openid("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o") + .build(); + + RealNameResult result = this.payService.getRealNameService().queryRealName(request); + log.info("实名认证查询结果:{}", result); + } + + /** + * 测试查询用户实名认证信息(简化方法). + * + * @throws WxPayException the wx pay exception + */ + @Test + public void testQueryRealNameSimple() throws WxPayException { + RealNameResult result = this.payService.getRealNameService() + .queryRealName("oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"); + log.info("实名认证查询结果:{}", result); + } +} diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java new file mode 100644 index 0000000000..21143a47d1 --- /dev/null +++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/SubscriptionBillingServiceImplTest.java @@ -0,0 +1,144 @@ +package com.github.binarywang.wxpay.service.impl; + +import com.github.binarywang.wxpay.bean.subscriptionbilling.*; +import com.github.binarywang.wxpay.service.SubscriptionBillingService; +import com.github.binarywang.wxpay.service.WxPayService; +import com.github.binarywang.wxpay.testbase.ApiTestModule; +import com.google.inject.Inject; +import org.testng.annotations.Guice; +import org.testng.annotations.Test; + +/** + * 微信支付预约扣费服务测试类 + *
+ * 注意:由于预约扣费功能需要用户授权和实际的签约关系, + * 这些测试主要用于验证接口调用的正确性,而不是功能的完整性。 + * 实际测试需要在具有有效签约关系的环境中进行。 + *
+ * + * @author Binary Wang + */ +@Test(enabled = false) // 默认关闭,需要实际环境配置才能测试 +@Guice(modules = ApiTestModule.class) +public class SubscriptionBillingServiceImplTest { + + @Inject + private WxPayService wxPayService; + + @Test + public void testScheduleSubscription() { + try { + SubscriptionBillingService service = this.wxPayService.getSubscriptionBillingService(); + + SubscriptionScheduleRequest request = new SubscriptionScheduleRequest(); + request.setOutTradeNo("test_subscription_" + System.currentTimeMillis()); + request.setOpenid("test_openid"); + request.setDescription("测试预约扣费"); + request.setScheduleTime("2024-09-01T10:00:00+08:00"); + + SubscriptionAmount amount = new SubscriptionAmount(); + amount.setTotal(100); // 1元,单位分 + amount.setCurrency("CNY"); + request.setAmount(amount); + + BillingPlan billingPlan = new BillingPlan(); + billingPlan.setPlanType("MONTHLY"); + billingPlan.setPeriod(1); + billingPlan.setTotalCount(12); + request.setBillingPlan(billingPlan); + + SubscriptionScheduleResult result = service.scheduleSubscription(request); + + System.out.println("预约扣费结果:" + result.toString()); + assert result.getSubscriptionId() != null; + assert "SCHEDULED".equals(result.getStatus()); + + } catch (Exception e) { + // 预期会因为测试环境没有有效的签约关系而失败 + System.out.println("预约扣费测试异常(预期):" + e.getMessage()); + } + } + + @Test + public void testQuerySubscription() { + try { + SubscriptionBillingService service = this.wxPayService.getSubscriptionBillingService(); + SubscriptionQueryResult result = service.querySubscription("test_subscription_id"); + + System.out.println("查询预约扣费结果:" + result.toString()); + + } catch (Exception e) { + // 预期会因为测试数据不存在而失败 + System.out.println("查询预约扣费测试异常(预期):" + e.getMessage()); + } + } + + @Test + public void testCancelSubscription() { + try { + SubscriptionBillingService service = this.wxPayService.getSubscriptionBillingService(); + + SubscriptionCancelRequest request = new SubscriptionCancelRequest(); + request.setSubscriptionId("test_subscription_id"); + request.setCancelReason("测试取消"); + + SubscriptionCancelResult result = service.cancelSubscription(request); + + System.out.println("取消预约扣费结果:" + result.toString()); + assert "CANCELLED".equals(result.getStatus()); + + } catch (Exception e) { + // 预期会因为测试数据不存在而失败 + System.out.println("取消预约扣费测试异常(预期):" + e.getMessage()); + } + } + + @Test + public void testInstantBilling() { + try { + SubscriptionBillingService service = this.wxPayService.getSubscriptionBillingService(); + + SubscriptionInstantBillingRequest request = new SubscriptionInstantBillingRequest(); + request.setOutTradeNo("test_instant_" + System.currentTimeMillis()); + request.setOpenid("test_openid"); + request.setDescription("测试立即扣费"); + + SubscriptionAmount amount = new SubscriptionAmount(); + amount.setTotal(100); // 1元,单位分 + amount.setCurrency("CNY"); + request.setAmount(amount); + + SubscriptionInstantBillingResult result = service.instantBilling(request); + + System.out.println("立即扣费结果:" + result.toString()); + assert result.getTransactionId() != null; + + } catch (Exception e) { + // 预期会因为测试环境没有有效的签约关系而失败 + System.out.println("立即扣费测试异常(预期):" + e.getMessage()); + } + } + + @Test + public void testQueryTransactions() { + try { + SubscriptionBillingService service = this.wxPayService.getSubscriptionBillingService(); + + SubscriptionTransactionQueryRequest request = new SubscriptionTransactionQueryRequest(); + request.setOpenid("test_openid"); + request.setBeginTime("2024-08-01T00:00:00+08:00"); + request.setEndTime("2024-08-31T23:59:59+08:00"); + request.setLimit(20); + request.setOffset(0); + + SubscriptionTransactionQueryResult result = service.queryTransactions(request); + + System.out.println("查询扣费记录结果:" + result.toString()); + assert result.getTotalCount() != null; + + } catch (Exception e) { + // 预期会因为测试环境数据问题而失败 + System.out.println("查询扣费记录测试异常(预期):" + e.getMessage()); + } + } +} \ No newline at end of file diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java new file mode 100644 index 0000000000..1bbf347211 --- /dev/null +++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/service/impl/WxDepositServiceTest.java @@ -0,0 +1,135 @@ +package com.github.binarywang.wxpay.service.impl; + +import com.github.binarywang.wxpay.bean.request.*; +import com.github.binarywang.wxpay.bean.result.*; +import com.github.binarywang.wxpay.exception.WxPayException; +import com.github.binarywang.wxpay.service.WxPayService; +import com.github.binarywang.wxpay.testbase.ApiTestModule; +import com.google.inject.Inject; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testng.annotations.Guice; +import org.testng.annotations.Test; + +/** + *+ * 微信押金支付测试 + *+ * + * @author Binary Wang + * created on 2024-09-24 + */ +@Test +@Guice(modules = ApiTestModule.class) +public class WxDepositServiceTest { + + private final Logger logger = LoggerFactory.getLogger(this.getClass()); + + @Inject + private WxPayService payService; + + /** + * 测试押金下单 + */ + @Test + public void testUnifiedOrder() throws WxPayException { + WxDepositUnifiedOrderRequest request = WxDepositUnifiedOrderRequest.newBuilder() + .body("共享单车押金") + .outTradeNo("D" + System.currentTimeMillis()) + .totalFee(99) + .spbillCreateIp("192.168.1.1") + .notifyUrl("https://example.com/wxpay/notify") + .tradeType("JSAPI") + .openid("test_openid_123") + .build(); + + try { + WxDepositUnifiedOrderResult result = this.payService.getWxDepositService().unifiedOrder(request); + logger.info("押金下单结果: {}", result); + } catch (WxPayException e) { + logger.error("押金下单失败", e); + // For demo purposes, just log the error - tests need proper WeChat credentials to run + } + } + + /** + * 测试查询押金订单 + */ + @Test + public void testQueryOrder() throws WxPayException { + WxDepositOrderQueryRequest request = WxDepositOrderQueryRequest.newBuilder() + .outTradeNo("D1695559200000") + .build(); + + try { + WxDepositOrderQueryResult result = this.payService.getWxDepositService().queryOrder(request); + logger.info("押金订单查询结果: {}", result); + } catch (WxPayException e) { + logger.error("押金订单查询失败", e); + // For demo purposes, just log the error - tests need proper WeChat credentials to run + } + } + + /** + * 测试押金消费 + */ + @Test + public void testConsume() throws WxPayException { + WxDepositConsumeRequest request = WxDepositConsumeRequest.newBuilder() + .transactionId("1217752501201407033233368018") + .outTradeNo("C" + System.currentTimeMillis()) + .consumeFee(10) + .consumeDesc("单车使用费") + .build(); + + try { + WxDepositConsumeResult result = this.payService.getWxDepositService().consume(request); + logger.info("押金消费结果: {}", result); + } catch (WxPayException e) { + logger.error("押金消费失败", e); + // For demo purposes, just log the error - tests need proper WeChat credentials to run + } + } + + /** + * 测试押金撤销 + */ + @Test + public void testUnfreeze() throws WxPayException { + WxDepositUnfreezeRequest request = WxDepositUnfreezeRequest.newBuilder() + .transactionId("1217752501201407033233368018") + .outTradeNo("U" + System.currentTimeMillis()) + .unfreezeFee(99) + .unfreezeDesc("用户主动取消") + .build(); + + try { + WxDepositUnfreezeResult result = this.payService.getWxDepositService().unfreeze(request); + logger.info("押金撤销结果: {}", result); + } catch (WxPayException e) { + logger.error("押金撤销失败", e); + // For demo purposes, just log the error - tests need proper WeChat credentials to run + } + } + + /** + * 测试押金退款 + */ + @Test + public void testRefund() throws WxPayException { + WxDepositRefundRequest request = WxDepositRefundRequest.newBuilder() + .transactionId("1217752501201407033233368018") + .outRefundNo("R" + System.currentTimeMillis()) + .refundFee(50) + .refundDesc("部分退款") + .build(); + + try { + WxDepositRefundResult result = this.payService.getWxDepositService().refund(request); + logger.info("押金退款结果: {}", result); + } catch (WxPayException e) { + logger.error("押金退款失败", e); + // For demo purposes, just log the error - tests need proper WeChat credentials to run + } + } +} \ No newline at end of file diff --git a/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/v3/util/RsaCryptoUtilTest.java b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/v3/util/RsaCryptoUtilTest.java new file mode 100644 index 0000000000..18f46c687f --- /dev/null +++ b/weixin-java-pay/src/test/java/com/github/binarywang/wxpay/v3/util/RsaCryptoUtilTest.java @@ -0,0 +1,179 @@ +package com.github.binarywang.wxpay.v3.util; + +import com.github.binarywang.wxpay.bean.profitsharing.request.ProfitSharingReceiverV3Request; +import com.github.binarywang.wxpay.bean.profitsharing.request.ProfitSharingV3Request; +import com.github.binarywang.wxpay.exception.WxPayException; +import com.github.binarywang.wxpay.v3.SpecEncrypt; +import com.google.gson.annotations.SerializedName; +import lombok.Data; +import org.testng.annotations.Test; + +import java.lang.reflect.Field; +import java.util.ArrayList; +import java.util.List; + +import static org.testng.Assert.*; + +/** + * RsaCryptoUtil 测试类 + */ +public class RsaCryptoUtilTest { + + /** + * 测试反射能否找到嵌套类中的 @SpecEncrypt 注解字段 + */ + @Test + public void testFindAnnotatedFieldsInNestedClass() { + // 创建 Receiver 对象 + ProfitSharingV3Request.Receiver receiver = new ProfitSharingV3Request.Receiver(); + receiver.setName("测试姓名"); + + // 使用反射查找带有 @SpecEncrypt 注解的字段 + Class> receiverClass = receiver.getClass(); + Field[] fields = receiverClass.getDeclaredFields(); + + boolean foundNameField = false; + boolean nameFieldHasAnnotation = false; + + for (Field field : fields) { + if (field.getName().equals("name")) { + foundNameField = true; + if (field.isAnnotationPresent(SpecEncrypt.class)) { + nameFieldHasAnnotation = true; + } + } + } + + // 验证能够找到 name 字段并且它有 @SpecEncrypt 注解 + assertTrue(foundNameField, "应该能找到 name 字段"); + assertTrue(nameFieldHasAnnotation, "name 字段应该有 @SpecEncrypt 注解"); + } + + /** + * 测试嵌套对象中的字段加密 + * 验证 List
- * 默认接口实现类,使用apache httpclient实现 + * 默认接口实现类,使用apache httpClient 5实现 * Created by Binary Wang on 2017-5-27. ** * @author Binary Wang */ -public class WxQidianServiceImpl extends WxQidianServiceHttpClientImpl { +public class WxQidianServiceImpl extends WxQidianServiceHttpComponentsImpl { } diff --git a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceOkHttpImpl.java b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceOkHttpImpl.java index 5ff6734ccb..8c2d69896e 100644 --- a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceOkHttpImpl.java +++ b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/api/impl/WxQidianServiceOkHttpImpl.java @@ -80,11 +80,11 @@ public void initHttp() { clientBuilder.proxy(getRequestHttpProxy().getProxy()); // 设置授权 - clientBuilder.authenticator(new Authenticator() { + clientBuilder.proxyAuthenticator(new Authenticator() { @Override public Request authenticate(Route route, Response response) throws IOException { String credential = Credentials.basic(httpProxy.getProxyUsername(), httpProxy.getProxyPassword()); - return response.request().newBuilder().header("Authorization", credential).build(); + return response.request().newBuilder().header("Proxy-Authorization", credential).build(); } }); httpClient = clientBuilder.build(); diff --git a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/util/json/WxQidianGsonBuilder.java b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/util/json/WxQidianGsonBuilder.java index bdce6bbedd..2e38b20220 100644 --- a/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/util/json/WxQidianGsonBuilder.java +++ b/weixin-java-qidian/src/main/java/me/chanjar/weixin/qidian/util/json/WxQidianGsonBuilder.java @@ -1,7 +1,12 @@ package me.chanjar.weixin.qidian.util.json; +import com.google.gson.ExclusionStrategy; +import com.google.gson.FieldAttributes; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import me.chanjar.weixin.common.util.http.apache.ApacheHttpClientBuilder; + +import java.io.File; /** * @author someone @@ -12,6 +17,18 @@ public class WxQidianGsonBuilder { static { INSTANCE.disableHtmlEscaping(); + + INSTANCE.setExclusionStrategies(new ExclusionStrategy() { + @Override + public boolean shouldSkipField(FieldAttributes fieldAttributes) { + return false; + } + + @Override + public boolean shouldSkipClass(Class> aClass) { + return aClass == File.class || aClass == ApacheHttpClientBuilder.class; + } + }); } public static Gson create() {