【企业微信】增加家校应用-复学码接口支持

binarywang · binarywang · Jun 5, 2022 · Jun 1, 2022 · Jun 1, 2022 · Jun 2, 2022
commit 3faefb3296f9917e56bc02a1d473dd4adc4b1125
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
@@ -0,0 +1,60 @@
+package me.chanjar.weixin.cp.api;
+
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.cp.bean.school.WxCpCustomizeHealthInfo;
+import me.chanjar.weixin.cp.bean.school.WxCpResultList;
+
+import javax.validation.constraints.NotNull;
+import java.util.List;
+
+/**
+ * 企业微信家校应用 复学码相关接口.
+ * https://developer.work.weixin.qq.com/document/path/93744
+ * <p>
+ * 权限说明：
+ * 仅复学码应用可以调用
+ *
+ * @author <a href="https://github.com/0katekate0">Wang_Wong</a>
+ * @date: 2022/5/31 9:10
+ */
+public interface WxCpSchoolService {
+
+  /**
+   * 获取老师健康信息
+   * 请求方式： POST（HTTPS）
+   * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_teacher_customize_health_info?access_token=ACCESS_TOKEN
+   *
+   * @param date
+   * @param nextKey
+   * @param limit
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpCustomizeHealthInfo getTeacherCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException;
+
+  /**
+   * 获取学生健康信息
+   * 请求方式： POST（HTTPS）
+   * 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_student_customize_health_info?access_token=ACCESS_TOKEN
+   *
+   * @param date
+   * @param nextKey
+   * @param limit
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpCustomizeHealthInfo getStudentCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException;
+
+  /**
+   * 获取师生健康码
+   * 请求方式：POST（HTTPS）
+   * 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get_health_qrcode?access_token=ACCESS_TOKEN
+   *
+   * @param userIds
+   * @param type
+   * @return
+   * @throws WxErrorException
+   */
+  WxCpResultList getHealthQrCode(@NotNull List<String> userIds, @NotNull Integer type) 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
@@ -400,6 +400,13 @@ public interface WxCpService extends WxService {
    */
   WxCpOaService getOaService();
 
+  /**
+   * 获取家校应用复学码相关接口的服务类对象
+   *
+   * @return
-   * @return
+   *
-   * @return
+   *
+   */
+  WxCpSchoolService getSchoolService();
+
   /**
    * 获取家校应用健康上报的服务类对象
    *

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
@@ -49,6 +49,7 @@ public abstract class BaseWxCpServiceImpl<H, P> implements WxCpService, RequestH
   private WxCpTagService tagService = new WxCpTagServiceImpl(this);
   private WxCpAgentService agentService = new WxCpAgentServiceImpl(this);
   private WxCpOaService oaService = new WxCpOaServiceImpl(this);
+  private WxCpSchoolService schoolService = new WxCpSchoolServiceImpl(this);
   private WxCpSchoolHealthService schoolHealthService = new WxCpSchoolHealthServiceImpl(this);
   private WxCpLivingService livingService = new WxCpLivingServiceImpl(this);
   private WxCpOaAgentService oaAgentService = new WxCpOaAgentServiceImpl(this);
@@ -494,6 +495,11 @@ public WxCpOaService getOaService() {
     return oaService;
   }
 
+  @Override
+  public WxCpSchoolService getSchoolService() {
+    return schoolService;
+  }
+
   @Override
   public WxCpSchoolHealthService getSchoolHealthService() {
     return schoolHealthService;

diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpSchoolServiceImpl.java
@@ -0,0 +1,67 @@
+package me.chanjar.weixin.cp.api.impl;
+
+import com.google.gson.JsonObject;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import me.chanjar.weixin.common.error.WxErrorException;
+import me.chanjar.weixin.cp.api.WxCpSchoolService;
+import me.chanjar.weixin.cp.api.WxCpService;
+import me.chanjar.weixin.cp.bean.school.WxCpCustomizeHealthInfo;
+import me.chanjar.weixin.cp.bean.school.WxCpResultList;
+
+import javax.validation.constraints.NotNull;
+import java.util.List;
+import java.util.Optional;
+
+import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.School.*;
+
+/**
+ * 企业微信家校应用 复学码相关接口实现类.
+ * https://developer.work.weixin.qq.com/document/path/93744
+ *
+ * @author <a href="https://github.com/0katekate0">Wang_Wong</a>
+ * @date: 2022/6/1 14:05
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class WxCpSchoolServiceImpl implements WxCpSchoolService {
+
+  private final WxCpService cpService;
+
+  @Override
+  public WxCpCustomizeHealthInfo getTeacherCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(GET_TEACHER_CUSTOMIZE_HEALTH_INFO);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("date", date);
+    jsonObject.addProperty("limit", Optional.ofNullable(limit).orElse(100));
+    if (nextKey != null) {
+      jsonObject.addProperty("next_key", nextKey);
+    }
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpCustomizeHealthInfo.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpCustomizeHealthInfo getStudentCustomizeHealthInfo(@NotNull String date, String nextKey, Integer limit) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(GET_STUDENT_CUSTOMIZE_HEALTH_INFO);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("date", date);
+    jsonObject.addProperty("limit", Optional.ofNullable(limit).orElse(100));
+    if (nextKey != null) {
+      jsonObject.addProperty("next_key", nextKey);
+    }
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpCustomizeHealthInfo.fromJson(responseContent);
+  }
+
+  @Override
+  public WxCpResultList getHealthQrCode(@NotNull List<String> userIds, @NotNull Integer type) throws WxErrorException {
+    String apiUrl = this.cpService.getWxCpConfigStorage().getApiUrl(GET_HEALTH_QRCODE);
+    JsonObject jsonObject = new JsonObject();
+    jsonObject.addProperty("type", type);
+    jsonObject.addProperty("userids", userIds.toString());
+    String responseContent = this.cpService.post(apiUrl, jsonObject.toString());
+    return WxCpResultList.fromJson(responseContent);
+  }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/WxCpCustomizeHealthInfo.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/WxCpCustomizeHealthInfo.java
@@ -0,0 +1,150 @@
+package me.chanjar.weixin.cp.bean.school;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 获取健康信息.
+ *
+ * @author Wang_Wong
+ */
+@Data
+public class WxCpCustomizeHealthInfo extends WxCpBaseResp implements Serializable {
+  private static final long serialVersionUID = -5028321625142879581L;
+
+  @SerializedName("health_infos")
+  private List<HealthInfo> healthInfos;
+
+  @SerializedName("template_id")
+  private String templateId;
+
+  @SerializedName("next_key")
+  private String nextKey;
+
+  @SerializedName("ending")
+  private Integer ending;
+
+  @Getter
+  @Setter
+  public static class HealthInfo implements Serializable {
+    private static final long serialVersionUID = -5696099236344075582L;
+
+    @SerializedName("userid")
+    private String userId;
+
+    @SerializedName("health_qrcode_status")
+    private Integer healthQrCodeStatus;
+
+    @SerializedName("self_submit")
+    private Integer selfSubmit;
+
+    @SerializedName("report_values")
+    private List<ReportValue> reportValues;
+
+    @SerializedName("question_templates")
+    private List<QuestionTemplate> questionTemplates;
+
+    public static HealthInfo fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, HealthInfo.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  @Getter
+  @Setter
+  public static class ReportValue implements Serializable {
+    private static final long serialVersionUID = -5696099236344075582L;
+
+    @SerializedName("question_id")
+    private Integer questionId;
+
+    @SerializedName("single_chose")
+    private Integer singleChose;
+
+    @SerializedName("text")
+    private String text;
+
+    public static ReportValue fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, ReportValue.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  @Getter
+  @Setter
+  public static class QuestionTemplate implements Serializable {
+    private static final long serialVersionUID = -5696099236344075582L;
+
+    @SerializedName("question_id")
+    private Integer questionId;
+
+    @SerializedName("question_type")
+    private Integer questionType;
+
+    @SerializedName("title")
+    private String title;
+
+    @SerializedName("is_must_fill")
+    private Integer isMustFill;
+
+    @SerializedName("is_not_display")
+    private Integer isNotDisplay;
+
+    @SerializedName("option_list")
+    private List<OptionList> optionList;
+
+    public static QuestionTemplate fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, QuestionTemplate.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  @Getter
+  @Setter
+  public static class OptionList implements Serializable {
+    private static final long serialVersionUID = -5696099236344075582L;
+
+    @SerializedName("option_id")
+    private Integer optionId;
+
+    @SerializedName("option_text")
+    private String optionText;
+
+    public static OptionList fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, OptionList.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  public static WxCpCustomizeHealthInfo fromJson(String json) {
+    return WxCpGsonBuilder.create().fromJson(json, WxCpCustomizeHealthInfo.class);
+  }
+
+  public String toJson() {
+    return WxCpGsonBuilder.create().toJson(this);
+  }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/WxCpResultList.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/school/WxCpResultList.java
@@ -0,0 +1,53 @@
+package me.chanjar.weixin.cp.bean.school;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
+import me.chanjar.weixin.cp.bean.WxCpBaseResp;
+import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
+
+import java.io.Serializable;
+import java.util.List;
+
+/**
+ * 获取师生健康码.
+ *
+ * @author Wang_Wong
+ */
+@Data
+public class WxCpResultList extends WxCpBaseResp implements Serializable {
+  private static final long serialVersionUID = -5028321625142879581L;
+
+  @SerializedName("result_list")
+  private List<QrCodeList> qrCodeList;
+
+  @Setter
+  @Getter
+  public static class QrCodeList extends WxCpBaseResp{
+
+    @SerializedName("userid")
+    private String userId;
+
+    @SerializedName("qrcode_data")
+    private String qrCodeData;
+
+    public static QrCodeList fromJson(String json) {
+      return WxCpGsonBuilder.create().fromJson(json, QrCodeList.class);
+    }
+
+    public String toJson() {
+      return WxCpGsonBuilder.create().toJson(this);
+    }
+
+  }
+
+  public static WxCpResultList fromJson(String json) {
+    return WxCpGsonBuilder.create().fromJson(json, WxCpResultList.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
@@ -177,6 +177,10 @@ interface School {
     String GET_HEALTH_REPORT_STAT = "/cgi-bin/health/get_health_report_stat";
     String GET_REPORT_JOBIDS = "/cgi-bin/health/get_report_jobids";
     String GET_REPORT_JOB_INFO = "/cgi-bin/health/get_report_job_info";
+
+    String GET_TEACHER_CUSTOMIZE_HEALTH_INFO = "/cgi-bin/school/user/get_teacher_customize_health_info";
+    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";
   }
 
   interface Living {