Package com.foxinmy.weixin4j.qy.api

Class UserApi

java.lang.Object

com.foxinmy.weixin4j.api.BaseApi

com.foxinmy.weixin4j.qy.api.QyApi

com.foxinmy.weixin4j.qy.api.UserApi

public class UserApi
extends QyApi

成员API

Since:

JDK 1.6

Author:

jinyu(foxinmy@gmail.com)

See Also:

User, 管理成员说明

Field Summary

Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

weixinExecutor

Constructor Summary

Constructors

Constructor	Description
UserApi(TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
ApiResult	authsucc(String userId)	开启二次验证成功时调用(管理员须拥有userid对应员工的管理权限)
ApiResult	batchDeleteUser(List<String> userIds)	批量删除成员
ApiResult	createUser(User user)	创建成员
ApiResult	createUser(User user, InputStream avatar)	创建成员
ApiResult	deleteUser(String userid)	删除成员
OUserInfo	getOUserInfoByCode(String authCode)	获取企业号管理员登录信息
User	getUser(String userid)	获取成员
User	getUserByCode(String code)	根据code获取用户信息
com.alibaba.fastjson.JSONObject	getUserIdByCode(String code)	根据code获取成员ID信息
InviteType	inviteUser(String userId, String tips)	邀请成员关注(管理员须拥有该成员的查看权限)
List<User>	listAllUser(UserStatus userStatus)	获取权限范围内的所有成员列表
List<User>	listUser(int partyId)	获取部门下所有状态成员(不进行递归)
List<User>	listUser(int partyId, boolean fetchChild, UserStatus userStatus, boolean findDetail)	获取部门成员
String	openid2userid(String openid)	openid转换成userid:该接口主要应用于使用微信支付、微信红包和企业转账之后的结果查询， 开发者需要知道某个结果事件的openid对应企业号内成员的信息时，可以通过调用该接口进行转换查询。
ApiResult	updateUser(User user)	更新用户(如果非必须的字段未指定 则不更新该字段之前的设置值)
ApiResult	updateUser(User user, InputStream avatar)	更新用户(如果非必须的字段未指定 则不更新该字段之前的设置值)
String[]	userid2openid(String userid, int agentid)	userid转换成openid:该接口使用场景为微信支付、微信红包和企业转账，企业号用户在使用微信支付的功能时， 需要自行将企业号的userid转成openid。 在使用微信红包功能时，需要将应用id和userid转成appid和openid才能使用。

Methods inherited from class com.foxinmy.weixin4j.qy.api.QyApi

weixinBundle

Methods inherited from class com.foxinmy.weixin4j.api.BaseApi

getRequestUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserApi

public UserApi(TokenManager tokenManager)

Method Detail

createUser

public ApiResult createUser(User user)
                     throws WeixinException

创建成员

Parameters:

user - 成员对象

Returns:

处理结果

Throws:

WeixinException

See Also:

User, 创建成员说明

createUser

public ApiResult createUser(User user,
                            InputStream avatar)
                     throws WeixinException

创建成员

Parameters:

user - 成员对象

avatar - 头像文件 可为空

Returns:

处理结果

Throws:

WeixinException

See Also:

User, 创建成员说明

updateUser

public ApiResult updateUser(User user)
                     throws WeixinException

更新用户(如果非必须的字段未指定 则不更新该字段之前的设置值)

Parameters:

user - 成员对象

Returns:

处理结果

Throws:

WeixinException

See Also:

User, 更新成员说明

updateUser

public ApiResult updateUser(User user,
                            InputStream avatar)
                     throws WeixinException

更新用户(如果非必须的字段未指定 则不更新该字段之前的设置值)

Parameters:

user - 成员对象

avatar - 头像文件

Returns:

处理结果

Throws:

WeixinException

See Also:

User, 更新成员说明

getUser

public User getUser(String userid)
             throws WeixinException

获取成员

Parameters:

userid - 成员唯一ID

Returns:

成员对象

Throws:

WeixinException

See Also:

User, 获取成员说明

getUserByCode

public User getUserByCode(String code)
                   throws WeixinException

根据code获取用户信息

Parameters:

code - 通过员工授权获取到的code，每次员工授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期

Returns:

成员对象

Throws:

WeixinException

See Also:

User, oauth授权获取用户信息

getUserIdByCode

public com.alibaba.fastjson.JSONObject getUserIdByCode(String code)
                                                throws WeixinException

根据code获取成员ID信息

Parameters:

code - 通过员工授权获取到的code，每次员工授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期

Returns:

换取结果

Throws:

WeixinException

See Also:

oauth授权获取用户信息

getOUserInfoByCode

public OUserInfo getOUserInfoByCode(String authCode)
                             throws WeixinException

获取企业号管理员登录信息

Parameters:

authCode - oauth2.0授权企业号管理员登录产生的code

Returns:

登陆信息

Throws:

WeixinException

See Also:

授权获取企业号管理员登录信息, OUserInfo

listUser

public List<User> listUser(int partyId,
                           boolean fetchChild,
                           UserStatus userStatus,
                           boolean findDetail)
                    throws WeixinException

获取部门成员

Parameters:

partyId - 部门ID

fetchChild - 是否递归获取子部门下面的成员

userStatus - 成员状态 status可叠加 未填写则默认为未关注(4)

findDetail - 是否获取详细信息

Returns:

成员列表

Throws:

WeixinException

See Also:

User, 获取部门成员说明

listUser

public List<User> listUser(int partyId)
                    throws WeixinException

获取部门下所有状态成员(不进行递归)

Parameters:

partyId - 部门ID

Returns:

成员列表

Throws:

WeixinException

listAllUser

public List<User> listAllUser(UserStatus userStatus)
                       throws WeixinException

获取权限范围内的所有成员列表

Parameters:

userStatus - 成员状态 未填写则默认为全部状态下的成员

Returns:

成员列表

Throws:

WeixinException

deleteUser

public ApiResult deleteUser(String userid)
                     throws WeixinException

删除成员

Parameters:

userid - 成员ID

Returns:

处理结果

Throws:

WeixinException

See Also:

删除成员说明

batchDeleteUser

public ApiResult batchDeleteUser(List<String> userIds)
                          throws WeixinException

批量删除成员

Parameters:

userIds - 成员列表

Returns:

处理结果

Throws:

WeixinException

See Also:

批量删除成员说明

authsucc

public ApiResult authsucc(String userId)
                   throws WeixinException

开启二次验证成功时调用(管理员须拥有userid对应员工的管理权限)

Parameters:

userid - 成员ID

Returns:

调用结果

Throws:

WeixinException

See Also:

二次验证说明

inviteUser

public InviteType inviteUser(String userId,
                             String tips)
                      throws WeixinException

邀请成员关注(管理员须拥有该成员的查看权限)

Parameters:

userId - 成员ID

tips - 推送到微信上的提示语（只有认证号可以使用）。当使用微信推送时，该字段默认为“请关注XXX企业号”，邮件邀请时，该字段无效。

Returns:

邀请类型

Throws:

WeixinException

See Also:

邀请成员关注说明

userid2openid

public String[] userid2openid(String userid,
                              int agentid)
                       throws WeixinException

userid转换成openid:该接口使用场景为微信支付、微信红包和企业转账，企业号用户在使用微信支付的功能时， 需要自行将企业号的userid转成openid。 在使用微信红包功能时，需要将应用id和userid转成appid和openid才能使用。

Parameters:

userid - 企业号内的成员id 必填

agentid - 需要发送红包的应用ID，若只是使用微信支付和企业转账，则无需该参数 传入0或负数则忽略

Returns:

结果数组 第一个元素为对应的openid 第二个元素则为应用的appid(如果有)

Throws:

WeixinException

See Also:

userid与openid互换

openid2userid

public String openid2userid(String openid)
                     throws WeixinException

openid转换成userid:该接口主要应用于使用微信支付、微信红包和企业转账之后的结果查询， 开发者需要知道某个结果事件的openid对应企业号内成员的信息时，可以通过调用该接口进行转换查询。

Parameters:

openid - 在使用微信支付、微信红包和企业转账之后，返回结果的openid

Returns:

该openid在企业号中对应的成员userid

Throws:

WeixinException

See Also:

userid与openid互换