me.chanjar.weixin.cp.api

接口 WxCpSchoolUserService

所有已知实现类:

WxCpSchoolUserServiceImpl

public interface WxCpSchoolUserService

企业微信家校沟通相关接口. https://developer.work.weixin.qq.com/document/path/91638

作者:

Wang_Wong

方法概要

限定符和类型	方法和说明
WxCpBaseResp	createParent(@NonNull WxCpCreateParentRequest request) 创建家长 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?
WxCpBaseResp	createStudent(@NonNull String studentUserId, @NonNull String name, @NonNull List<Integer> departments) 创建学生 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?
WxCpBaseResp	deleteParent(@NonNull String userId) 删除家长 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?
WxCpBaseResp	deleteStudent(@NonNull String studentUserId) 删除学生 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?
WxCpBaseResp	setArchSyncMode(@NonNull Integer archSyncMode) 设置家校通讯录自动同步模式 企业和第三方可通过此接口修改家校通讯录与班级标签之间的自动同步模式，注意，一旦设置禁止自动同步，将无法再次开启。
WxCpBaseResp	updateParent(@NonNull WxCpUpdateParentRequest request) 更新家长 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?
WxCpBaseResp	updateStudent(@NonNull String studentUserId, String newStudentUserId, String name, List<Integer> departments) 更新学生 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?

方法详细资料

createStudent

WxCpBaseResp createStudent(@NonNull
                           @NonNull String studentUserId,
                           @NonNull
                           @NonNull String name,
                           @NonNull
                           @NonNull List<Integer> departments)
                    throws WxErrorException

创建学生 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?access_token=ACCESS_TOKEN

参数:

studentUserId -

name -

departments -

返回:

抛出:

WxErrorException

deleteStudent

WxCpBaseResp deleteStudent(@NonNull
                           @NonNull String studentUserId)
                    throws WxErrorException

删除学生 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID

参数:

studentUserId -

返回:

抛出:

WxErrorException

updateStudent

WxCpBaseResp updateStudent(@NonNull
                           @NonNull String studentUserId,
                           String newStudentUserId,
                           String name,
                           List<Integer> departments)
                    throws WxErrorException

更新学生 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_student?access_token=ACCESS_TOKEN

参数:

studentUserId -

newStudentUserId -

name -

departments -

返回:

抛出:

WxErrorException

createParent

WxCpBaseResp createParent(@NonNull
                          @NonNull WxCpCreateParentRequest request)
                   throws WxErrorException

创建家长 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/create_parent?access_token=ACCESS_TOKEN

参数:

request -

返回:

抛出:

WxErrorException

updateParent

WxCpBaseResp updateParent(@NonNull
                          @NonNull WxCpUpdateParentRequest request)
                   throws WxErrorException

更新家长 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?access_token=ACCESS_TOKEN

参数:

request -

返回:

抛出:

WxErrorException

deleteParent

WxCpBaseResp deleteParent(@NonNull
                          @NonNull String userId)
                   throws WxErrorException

删除家长 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID

参数:

userId -

返回:

抛出:

WxErrorException

setArchSyncMode

WxCpBaseResp setArchSyncMode(@NonNull
                             @NonNull Integer archSyncMode)
                      throws WxErrorException

设置家校通讯录自动同步模式 企业和第三方可通过此接口修改家校通讯录与班级标签之间的自动同步模式，注意，一旦设置禁止自动同步，将无法再次开启。

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

参数:

archSyncMode - 家校通讯录同步模式：1-禁止将标签同步至家校通讯录，2-禁止将家校通讯录同步至标签，3-禁止家校通讯录和标签相互同步

返回:

抛出:

WxErrorException