From 3b439113acf14c7e739df1914c7497844018d459 Mon Sep 17 00:00:00 2001 From: Binary Wang Date: Sun, 8 Nov 2020 15:12:52 +0800 Subject: [PATCH] =?UTF-8?q?:art:=20#1857=20=E3=80=90=E4=BC=81=E4=B8=9A?= =?UTF-8?q?=E5=BE=AE=E4=BF=A1=E3=80=91=E8=8E=B7=E5=8F=96=E8=8E=B7=E5=8F=96?= =?UTF-8?q?=E9=83=A8=E9=97=A8=E6=88=90=E5=91=98=E8=AF=A6=E6=83=85=E6=8E=A5?= =?UTF-8?q?=E5=8F=A3=E8=BF=94=E5=9B=9E=E5=80=BC=E5=A2=9E=E5=8A=A0=E7=AC=AC?= =?UTF-8?q?=E4=B8=89=E6=96=B9=E5=BA=94=E7=94=A8=E4=B8=93=E6=9C=89=E7=9A=84?= =?UTF-8?q?open=5Fuserid=E5=AD=97=E6=AE=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../weixin/cp/api/WxCpUserService.java | 28 ++++++++++++++----- .../me/chanjar/weixin/cp/bean/WxCpUser.java | 4 +++ .../cp/util/json/WxCpUserGsonAdapter.java | 1 + 3 files changed, 26 insertions(+), 7 deletions(-) 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 c8b2aae67..4804dbc81 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 @@ -25,19 +25,24 @@ public interface WxCpUserService { * * * @param userId 用户id + * @throws WxErrorException the wx error exception */ void authenticate(String userId) throws WxErrorException; /** * 
-   * 获取部门成员(详情).
+   * 获取部门成员详情
+   * 请求方式：GET（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD
    *
-   * http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E8.8E.B7.E5.8F.96.E9.83.A8.E9.97.A8.E6.88.90.E5.91.98.28.E8.AF.A6.E6.83.85.29
+   * 文档地址：https://work.weixin.qq.com/api/doc/90000/90135/90201
    *
* * @param departId 必填。部门id * @param fetchChild 非必填。1/0：是否递归获取子部门下面的成员 * @param status 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加 + * @return the list + * @throws WxErrorException the wx error exception */ List listByDepartment(Long departId, Boolean fetchChild, Integer status) throws WxErrorException; @@ -51,6 +56,8 @@ public interface WxCpUserService { * @param departId 必填。部门id * @param fetchChild 非必填。1/0：是否递归获取子部门下面的成员 * @param status 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加 + * @return the list + * @throws WxErrorException the wx error exception */ List listSimpleByDepartment(Long departId, Boolean fetchChild, Integer status) throws WxErrorException; @@ -58,6 +65,7 @@ public interface WxCpUserService { * 新建用户. * * @param user 用户对象 + * @throws WxErrorException the wx error exception */ void create(WxCpUser user) throws WxErrorException; @@ -65,6 +73,7 @@ public interface WxCpUserService { * 更新用户. * * @param user 用户对象 + * @throws WxErrorException the wx error exception */ void update(WxCpUser user) throws WxErrorException; @@ -75,6 +84,7 @@ public interface WxCpUserService { * * * @param userIds 员工UserID列表。对应管理端的帐号 + * @throws WxErrorException the wx error exception */ void delete(String... userIds) throws WxErrorException; @@ -82,6 +92,8 @@ public interface WxCpUserService { * 获取用户. * * @param userid 用户id + * @return the by id + * @throws WxErrorException the wx error exception */ WxCpUser getById(String userid) throws WxErrorException; @@ -97,6 +109,8 @@ public interface WxCpUserService { * @param userIds 成员ID列表, 最多支持1000个。 * @param partyIds 部门ID列表，最多支持100个。 * @param tagIds 标签ID列表，最多支持100个。 + * @return the wx cp invite result + * @throws WxErrorException the wx error exception */ WxCpInviteResult invite(List userIds, List partyIds, List tagIds) throws WxErrorException; @@ -114,9 +128,8 @@ public interface WxCpUserService { * * @param userId 企业内的成员id * @param agentId 非必填，整型，仅用于发红包。其它场景该参数不要填，如微信支付、企业转账、电子发票 - * @return map对象，可能包含以下值： - * - openid 企业微信成员userid对应的openid，若有传参agentid，则是针对该agentid的openid。否则是针对企业微信corpid的openid - * - appid 应用的appid，若请求包中不包含agentid则不返回appid。该appid在使用微信红包时会用到 + * @return map对象 ，可能包含以下值： - openid 企业微信成员userid对应的openid，若有传参agentid，则是针对该agentid的openid。否则是针对企业微信corpid的openid - appid 应用的appid，若请求包中不包含agentid则不返回appid。该appid在使用微信红包时会用到 + * @throws WxErrorException the wx error exception */ Map userId2Openid(String userId, Integer agentId) throws WxErrorException; @@ -134,6 +147,7 @@ public interface WxCpUserService { * * @param openid 在使用微信支付、微信红包和企业转账之后，返回结果的openid * @return userid 该openid在企业微信对应的成员userid + * @throws WxErrorException the wx error exception */ String openid2UserId(String openid) throws WxErrorException; @@ -149,7 +163,7 @@ public interface WxCpUserService { * * * @param mobile 手机号码。长度为5~32个字节 - * @return userid mobile对应的成员userid + * @return userid mobile对应的成员userid * @throws WxErrorException . */ String getUserId(String mobile) throws WxErrorException; @@ -164,7 +178,7 @@ public interface WxCpUserService { * * * @param userId 外部联系人的userid - * @return 联系人详情 + * @return 联系人详情 external contact * @throws WxErrorException . */ WxCpExternalContactInfo getExternalContact(String userId) throws WxErrorException; diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java index 221f49aa8..a0ecac268 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpUser.java @@ -33,6 +33,10 @@ public class WxCpUser implements Serializable { private String avatar; private String thumbAvatar; private String mainDepartment; + /** + * 全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取 + */ + private String openUserId; /** * 地址。长度最大128个字符 diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/util/json/WxCpUserGsonAdapter.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/util/json/WxCpUserGsonAdapter.java index 835f89cc5..7df4cd78f 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/util/json/WxCpUserGsonAdapter.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/util/json/WxCpUserGsonAdapter.java @@ -86,6 +86,7 @@ public class WxCpUserGsonAdapter implements JsonDeserializer, JsonSeri user.setTelephone(GsonHelper.getString(o, "telephone")); user.setQrCode(GsonHelper.getString(o, "qr_code")); user.setToInvite(GsonHelper.getBoolean(o, "to_invite")); + user.setOpenUserId(GsonHelper.getString(o, "open_userid")); user.setMainDepartment(GsonHelper.getString(o, "main_department")); if (GsonHelper.isNotNull(o.get(EXTRA_ATTR))) {