me.chanjar.weixin.cp.api

接口 WxCpUserService

所有已知实现类:

WxCpUserServiceImpl

public interface WxCpUserService

 用户管理接口
  Created by BinaryWang on 2017/6/24.
 

作者:

Binary Wang

方法概要

限定符和类型	方法和说明
void	authenticate(String userId) 用在二次验证的时候 企业在员工验证成功后，调用本方法告诉企业号平台该员工关注成功。
void	create(WxCpUser user) 新建用户
void	delete(String... userIds) 删除用户/批量删除成员 http://qydev.weixin.qq.com/wiki/index.php?
WxCpUser	getById(String userid) 获取用户
List<WxCpUser>	listByDepartment(Integer departId, Boolean fetchChild, Integer status) 获取部门成员(详情) http://qydev.weixin.qq.com/wiki/index.php?
List<WxCpUser>	listSimpleByDepartment(Integer departId, Boolean fetchChild, Integer status) 获取部门成员 http://qydev.weixin.qq.com/wiki/index.php?
void	update(WxCpUser user) 更新用户

方法详细资料

authenticate

void authenticate(String userId)
           throws WxErrorException

   用在二次验证的时候
   企业在员工验证成功后，调用本方法告诉企业号平台该员工关注成功。
 

参数:

userId - 用户id

抛出:

WxErrorException

listByDepartment

List<WxCpUser> listByDepartment(Integer departId,
                                Boolean fetchChild,
                                Integer status)
                         throws WxErrorException

 获取部门成员(详情)

 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E8.8E.B7.E5.8F.96.E9.83.A8.E9.97.A8.E6.88.90.E5.91.98.28.E8.AF.A6.E6.83.85.29
 

参数:

departId - 必填。部门id

fetchChild - 非必填。1/0：是否递归获取子部门下面的成员

status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加

抛出:

WxErrorException

listSimpleByDepartment

List<WxCpUser> listSimpleByDepartment(Integer departId,
                                      Boolean fetchChild,
                                      Integer status)
                               throws WxErrorException

 获取部门成员

 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E8.8E.B7.E5.8F.96.E9.83.A8.E9.97.A8.E6.88.90.E5.91.98
 

参数:

departId - 必填。部门id

fetchChild - 非必填。1/0：是否递归获取子部门下面的成员

status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加

抛出:

WxErrorException

create

void create(WxCpUser user)
     throws WxErrorException

新建用户

参数:

user - 用户对象

抛出:

WxErrorException

update

void update(WxCpUser user)
     throws WxErrorException

更新用户

参数:

user - 用户对象

抛出:

WxErrorException

delete

void delete(String... userIds)
     throws WxErrorException

 删除用户/批量删除成员
 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E6.89.B9.E9.87.8F.E5.88.A0.E9.99.A4.E6.88.90.E5.91.98
 

参数:

userIds - 员工UserID列表。对应管理端的帐号

抛出:

WxErrorException

getById

WxCpUser getById(String userid)
          throws WxErrorException

获取用户

参数:

userid - 用户id

抛出:

WxErrorException