me.chanjar.weixin.cp.api

接口 WxCpSchoolHealthService

所有已知实现类:

WxCpSchoolHealthServiceImpl

public interface WxCpSchoolHealthService

企业微信家校应用 健康上报接口. https://developer.work.weixin.qq.com/document/path/93676

作者:

Wang_Wong created on : 2022/5/31 9:10

方法概要

限定符和类型	方法和说明
WxCpGetHealthReportStat	getHealthReportStat(@NonNull String date) 获取健康上报使用统计 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_health_report_stat?
WxCpGetReportAnswer	getReportAnswer(@NonNull String jobId, @NonNull String date, Integer offset, Integer limit) 获取用户填写答案 通过此接口可以获取指定的健康上报任务详情。
WxCpGetReportJobIds	getReportJobIds(Integer offset, Integer limit) 获取健康上报任务ID列表 通过此接口可以获取企业当前正在运行的上报任务ID列表。
WxCpGetReportJobInfo	getReportJobInfo(@NonNull String jobId, @NonNull String date) 获取健康上报任务详情 通过此接口可以获取指定的健康上报任务详情。

方法详细资料

getHealthReportStat

WxCpGetHealthReportStat getHealthReportStat(@NonNull
                                            @NonNull String date)
                                     throws WxErrorException

获取健康上报使用统计 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_health_report_stat?access_token=ACCESS_TOKEN

参数:

date - 具体某天的使用统计，最长支持获取30天前数据

返回:

health report stat

抛出:

WxErrorException - the wx error exception

getReportJobIds

WxCpGetReportJobIds getReportJobIds(Integer offset,
                                    Integer limit)
                             throws WxErrorException

获取健康上报任务ID列表 通过此接口可以获取企业当前正在运行的上报任务ID列表。

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_report_jobids?access_token=ACCESS_TOKEN

参数:

offset - 否 分页，偏移量, 默认为0

limit - 否 分页，预期请求的数据量，默认为100，取值范围 1 ~ 100

返回:

report job ids

抛出:

WxErrorException - the wx error exception

getReportJobInfo

WxCpGetReportJobInfo getReportJobInfo(@NonNull
                                      @NonNull String jobId,
                                      @NonNull
                                      @NonNull String date)
                               throws WxErrorException

获取健康上报任务详情 通过此接口可以获取指定的健康上报任务详情。

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_report_job_info?access_token=ACCESS_TOKEN

参数:

jobId - 是 任务ID

date - 是 具体某天任务详情，仅支持获取最近14天数据

返回:

report job info

抛出:

WxErrorException - the wx error exception

getReportAnswer

WxCpGetReportAnswer getReportAnswer(@NonNull
                                    @NonNull String jobId,
                                    @NonNull
                                    @NonNull String date,
                                    Integer offset,
                                    Integer limit)
                             throws WxErrorException

获取用户填写答案 通过此接口可以获取指定的健康上报任务详情。

请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/health/get_report_answer?access_token=ACCESS_TOKEN

参数:

jobId - the job id

date - the date

offset - the offset

limit - the limit

返回:

report answer

抛出:

WxErrorException - the wx error exception