🆕 #2707【企业微信】家校沟通-增加学生与家长部分接口

binarywang · Jun 21, 2022 · 867f8e4 · 867f8e4
1 parent 2ed1a5f
commit 867f8e4
Show file tree

Hide file tree

Showing 8 changed files with 493 additions and 0 deletions.
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
@@ -0,0 +1,104 @@
+package me.chanjar.weixin.cp.api;
+
+import lombok.NonNull;
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.bean.school.user.WxCpCreateParentRequest;
+import me.chanjar.weixin.cp.bean.school.user.WxCpUpdateParentRequest;
+
+import java.util.List;
+
+/**
+ * 企业微信家校沟通相关接口.
+ * https://developer.work.weixin.qq.com/document/path/91638
+ *
+ * @author <a href="https://github.com/0katekate0">Wang_Wong</a>
+ * @date: 2022/6/18 9:10
+ */
+public interface WxCpSchoolUserService {
+
+  /**
+   * 创建学生
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?access_token=ACCESS_TOKEN
+   *
+   * @param studentUserId
+   * @param name
+   * @param departments
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List<Integer> departments) throws WxErrorException;
+
+  /**
+   * 删除学生
+   * 请求方式：GET（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
+   *
+   * @param studentUserId
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp deleteStudent(@NonNull String studentUserId) throws WxErrorException;
+
+  /**
+   * 更新学生
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?access_token=ACCESS_TOKEN
+   *
+   * @param studentUserId
+   * @param newStudentUserId
+   * @param name
+   * @param departments
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List<Integer> departments) throws WxErrorException;
+
+  /**
+   * 创建家长
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?access_token=ACCESS_TOKEN
+   *
+   * @param request
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp createParent(@NonNull WxCpCreateParentRequest request) throws WxErrorException;
+
+  /**
+   * 更新家长
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?access_token=ACCESS_TOKEN
+   *
+   * @param request
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp updateParent(@NonNull WxCpUpdateParentRequest request) throws WxErrorException;
+
+  /**
+   * 删除家长
+   * 请求方式：GET（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
+   *
+   * @param userId
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp deleteParent(@NonNull String userId) throws WxErrorException;
+
+  /**
+   * 设置家校通讯录自动同步模式
+   * 企业和第三方可通过此接口修改家校通讯录与班级标签之间的自动同步模式，注意，一旦设置禁止自动同步，将无法再次开启。
+   * <p>
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/set_arch_sync_mode?access_token=ACCESS_TOKEN
+   *
+   * @param archSyncMode 家校通讯录同步模式：1-禁止将标签同步至家校通讯录，2-禁止将家校通讯录同步至标签，3-禁止家校通讯录和标签相互同步
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpBaseResp setArchSyncMode(@NonNull Integer archSyncMode) throws WxErrorException;
+
+}
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
@@ -407,6 +407,13 @@ public interface WxCpService extends WxService {
    */
   WxCpSchoolService getSchoolService();
 
+  /**
+   * 获取家校沟通相关接口的服务类对象
+   *
+   * @return
+   */
+  WxCpSchoolUserService getSchoolUserService();
+
   /**
    * 获取家校应用健康上报的服务类对象
    *

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
@@ -50,6 +50,7 @@ public abstract class BaseWxCpServiceImpl<H, P> implements WxCpService, RequestH
   private WxCpAgentService agentService = new WxCpAgentServiceImpl(this);
   private WxCpOaService oaService = new WxCpOaServiceImpl(this);
   private WxCpSchoolService schoolService = new WxCpSchoolServiceImpl(this);
+  private WxCpSchoolUserService schoolUserService = new WxCpSchoolUserServiceImpl(this);
   private WxCpSchoolHealthService schoolHealthService = new WxCpSchoolHealthServiceImpl(this);
   private WxCpLivingService livingService = new WxCpLivingServiceImpl(this);
   private WxCpOaAgentService oaAgentService = new WxCpOaAgentServiceImpl(this);
@@ -500,6 +501,11 @@ public WxCpSchoolService getSchoolService() {
     return schoolService;
   }
 
+  @Override
+  public WxCpSchoolUserService getSchoolUserService() {
+    return schoolUserService;
+  }
+
   @Override
   public WxCpSchoolHealthService getSchoolHealthService() {
     return schoolHealthService;

diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolUserServiceImpl.java
@@ -0,0 +1,108 @@
+package me.chanjar.weixin.cp.api.impl;
+
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonPrimitive;
+import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.cp.api.WxCpSchoolUserService;
+import me.chanjar.weixin.cp.api.WxCpService;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.bean.school.user.WxCpCreateParentRequest;
+import me.chanjar.weixin.cp.bean.school.user.WxCpUpdateParentRequest;
+import org.apache.commons.lang3.StringUtils;
+
+import java.util.List;
+
+import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.School.*;
+
+/**
+ * 企业微信家校沟通相关接口.
+ * https://developer.work.weixin.qq.com/document/path/91638
+ *
+ * @author <a href="https://github.com/0katekate0">Wang_Wong</a>
+ * @date: 2022/6/18 9:10
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class WxCpSchoolUserServiceImpl implements WxCpSchoolUserService {
+
+  private final WxCpService cpService;
+
+  @Override
+  public WxCpBaseResp createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List<Integer> departments) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(CREATE_STUDENT);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("student_userid", studentUserId);
+    jsonObject.addProperty("name", name);
+    JsonArray jsonArray = new JsonArray();
+    for (Integer depart : departments) {
+      jsonArray.add(new JsonPrimitive(depart));
+    }
+    jsonObject.add("department", jsonArray);
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp deleteStudent(@NonNull String studentUserId) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(DELETE_STUDENT) + studentUserId;
+    String responseContent = this.cpService.get(apiUrl, null);
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List<Integer> departments) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(UPDATE_STUDENT);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("student_userid", studentUserId);
+    if (StringUtils.isNotEmpty(newStudentUserId)) {
+      jsonObject.addProperty("new_student_userid", newStudentUserId);
+    }
+    if (StringUtils.isNotEmpty(name)) {
+      jsonObject.addProperty("name", name);
+    }
+    if (departments != null && departments.size() > 0) {
+      JsonArray jsonArray = new JsonArray();
+      for (Integer depart : departments) {
+        jsonArray.add(new JsonPrimitive(depart));
+      }
+      jsonObject.add("department", jsonArray);
+    }
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp createParent(@NonNull WxCpCreateParentRequest request) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(CREATE_PARENT);
+    String responseContent = this.cpService.post(apiUrl, request.toJson());
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp updateParent(@NonNull WxCpUpdateParentRequest request) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(UPDATE_PARENT);
+    String responseContent = this.cpService.post(apiUrl, request.toJson());
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp deleteParent(@NonNull String userId) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(DELETE_PARENT) + userId;
+    String responseContent = this.cpService.get(apiUrl, null);
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpBaseResp setArchSyncMode(@NonNull Integer archSyncMode) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(SET_ARCH_SYNC_MODE);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("arch_sync_mode", archSyncMode);
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpBaseResp.fromJson(responseContent);
+  }
+
+}
diff --git a/...-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpCreateParentRequest.java b/...-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpCreateParentRequest.java
@@ -0,0 +1,65 @@
+package me.chanjar.weixin.cp.bean.school.user;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.*;
+import lombok.experimental.Accessors;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 创建家长请求.
+ *
+ * @author Wang_Wong
+ * @date 2022-06-20
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class WxCpCreateParentRequest implements Serializable {
+  private static final long serialVersionUID = -4960239393895754138L;
+
+  @SerializedName("parent_userid")
+  private String parentUserId;
+
+  @SerializedName("mobile")
+  private String mobile;
+
+  @SerializedName("to_invite")
+  private Boolean toInvite;
+
+  @SerializedName("children")
+  private List<Children> children;
+
+  @Setter
+  @Getter
+  public static class Children implements Serializable {
+
+    @SerializedName("student_userid")
+    private String studentUserId;
+
+    @SerializedName("relation")
+    private String relation;
+
+    public static Children fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, Children.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  public static WxCpCreateParentRequest fromJson(String json) {
+    return WxCpGsonBuilder.create().fromJson(json, WxCpCreateParentRequest.class);
+  }
+
+  public String toJson() {
+    return WxCpGsonBuilder.create().toJson(this);
+  }
+
+}
diff --git a/...-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpUpdateParentRequest.java b/...-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/user/WxCpUpdateParentRequest.java
@@ -0,0 +1,65 @@
+package me.chanjar.weixin.cp.bean.school.user;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.*;
+import lombok.experimental.Accessors;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 更新家长请求.
+ *
+ * @author Wang_Wong
+ * @date 2022-06-20
+ */
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Accessors(chain = true)
+public class WxCpUpdateParentRequest implements Serializable {
+  private static final long serialVersionUID = -4960239393895754138L;
+
+  @SerializedName("parent_userid")
+  private String parentUserId;
+
+  @SerializedName("mobile")
+  private String mobile;
+
+  @SerializedName("new_parent_userid")
+  private String newParentUserId;
+
+  @SerializedName("children")
+  private List<Children> children;
+
+  @Setter
+  @Getter
+  public static class Children implements Serializable {
+
+    @SerializedName("student_userid")
+    private String studentUserId;
+
+    @SerializedName("relation")
+    private String relation;
+
+    public static Children fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, Children.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  public static WxCpUpdateParentRequest fromJson(String json) {
+    return WxCpGsonBuilder.create().fromJson(json, WxCpUpdateParentRequest.class);
+  }
+
+  public String toJson() {
+    return WxCpGsonBuilder.create().toJson(this);
+  }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java
@@ -183,6 +183,14 @@ interface School {
     String GET_STUDENT_CUSTOMIZE_HEALTH_INFO = "/cgi-bin/school/user/get_student_customize_health_info";
     String GET_HEALTH_QRCODE = "/cgi-bin/school/user/get_health_qrcode";
 
+    String CREATE_STUDENT = "/cgi-bin/school/user/create_student";
+    String DELETE_STUDENT = "/cgi-bin/school/user/delete_student?userid=";
+    String UPDATE_STUDENT = "/cgi-bin/school/user/update_student";
+    String CREATE_PARENT = "/cgi-bin/school/user/create_parent";
+    String UPDATE_PARENT = "/cgi-bin/school/user/update_parent";
+    String DELETE_PARENT = "/cgi-bin/school/user/delete_parent?userid=";
+    String SET_ARCH_SYNC_MODE = "/cgi-bin/school/set_arch_sync_mode";
+
     String GET_PAYMENT_RESULT = "/cgi-bin/school/get_payment_result";
     String GET_TRADE = "/cgi-bin/school/get_trade";