cn.net.wanmo.common.weixin.work.inner.server_api.util.address_book

类 UserUtil

java.lang.Object

cn.net.wanmo.common.weixin.work.inner.server_api.util.address_book.UserUtil

public class UserUtil
extends Object

企业内部开发 -> 服务端API -> 通讯录管理 -> 成员管理

     1. 电脑端企业微信 -> 安全与管理 -> 管理工具 -> 通讯录同步 -> 开启;
     2. 查看 Secret;
     3. 企业可信IP配置;
 

字段概要

字段

限定符和类型	字段和说明
private static org.slf4j.Logger	logger

构造器概要

构造器

构造器和说明
UserUtil()

方法概要

限定符和类型	方法和说明
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserAuthSuccRes>	authSucc(Corp<AddressBookToken> corp, UserAuthSuccReq req) 二次验证
static cn.net.wanmo.common.result.InterfaceResult<UserAuthSuccRes>	authSucc(String logPrevDesc, String token, UserAuthSuccReq req) 二次验证
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserBatchDeleteRes>	batchDeleteUser(Corp<AddressBookToken> corp, UserBatchDeleteReq req) 批量删除成员
static cn.net.wanmo.common.result.InterfaceResult<UserBatchDeleteRes>	batchDeleteUser(String logPrevDesc, String token, UserBatchDeleteReq req) 批量删除成员
static <AddressBookToken extends AccessToken> void	batchInvite() 邀请成员 企业可通过接口批量邀请成员使用企业微信，邀请后将通过短信或邮件下发通知。
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserConvertToOpenidRes>	convertToOpenid(Corp<AddressBookToken> corp, UserConvertToOpenidReq req) userid转openid
static cn.net.wanmo.common.result.InterfaceResult<UserConvertToOpenidRes>	convertToOpenid(String logPrevDesc, String token, UserConvertToOpenidReq req) userid转openid
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserConvertToUseridRes>	convertToUserid(Corp<AddressBookToken> corp, UserConvertToUseridReq req) openid转userid
static cn.net.wanmo.common.result.InterfaceResult<UserConvertToUseridRes>	convertToUserid(String logPrevDesc, String token, UserConvertToUseridReq req) openid转userid
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserCreateRes>	createUser(Corp<AddressBookToken> corp, UserCreateReq req) 创建成员
static cn.net.wanmo.common.result.InterfaceResult<UserCreateRes>	createUser(String logPrevDesc, String token, UserCreateReq req) 创建成员
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserDeleteRes>	deleteUser(Corp<AddressBookToken> corp, UserDeleteReq req) 删除成员
static cn.net.wanmo.common.result.InterfaceResult<UserDeleteRes>	deleteUser(String logPrevDesc, String token, UserDeleteReq req) 删除成员
static <AddressBookToken extends AccessToken> void	getJoinQrcode() 获取加入企业二维码 支持企业用户获取实时成员加入二维码。
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetRes>	getUser(Corp<AddressBookToken> corp, UserGetReq req) 已过时。
static cn.net.wanmo.common.result.InterfaceResult<UserGetRes>	getUser(String logPrevDesc, String token, UserGetReq req) 已过时。
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetIdByEmailRes>	getUseridByEmail(Corp<AddressBookToken> corp, UserGetIdByEmailReq req) 邮箱获取userid 通过邮箱获取其所对应的userid。
static cn.net.wanmo.common.result.InterfaceResult<UserGetIdByEmailRes>	getUseridByEmail(String logPrevDesc, String token, UserGetIdByEmailReq req) 邮箱获取userid 通过邮箱获取其所对应的userid。
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetIdByMobileRes>	getUseridByMobile(Corp<AddressBookToken> corp, UserGetIdByMobileReq req) 手机号获取userid 通过手机号获取其所对应的userid。
static cn.net.wanmo.common.result.InterfaceResult<UserGetIdByMobileRes>	getUseridByMobile(String logPrevDesc, String token, UserGetIdByMobileReq req) 手机号获取userid 通过手机号获取其所对应的userid。
static <AddressBookToken extends AccessToken> void	listByDeptId() 获取部门成员详情 * 注：已停用
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserListIdRes>	listId(Corp<AddressBookToken> corp, UserListIdReq req) 获取成员ID列表 获取企业成员的userid与对应的部门ID列表 注：仅支持通过“通讯录同步secret”调用。
static cn.net.wanmo.common.result.InterfaceResult<UserListIdRes>	listId(String logPrevDesc, String token, UserListIdReq req) 获取成员ID列表 获取企业成员的userid与对应的部门ID列表 注：仅支持通过“通讯录同步secret”调用。
static cn.net.wanmo.common.result.InterfaceResult<UserListIdRes>	listId(String token, UserListIdReq req) 获取成员ID列表 获取企业成员的userid与对应的部门ID列表 注：仅支持通过“通讯录同步secret”调用。
static <AddressBookToken extends AccessToken> void	simpleListByDeptId() 获取部门成员 注：已停用
static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserUpdateRes>	updateUser(Corp<AddressBookToken> corp, UserUpdateReq req) 更新成员
static cn.net.wanmo.common.result.InterfaceResult<UserUpdateRes>	updateUser(String logPrevDesc, String token, UserUpdateReq req) 更新成员

从类继承的方法 java.lang.Object

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

字段详细资料

logger

private static org.slf4j.Logger logger

构造器详细资料

UserUtil

public UserUtil()

方法详细资料

createUser

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserCreateRes> createUser(Corp<AddressBookToken> corp,
                                                                                                                          UserCreateReq req)

创建成员

createUser

public static cn.net.wanmo.common.result.InterfaceResult<UserCreateRes> createUser(String logPrevDesc,
                                                                                   String token,
                                                                                   UserCreateReq req)

创建成员

getUser

@Deprecated
public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetRes> getUser(Corp<AddressBookToken> corp,
                                                                                                                                 UserGetReq req)

已过时。

读取成员
注： 通讯录查询接口停用

参数:

corp - 企业

req - 请求体

返回:

响应结果

getUser

@Deprecated
public static cn.net.wanmo.common.result.InterfaceResult<UserGetRes> getUser(String logPrevDesc,
                                                                                          String token,
                                                                                          UserGetReq req)

已过时。

读取成员
注： 通讯录查询接口停用

参数:

logPrevDesc - 日志前缀描述

token - 通讯录令牌

req - 请求体

返回:

响应结果

updateUser

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserUpdateRes> updateUser(Corp<AddressBookToken> corp,
                                                                                                                          UserUpdateReq req)

更新成员

updateUser

public static cn.net.wanmo.common.result.InterfaceResult<UserUpdateRes> updateUser(String logPrevDesc,
                                                                                   String token,
                                                                                   UserUpdateReq req)

更新成员

deleteUser

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserDeleteRes> deleteUser(Corp<AddressBookToken> corp,
                                                                                                                          UserDeleteReq req)

删除成员

deleteUser

public static cn.net.wanmo.common.result.InterfaceResult<UserDeleteRes> deleteUser(String logPrevDesc,
                                                                                   String token,
                                                                                   UserDeleteReq req)

删除成员

batchDeleteUser

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserBatchDeleteRes> batchDeleteUser(Corp<AddressBookToken> corp,
                                                                                                                                    UserBatchDeleteReq req)

批量删除成员

batchDeleteUser

public static cn.net.wanmo.common.result.InterfaceResult<UserBatchDeleteRes> batchDeleteUser(String logPrevDesc,
                                                                                             String token,
                                                                                             UserBatchDeleteReq req)

批量删除成员

simpleListByDeptId

public static <AddressBookToken extends AccessToken> void simpleListByDeptId()

获取部门成员
注：已停用

listByDeptId

public static <AddressBookToken extends AccessToken> void listByDeptId()

获取部门成员详情
* 注：已停用

convertToOpenid

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserConvertToOpenidRes> convertToOpenid(Corp<AddressBookToken> corp,
                                                                                                                                        UserConvertToOpenidReq req)

userid转openid

convertToOpenid

public static cn.net.wanmo.common.result.InterfaceResult<UserConvertToOpenidRes> convertToOpenid(String logPrevDesc,
                                                                                                 String token,
                                                                                                 UserConvertToOpenidReq req)

userid转openid

convertToUserid

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserConvertToUseridRes> convertToUserid(Corp<AddressBookToken> corp,
                                                                                                                                        UserConvertToUseridReq req)

openid转userid

convertToUserid

public static cn.net.wanmo.common.result.InterfaceResult<UserConvertToUseridRes> convertToUserid(String logPrevDesc,
                                                                                                 String token,
                                                                                                 UserConvertToUseridReq req)

openid转userid

authSucc

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserAuthSuccRes> authSucc(Corp<AddressBookToken> corp,
                                                                                                                          UserAuthSuccReq req)

二次验证

authSucc

public static cn.net.wanmo.common.result.InterfaceResult<UserAuthSuccRes> authSucc(String logPrevDesc,
                                                                                   String token,
                                                                                   UserAuthSuccReq req)

二次验证

batchInvite

public static <AddressBookToken extends AccessToken> void batchInvite()

邀请成员
企业可通过接口批量邀请成员使用企业微信，邀请后将通过短信或邮件下发通知。

getJoinQrcode

public static <AddressBookToken extends AccessToken> void getJoinQrcode()

获取加入企业二维码
支持企业用户获取实时成员加入二维码。

getUseridByMobile

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetIdByMobileRes> getUseridByMobile(Corp<AddressBookToken> corp,
                                                                                                                                        UserGetIdByMobileReq req)

手机号获取userid
通过手机号获取其所对应的userid。
注：请确保手机号的正确性，若出错的次数超出企业规模人数的20%，会导致1天不可调用。

参数:

corp - 企业

req - 请求体

返回:

响应结果

getUseridByMobile

public static cn.net.wanmo.common.result.InterfaceResult<UserGetIdByMobileRes> getUseridByMobile(String logPrevDesc,
                                                                                                 String token,
                                                                                                 UserGetIdByMobileReq req)

手机号获取userid
通过手机号获取其所对应的userid。
注：请确保手机号的正确性，若出错的次数超出企业规模人数的20%，会导致1天不可调用。

参数:

logPrevDesc - 日志前缀描述

token - 通讯录令牌

req - 请求体

返回:

响应结果

getUseridByEmail

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserGetIdByEmailRes> getUseridByEmail(Corp<AddressBookToken> corp,
                                                                                                                                      UserGetIdByEmailReq req)

邮箱获取userid
通过邮箱获取其所对应的userid。
注：请确保邮箱的正确性，若出错的次数较多，会导致1天不可调用。（限制阈值取决于安装企业的员工规模）

参数:

corp - 企业

req - 请求体

返回:

响应结果

getUseridByEmail

public static cn.net.wanmo.common.result.InterfaceResult<UserGetIdByEmailRes> getUseridByEmail(String logPrevDesc,
                                                                                               String token,
                                                                                               UserGetIdByEmailReq req)

邮箱获取userid
通过邮箱获取其所对应的userid。
注：请确保邮箱的正确性，若出错的次数较多，会导致1天不可调用。（限制阈值取决于安装企业的员工规模）

参数:

logPrevDesc - 日志前缀描述

token - 通讯录令牌

req - 请求体

返回:

响应结果

listId

public static <AddressBookToken extends AccessToken> cn.net.wanmo.common.result.InterfaceResult<UserListIdRes> listId(Corp<AddressBookToken> corp,
                                                                                                                      UserListIdReq req)

获取成员ID列表
获取企业成员的userid与对应的部门ID列表
注：仅支持通过“通讯录同步secret”调用。

参数:

corp - 企业

req - 请求体

返回:

响应结果

listId

public static cn.net.wanmo.common.result.InterfaceResult<UserListIdRes> listId(String token,
                                                                               UserListIdReq req)

获取成员ID列表
获取企业成员的userid与对应的部门ID列表
注：仅支持通过“通讯录同步secret”调用。

参数:

token - 通讯录令牌

req - 请求体

返回:

响应结果

listId

public static cn.net.wanmo.common.result.InterfaceResult<UserListIdRes> listId(String logPrevDesc,
                                                                               String token,
                                                                               UserListIdReq req)

获取成员ID列表
获取企业成员的userid与对应的部门ID列表
注：仅支持通过“通讯录同步secret”调用。

参数:

logPrevDesc - 日志前缀描述

token - 通讯录令牌

req - 请求体

返回:

响应结果