Visitar URL original
:new: #2742【企业微信】 家校沟通-增加批量更新家长接口支持 · binarywang/WxJava@d166c27 · GitHub
Skip to content

Commit d166c27

Browse files
0katekate00katekate0
authored
🆕 #2742【企业微信】 家校沟通-增加批量更新家长接口支持
1 parent c68f2d2 commit d166c27

11 files changed

Lines changed: 480 additions & 1 deletion

File tree

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpOAuth2Service.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
* OAuth2相关管理接口.
1010
* Created by BinaryWang on 2017/6/24.
1111
* </pre>
12+
* <p>
13+
* 文档1：https://developer.work.weixin.qq.com/document/path/91856
1214
*
1315
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1416
*/
@@ -84,6 +86,19 @@ public interface WxCpOAuth2Service {
8486
*/
8587
WxCpOauth2UserInfo getUserInfo(Integer agentId, String code) throws WxErrorException;
8688

89+
/**
90+
* 获取家校访问用户身份
91+
* 该接口用于根据code获取家长或者学生信息
92+
* <p>
93+
* 请求方式：GET（HTTPS）
94+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
95+
*
96+
* @param code
97+
* @return
98+
* @throws WxErrorException
99+
*/
100+
WxCpOauth2UserInfo getSchoolUserInfo(String code) throws WxErrorException;
101+
87102
/**
88103
* <pre>
89104
* 使用user_ticket获取成员详情.

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpSchoolUserService.java‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import lombok.NonNull;
44
import me.chanjar.weixin.common.error.WxErrorException;
55
import me.chanjar.weixin.cp.bean.WxCpBaseResp;
6+
import me.chanjar.weixin.cp.bean.WxCpOauth2UserInfo;
67
import me.chanjar.weixin.cp.bean.school.user.*;
78

89
import java.util.List;
@@ -16,6 +17,32 @@
1617
*/
1718
public interface WxCpSchoolUserService {
1819

20+
/**
21+
* 获取访问用户身份
22+
* 该接口用于根据code获取成员信息
23+
* <p>
24+
* 请求方式：GET（HTTPS）
25+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
26+
*
27+
* @param code
28+
* @return
29+
* @throws WxErrorException
30+
*/
31+
WxCpOauth2UserInfo getUserInfo(@NonNull String code) throws WxErrorException;
32+
33+
/**
34+
* 获取家校访问用户身份
35+
* 该接口用于根据code获取家长或者学生信息
36+
* <p>
37+
* 请求方式：GET（HTTPS）
38+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
39+
*
40+
* @param code
41+
* @return
42+
* @throws WxErrorException
43+
*/
44+
WxCpOauth2UserInfo getSchoolUserInfo(@NonNull String code) throws WxErrorException;
45+
1946
/**
2047
* 创建学生
2148
* 请求方式：POST（HTTPS）
@@ -98,6 +125,39 @@ public interface WxCpSchoolUserService {
98125
*/
99126
WxCpBaseResp createParent(@NonNull WxCpCreateParentRequest request) throws WxErrorException;
100127

128+
/**
129+
* 批量创建家长
130+
* 请求方式：POST（HTTPS）
131+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_create_parent?access_token=ACCESS_TOKEN
132+
*
133+
* @param request
134+
* @return
135+
* @throws WxErrorException
136+
*/
137+
WxCpBatchResultList batchCreateParent(@NonNull WxCpBatchCreateParentRequest request) throws WxErrorException;
138+
139+
/**
140+
* 批量删除家长
141+
* 请求方式：POST（HTTPS）
142+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_delete_parent?access_token=ACCESS_TOKEN
143+
*
144+
* @param userIdList
145+
* @return
146+
* @throws WxErrorException
147+
*/
148+
WxCpBatchResultList batchDeleteParent(@NonNull String... userIdList) throws WxErrorException;
149+
150+
/**
151+
* 批量更新家长
152+
* 请求方式：POST（HTTPS）
153+
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/batch_update_parent?access_token=ACCESS_TOKEN
154+
*
155+
* @param request
156+
* @return
157+
* @throws WxErrorException
158+
*/
159+
WxCpBatchResultList batchUpdateParent(@NonNull WxCpBatchUpdateParentRequest request) throws WxErrorException;
160+
101161
/**
102162
* 更新家长
103163
* 请求方式：POST（HTTPS）

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpOAuth2ServiceImpl.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,20 @@ public WxCpOauth2UserInfo getUserInfo(Integer agentId, String code) throws WxErr
7777
.userTicket(GsonHelper.getString(jo, "user_ticket"))
7878
.expiresIn(GsonHelper.getString(jo, "expires_in"))
7979
.externalUserId(GsonHelper.getString(jo, "external_userid"))
80+
.parentUserId(GsonHelper.getString(jo, "parent_userid"))
81+
.studentUserId(GsonHelper.getString(jo, "student_userid"))
82+
.build();
83+
}
84+
85+
@Override
86+
public WxCpOauth2UserInfo getSchoolUserInfo(String code) throws WxErrorException {
87+
String responseText = this.mainService.get(String.format(this.mainService.getWxCpConfigStorage().getApiUrl(GET_SCHOOL_USER_INFO), code), null);
88+
JsonObject jo = GsonParser.parse(responseText);
89+
90+
return WxCpOauth2UserInfo.builder()
91+
.deviceId(GsonHelper.getString(jo, "DeviceId"))
92+
.parentUserId(GsonHelper.getString(jo, "parent_userid"))
93+
.studentUserId(GsonHelper.getString(jo, "student_userid"))
8094
.build();
8195
}
8296

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import me.chanjar.weixin.cp.api.WxCpSchoolUserService;
1212
import me.chanjar.weixin.cp.api.WxCpService;
1313
import me.chanjar.weixin.cp.bean.WxCpBaseResp;
14+
import me.chanjar.weixin.cp.bean.WxCpOauth2UserInfo;
1415
import me.chanjar.weixin.cp.bean.school.user.*;
1516
import org.apache.commons.lang3.StringUtils;
1617

@@ -32,6 +33,16 @@ public class WxCpSchoolUserServiceImpl implements WxCpSchoolUserService {
3233

3334
private final WxCpService cpService;
3435

36+
@Override
37+
public WxCpOauth2UserInfo getUserInfo(@NonNull String code) throws WxErrorException {
38+
return cpService.getOauth2Service().getUserInfo(code);
39+
}
40+
41+
@Override
42+
public WxCpOauth2UserInfo getSchoolUserInfo(@NonNull String code) throws WxErrorException {
43+
return cpService.getOauth2Service().getSchoolUserInfo(code);
44+
}
45+
3546
@Override
3647
public WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List<Integer> departments) throws WxErrorException {
3748
String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(CREATE_STUDENT);
@@ -104,6 +115,33 @@ public WxCpBaseResp createParent(@NonNull WxCpCreateParentRequest request) throw
104115
return WxCpBaseResp.fromJson(responseContent);
105116
}
106117

118+
@Override
119+
public WxCpBatchResultList batchCreateParent(@NonNull WxCpBatchCreateParentRequest request) throws WxErrorException {
120+
String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(BATCH_CREATE_PARENT);
121+
String responseContent = this.cpService.post(apiUrl, request.toJson());
122+
return WxCpBatchResultList.fromJson(responseContent);
123+
}
124+
125+
@Override
126+
public WxCpBatchResultList batchDeleteParent(@NonNull String... userIdList) throws WxErrorException {
127+
String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(BATCH_DELETE_PARENT);
128+
JsonObject jsonObject = new JsonObject();
129+
JsonArray jsonArray = new JsonArray();
130+
for (String userId : userIdList) {
131+
jsonArray.add(new JsonPrimitive(userId));
132+
}
133+
jsonObject.add("useridlist", jsonArray);
134+
String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
135+
return WxCpBatchResultList.fromJson(responseContent);
136+
}
137+
138+
@Override
139+
public WxCpBatchResultList batchUpdateParent(@NonNull WxCpBatchUpdateParentRequest request) throws WxErrorException {
140+
String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(BATCH_UPDATE_PARENT);
141+
String responseContent = this.cpService.post(apiUrl, request.toJson());
142+
return WxCpBatchResultList.fromJson(responseContent);
143+
}
144+
107145
@Override
108146
public WxCpBaseResp updateParent(@NonNull WxCpUpdateParentRequest request) throws WxErrorException {
109147
String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(UPDATE_PARENT);

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpOauth2UserInfo.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
* Created by BinaryWang on 2019/5/26.
1515
* </pre>
1616
*
17+
* 文档1：https://developer.work.weixin.qq.com/document/path/91707
18+
*
1719
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1820
*/
1921
@Data
@@ -30,4 +32,7 @@ public class WxCpOauth2UserInfo implements Serializable {
3032
private String userTicket;
3133
private String expiresIn;
3234
private String externalUserId;
35+
private String parentUserId;
36+
private String studentUserId;
37+
3338
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpBatchCreateParentRequest.java‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
package me.chanjar.weixin.cp.bean.school.user;
2+
3+
import com.google.gson.annotations.SerializedName;
4+
import lombok.*;
5+
import lombok.experimental.Accessors;
6+
import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
7+
8+
import java.io.Serializable;
9+
import java.util.List;
10+
11+
/**
12+
* 批量创建家长.
13+
*
14+
* @author Wang_Wong
15+
* @date 2022-07-11
16+
*/
17+
@Data
18+
@Builder
19+
@NoArgsConstructor
20+
@AllArgsConstructor
21+
@Accessors(chain = true)
22+
public class WxCpBatchCreateParentRequest implements Serializable {
23+
private static final long serialVersionUID = -4960239393895754138L;
24+
25+
@SerializedName("parents")
26+
private List<Parent> parents;
27+
28+
@Setter
29+
@Getter
30+
@Builder
31+
@NoArgsConstructor
32+
@AllArgsConstructor
33+
public static class Parent implements Serializable {
34+
35+
@SerializedName("parent_userid")
36+
private String parentUserId;
37+
38+
@SerializedName("mobile")
39+
private String mobile;
40+
41+
@SerializedName("to_invite")
42+
private Boolean toInvite;
43+
44+
@SerializedName("children")
45+
private List<Children> children;
46+
47+
public static Parent fromJson(String json) {
48+
return WxCpGsonBuilder.create().fromJson(json, Parent.class);
49+
}
50+
51+
public String toJson() {
52+
return WxCpGsonBuilder.create().toJson(this);
53+
}
54+
55+
}
56+
57+
@Setter
58+
@Getter
59+
@Builder
60+
@NoArgsConstructor
61+
@AllArgsConstructor
62+
public static class Children implements Serializable {
63+
64+
@SerializedName("student_userid")
65+
private String studentUserId;
66+
67+
@SerializedName("relation")
68+
private String relation;
69+
70+
public static Children fromJson(String json) {
71+
return WxCpGsonBuilder.create().fromJson(json, Children.class);
72+
}
73+
74+
public String toJson() {
75+
return WxCpGsonBuilder.create().toJson(this);
76+
}
77+
78+
}
79+
80+
public static WxCpBatchCreateParentRequest fromJson(String json) {
81+
return WxCpGsonBuilder.create().fromJson(json, WxCpBatchCreateParentRequest.class);
82+
}
83+
84+
public String toJson() {
85+
return WxCpGsonBuilder.create().toJson(this);
86+
}
87+
88+
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpBatchUpdateParentRequest.java‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
package me.chanjar.weixin.cp.bean.school.user;
2+
3+
import com.google.gson.annotations.SerializedName;
4+
import lombok.*;
5+
import lombok.experimental.Accessors;
6+
import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
7+
8+
import java.io.Serializable;
9+
import java.util.List;
10+
11+
/**
12+
* 批量更新家长.
13+
*
14+
* @author Wang_Wong
15+
* @date 2022-07-11
16+
*/
17+
@Data
18+
@Builder
19+
@NoArgsConstructor
20+
@AllArgsConstructor
21+
@Accessors(chain = true)
22+
public class WxCpBatchUpdateParentRequest implements Serializable {
23+
private static final long serialVersionUID = -4960239393895754138L;
24+
25+
@SerializedName("parents")
26+
private List<Parent> parents;
27+
28+
@Setter
29+
@Getter
30+
@Builder
31+
@NoArgsConstructor
32+
@AllArgsConstructor
33+
public static class Parent implements Serializable {
34+
35+
@SerializedName("parent_userid")
36+
private String parentUserId;
37+
38+
@SerializedName("new_parent_userid")
39+
private String newParentUserId;
40+
41+
@SerializedName("mobile")
42+
private String mobile;
43+
44+
@SerializedName("children")
45+
private List<Children> children;
46+
47+
public static Parent fromJson(String json) {
48+
return WxCpGsonBuilder.create().fromJson(json, Parent.class);
49+
}
50+
51+
public String toJson() {
52+
return WxCpGsonBuilder.create().toJson(this);
53+
}
54+
55+
}
56+
57+
@Setter
58+
@Getter
59+
@Builder
60+
@NoArgsConstructor
61+
@AllArgsConstructor
62+
public static class Children implements Serializable {
63+
64+
@SerializedName("student_userid")
65+
private String studentUserId;
66+
67+
@SerializedName("relation")
68+
private String relation;
69+
70+
public static Children fromJson(String json) {
71+
return WxCpGsonBuilder.create().fromJson(json, Children.class);
72+
}
73+
74+
public String toJson() {
75+
return WxCpGsonBuilder.create().toJson(this);
76+
}
77+
78+
}
79+
80+
public static WxCpBatchUpdateParentRequest fromJson(String json) {
81+
return WxCpGsonBuilder.create().fromJson(json, WxCpBatchUpdateParentRequest.class);
82+
}
83+
84+
public String toJson() {
85+
return WxCpGsonBuilder.create().toJson(this);
86+
}
87+
88+
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpCreateParentRequest.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ public class WxCpCreateParentRequest implements Serializable {
3636

3737
@Setter
3838
@Getter
39+
@Builder
40+
@NoArgsConstructor
41+
@AllArgsConstructor
3942
public static class Children implements Serializable {
4043

4144
@SerializedName("student_userid")

0 commit comments

Comments
 (0)