me.chanjar.weixin.cp.api

接口 WxCpSchoolService

所有已知实现类:

WxCpSchoolServiceImpl

public interface WxCpSchoolService

企业微信家校应用 复学码相关接口. https://developer.work.weixin.qq.com/document/path/93744

权限说明： 仅复学码应用可以调用

作者:

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

方法概要

限定符和类型	方法和说明
WxCpLivingResult	deleteReplayData(String livingId) 删除直播回放 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?
WxCpResultList	getHealthQrCode(List<String> userIds, Integer type) 获取师生健康码 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get_health_qrcode?
WxCpSchoolLivingInfo	getLivingInfo(String livingId) 获取直播详情 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?
WxCpPaymentResult	getPaymentResult(String paymentId) 获取学生付款结果 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_payment_result?
WxCpCustomizeHealthInfo	getStudentCustomizeHealthInfo(String date, String nextKey, Integer limit) 获取学生健康信息 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_student_customize_health_info?
WxCpCustomizeHealthInfo	getTeacherCustomizeHealthInfo(String date, String nextKey, Integer limit) 获取老师健康信息 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_teacher_customize_health_info?
WxCpTrade	getTrade(String paymentId, String tradeNo) 获取订单详情 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_trade?
WxCpSchoolUnwatchStat	getUnwatchStat(String livingId, String nextKey) 获取未观看直播统计 通过该接口可以获取未观看直播的学生统计，学生的家长必须是已经关注「学校通知」才会纳入统计范围。
WxCpLivingResult.LivingIdResult	getUserAllLivingId(String userId, String cursor, Integer limit) 获取老师直播ID列表 通过此接口可以获取指定老师的所有直播ID 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/living/get_user_all_livingid?
WxCpSchoolWatchStat	getWatchStat(String livingId, String nextKey) 获取观看直播统计 通过该接口可以获取所有观看直播的人员统计 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_watch_stat?

方法详细资料

getTeacherCustomizeHealthInfo

WxCpCustomizeHealthInfo getTeacherCustomizeHealthInfo(String date,
                                                      String nextKey,
                                                      Integer limit)
                                               throws WxErrorException

获取老师健康信息 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/user/get_teacher_customize_health_info?access_token=ACCESS_TOKEN

参数:

date - the date

nextKey - the next key

limit - the limit

返回:

teacher customize health info

抛出:

WxErrorException - the wx error exception

getStudentCustomizeHealthInfo

WxCpCustomizeHealthInfo getStudentCustomizeHealthInfo(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

参数:

date - the date

nextKey - the next key

limit - the limit

返回:

student customize health info

抛出:

WxErrorException - the wx error exception

getHealthQrCode

WxCpResultList getHealthQrCode(List<String> userIds,
                               Integer type)
                        throws WxErrorException

获取师生健康码 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get_health_qrcode?access_token=ACCESS_TOKEN

参数:

userIds - the user ids

type - the type

返回:

health qr code

抛出:

WxErrorException - the wx error exception

getPaymentResult

WxCpPaymentResult getPaymentResult(String paymentId)
                            throws WxErrorException

获取学生付款结果 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_payment_result?access_token=ACCESS_TOKEN

参数:

paymentId - the payment id

返回:

payment result

抛出:

WxErrorException - the wx error exception

getTrade

WxCpTrade getTrade(String paymentId,
                   String tradeNo)
            throws WxErrorException

获取订单详情 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/school/get_trade?access_token=ACCESS_TOKEN

参数:

paymentId - the payment id

tradeNo - the trade no

返回:

trade

抛出:

WxErrorException - the wx error exception

getLivingInfo

WxCpSchoolLivingInfo getLivingInfo(String livingId)
                            throws WxErrorException

获取直播详情 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid =LIVINGID

参数:

livingId - the living id

返回:

living info

抛出:

WxErrorException - the wx error exception

getUserAllLivingId

WxCpLivingResult.LivingIdResult getUserAllLivingId(String userId,
                                                   String cursor,
                                                   Integer limit)
                                            throws WxErrorException

获取老师直播ID列表 通过此接口可以获取指定老师的所有直播ID

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

参数:

userId - the user id

cursor - the cursor

limit - the limit

返回:

user all living id

抛出:

WxErrorException - the wx error exception

getWatchStat

WxCpSchoolWatchStat getWatchStat(String livingId,
                                 String nextKey)
                          throws WxErrorException

获取观看直播统计 通过该接口可以获取所有观看直播的人员统计

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

参数:

livingId - the living id

nextKey - the next key

返回:

watch stat

抛出:

WxErrorException - the wx error exception

getUnwatchStat

WxCpSchoolUnwatchStat getUnwatchStat(String livingId,
                                     String nextKey)
                              throws WxErrorException

获取未观看直播统计 通过该接口可以获取未观看直播的学生统计，学生的家长必须是已经关注「学校通知」才会纳入统计范围。

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

参数:

livingId - the living id

nextKey - the next key

返回:

unwatch stat

抛出:

WxErrorException - the wx error exception

deleteReplayData

WxCpLivingResult deleteReplayData(String livingId)
                           throws WxErrorException

删除直播回放 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/living/delete_replay_data?access_token=ACCESS_TOKEN

参数:

livingId - the living id

返回:

wx cp living result

抛出:

WxErrorException - the wx error exception