Skip to content

HR助手getEmployeeFieldInfo，getAll参数问题，没有此参数，请求报错错误代码：40058, 错误信息：不合法的参数；传递参数不符合系统要求，需要参照具体API接口说明，微信原始报文：{"errcode":40058,"errmsg":"invalid Request Parameter #3925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
softboy99 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

HR助手getEmployeeFieldInfo，getAll参数问题，没有此参数，请求报错错误代码：40058, 错误信息：不合法的参数；传递参数不符合系统要求，需要参照具体API接口说明，微信原始报文：{"errcode":40058,"errmsg":"invalid Request Parameter #3925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5567348
Merge pull request #1 from binarywang/develop
softboy99 Mar 11, 2026
4ddad91
修正 getEmployeeFieldInfo getAll参数问题，没有此参数时，报错误代码：40058, 错误信息：不合法的参数；传递…
Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpHrService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,28 @@ public interface WxCpHrService {
* 需要配置人事助手的secret，调用接口前需给对应成员赋予人事小助手应用的权限。
*
* @param userid 员工userid
* @param fields 指定字段key列表，不填则返回全部字段
* @param fields 指定字段key列表
* @return 员工档案数据响应 wx cp hr employee field data resp
* @throws WxErrorException the wx error exception
*/
WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, List<String> fields) throws WxErrorException;
Comment on lines 40 to 45
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

该接口原注释曾表明 fields 可不填以返回全部字段；并且测试用例也以 fields=null 调用。这里把 fields 描述改成必填会造成文档与实际/既有用法不一致。建议在 Javadoc 中明确 fields 为空时的行为（例如：不填则返回全部字段）。

Copilot uses AI. Check for mistakes.

/**
* 获取员工档案数据.
* <p>
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/hr/get_staff_info?access_token=ACCESS_TOKEN
* 权限说明：
* 需要配置人事助手的secret，调用接口前需给对应成员赋予人事小助手应用的权限。
*
* @param userid 员工userid
* @param getAll 是否获取全部字段
* @param fields 指定字段key列表
* @return 员工档案数据响应 wx cp hr employee field data resp
* @throws WxErrorException the wx error exception
*/
WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, boolean getAll, List<String> fields) throws WxErrorException;
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

在公共 interface 中新增抽象方法会对外部自定义实现（例如业务方 mock / 代理实现 WxCpHrService）造成源/二进制兼容性破坏，需要他们同步实现新方法。若只是为了提供新重载，建议考虑使用 default 方法（Java 8+）在接口内提供默认实现，或通过新增请求对象/在实现类中扩展来避免破坏兼容性。

Suggested change
WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, boolean getAll, List<String> fields) throws WxErrorException;
default WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, boolean getAll,
List<String> fields) throws WxErrorException {
// 为了保持接口的向后兼容性，默认实现忽略 getAll 参数，仅透传 fields。
// 需要根据 getAll 返回全部字段的实现类可以自行覆盖该方法。
return this.getEmployeeFieldInfo(userid, fields);
}

Copilot uses AI. Check for mistakes.
Copy link

@augmentcode augmentcode bot Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a new abstract method to the public WxCpHrService interface is a source/binary breaking change for any external custom implementations. Please double-check this is acceptable for the project’s compatibility guarantees.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


/**
Comment on lines +48 to 63
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里新增的 getAll 参数会让调用方以为该接口支持一个名为 get_all 的请求参数；但当前接口历史行为/注释是通过「不传 fields」来返回全部字段。若微信接口并不存在该参数（会触发 40058），建议不要把它暴露为公共 API，而是保留 fields 为空即取全量的调用方式。

Suggested change
* 获取员工档案数据.
* <p>
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/hr/get_staff_info?access_token=ACCESS_TOKEN
* 权限说明：
* 需要配置人事助手的secret，调用接口前需给对应成员赋予人事小助手应用的权限。
*
* @param userid 员工userid
* @param getAll 是否获取全部字段
* @param fields 指定字段key列表
* @return 员工档案数据响应 wx cp hr employee field data resp
* @throws WxErrorException the wx error exception
*/
WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, boolean getAll, List<String> fields) throws WxErrorException;
/**

Copilot uses AI. Check for mistakes.
* 更新员工档案数据.
* <p>
Expand Down
9 changes: 9 additions & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpHrServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,22 @@ public WxCpHrEmployeeFieldInfoResp getFieldInfo(List<String> fields) throws WxEr

@Override
public WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, List<String> fields) throws WxErrorException {
return getEmployeeFieldInfo(userid,false,fields);
}
Comment on lines 42 to +44
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里的格式与本文件其余部分不一致（逗号后缺少空格）。建议按既有风格调整为在逗号后留空格，避免 checkstyle/可读性问题。

Copilot uses AI. Check for mistakes.

@Override
public WxCpHrEmployeeFieldDataResp getEmployeeFieldInfo(String userid, boolean getAll, List<String> fields) throws WxErrorException {
if (userid == null || userid.trim().isEmpty()) {
throw new IllegalArgumentException("userid 不能为空");
}
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("userid", userid);
jsonObject.addProperty("get_all", getAll);
if (fields != null && !fields.isEmpty()) {
Comment on lines 52 to 54
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里无条件向请求体写入了 get_all 字段（即使为 false 也会发送）。从该接口的既有用法/测试（WxCpHrServiceImplTest#testGetEmployeeFieldInfo 传 fields=null）以及 PR 描述来看，接口并不支持该参数，发送后会触发 40058「invalid Request Parameter」。建议不要在请求体中包含 get_all，需要“获取全部字段”时直接省略 fields 字段即可。

Copilot uses AI. Check for mistakes.
jsonObject.add("fields", WxCpGsonBuilder.create().toJsonTree(fields));
}else{
if(!getAll)
throw new IllegalArgumentException("fields 不能为空");
Comment on lines +56 to +58
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

当前逻辑在 fields 为空且 getAll 为 false 时直接抛出异常，这会改变该方法原有语义：测试用例 WxCpHrServiceImplTest#testGetEmployeeFieldInfo 依赖 fields=null 来获取全部字段。若接口本身支持不传 fields 返回全部字段，应允许 fields 为空并且不抛异常（仅在确实需要限制时才校验）。

Suggested change
}else{
if(!getAll)
throw new IllegalArgumentException("fields 不能为空");

Copilot uses AI. Check for mistakes.
Comment on lines +56 to +58
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里的 }else{ / if(!getAll) 缺少空格且 if 未使用花括号，风格与周围代码不一致，也容易被 checkstyle 拦截。建议补齐空格并为条件分支加上 {}。

Suggested change
}else{
if(!getAll)
throw new IllegalArgumentException("fields 不能为空");
} else {
if (!getAll) {
throw new IllegalArgumentException("fields 不能为空");
}

Copilot uses AI. Check for mistakes.
Copy link

@augmentcode augmentcode bot Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this validation, existing calls like getEmployeeFieldInfo(userid, null) will now throw IllegalArgumentException (and it also breaks WxCpHrServiceImplTest.testGetEmployeeFieldInfo). If the intent is to keep supporting “get all fields” when fields is omitted, this behavioral change likely needs to be revisited.

Severity: medium

Other Locations
  • weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpHrServiceImpl.java:43

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

}
String response = this.cpService.post(
this.cpService.getWxCpConfigStorage().getApiUrl(GET_EMPLOYEE_FIELD_INFO),
Expand Down