WxCpTpUserServiceImpl (WxJava - CP Java SDK 4.7.0 API)

java.lang.Object
- me.chanjar.weixin.cp.tp.service.impl.WxCpTpUserServiceImpl

所有已实现的接口:: WxCpTpUserService

public class WxCpTpUserServiceImpl
extends Object
implements WxCpTpUserService

  Created by jamie on 2020/7/22.

构造器概要

构造器
构造器和说明

WxCpTpUserServiceImpl()

构造器
构造器和说明
`WxCpTpUserServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`authenticate(String userId)` 用在二次验证的时候.
`void`	`create(WxCpUser user)` 新建用户.
`void`	`delete(String... userIds)` 删除用户/批量删除成员.
`WxCpUser`	`getById(String userid, String corpId)` 获取用户.
`WxCpUserExternalContactInfo`	`getExternalContact(String userId)` 获取外部联系人详情.
`String`	`getUserId(String mobile, String corpId)` 通过手机号获取其所对应的userid。
`WxCpInviteResult`	`invite(List<String> userIds, List<String> partyIds, List<String> tagIds)` 邀请成员.
`List<WxCpUser>`	`listByDepartment(Long departId, Boolean fetchChild, Integer status, String corpId)` 获取部门成员(详情).
`List<WxCpUser>`	`listSimpleByDepartment(Long departId, Boolean fetchChild, Integer status)` 获取部门成员.
`String`	`openid2UserId(String openid)` openid转userid.
`void`	`update(WxCpUser user)` 更新用户.
`Map<String,String>`	`userId2Openid(String userId, Integer agentId)` userid转openid.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料
- WxCpTpUserServiceImpl
```
public WxCpTpUserServiceImpl()
```

方法详细资料

authenticate

public void authenticate(String userId)
                  throws WxErrorException

从接口复制的说明: WxCpTpUserService

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

指定者:: authenticate 在接口中 WxCpTpUserService
参数:: userId - 用户id
抛出:: WxErrorException - the wx error exception

create
```
public void create(WxCpUser user)
            throws WxErrorException
```
从接口复制的说明: WxCpTpUserService

新建用户.

指定者:

create 在接口中 WxCpTpUserService

参数:

user - 用户对象

抛出:

WxErrorException - the wx error exception

update
```
public void update(WxCpUser user)
            throws WxErrorException
```
从接口复制的说明: WxCpTpUserService

更新用户.

指定者:

update 在接口中 WxCpTpUserService

参数:

user - 用户对象

抛出:

WxErrorException - the wx error exception

delete

public void delete(String... userIds)
            throws WxErrorException

从接口复制的说明: WxCpTpUserService

 删除用户/批量删除成员.
 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

指定者:: delete 在接口中 WxCpTpUserService
参数:: userIds - 员工UserID列表。对应管理端的帐号
抛出:: WxErrorException - the wx error exception

getById
```
public WxCpUser getById(String userid,
                        String corpId)
                 throws WxErrorException
```
从接口复制的说明: WxCpTpUserService

获取用户.

指定者:

getById 在接口中 WxCpTpUserService

参数:

userid - 用户id

corpId - the corp id

返回:

the by id

抛出:

WxErrorException - the wx error exception

listByDepartment

public List<WxCpUser> listByDepartment(Long departId,
                                       Boolean fetchChild,
                                       Integer status,
                                       String corpId)
                                throws WxErrorException

从接口复制的说明: WxCpTpUserService

 获取部门成员(详情).

 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

指定者:: listByDepartment 在接口中 WxCpTpUserService
参数:: departId - 必填。部门id; fetchChild - 非必填。1/0：是否递归获取子部门下面的成员; status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加; corpId - the corp id
返回:: the list
抛出:: WxErrorException - the wx error exception

listSimpleByDepartment

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

从接口复制的说明: WxCpTpUserService

 获取部门成员.

 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

指定者:: listSimpleByDepartment 在接口中 WxCpTpUserService
参数:: departId - 必填。部门id; fetchChild - 非必填。1/0：是否递归获取子部门下面的成员; status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加
返回:: the list
抛出:: WxErrorException - the wx error exception

invite

public WxCpInviteResult invite(List<String> userIds,
                               List<String> partyIds,
                               List<String> tagIds)
                        throws WxErrorException

从接口复制的说明: WxCpTpUserService

 邀请成员.
 企业可通过接口批量邀请成员使用企业微信，邀请后将通过短信或邮件下发通知。
 请求方式：POST（HTTPS）
 请求地址： https://qyapi.weixin.qq.com/cgi-bin/batch/invite?access_token=ACCESS_TOKEN
 文档地址：https://work.weixin.qq.com/api/doc#12543

指定者:: invite 在接口中 WxCpTpUserService
参数:: userIds - 成员ID列表, 最多支持1000个。; partyIds - 部门ID列表，最多支持100个。; tagIds - 标签ID列表，最多支持100个。
返回:: the wx cp invite result
抛出:: WxErrorException - the wx error exception

userId2Openid

public Map<String,String> userId2Openid(String userId,
                                        Integer agentId)
                                 throws WxErrorException

从接口复制的说明: WxCpTpUserService

  userid转openid.
  该接口使用场景为微信支付、微信红包和企业转账。

 在使用微信支付的功能时，需要自行将企业微信的userid转成openid。
 在使用微信红包功能时，需要将应用id和userid转成appid和openid才能使用。
 注：需要成员使用微信登录企业微信或者关注微信插件才能转成openid

 文档地址：https://work.weixin.qq.com/api/doc#11279

指定者:: userId2Openid 在接口中 WxCpTpUserService
参数:: userId - 企业内的成员id; agentId - 非必填，整型，仅用于发红包。其它场景该参数不要填，如微信支付、企业转账、电子发票
返回:: map对象，可能包含以下值： - openid 企业微信成员userid对应的openid，若有传参agentid，则是针对该agentid的openid。否则是针对企业微信corpid的openid - appid 应用的appid，若请求包中不包含agentid则不返回appid。该appid在使用微信红包时会用到
抛出:: WxErrorException - the wx error exception

openid2UserId

public String openid2UserId(String openid)
                     throws WxErrorException

从接口复制的说明: WxCpTpUserService

 openid转userid.

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

 文档地址：https://work.weixin.qq.com/api/doc#11279

指定者:: openid2UserId 在接口中 WxCpTpUserService
参数:: openid - 在使用微信支付、微信红包和企业转账之后，返回结果的openid
返回:: userid 该openid在企业微信对应的成员userid
抛出:: WxErrorException - the wx error exception

getUserId

public String getUserId(String mobile,
                        String corpId)
                 throws WxErrorException

从接口复制的说明: WxCpTpUserService


 通过手机号获取其所对应的userid。

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

 文档地址：https://work.weixin.qq.com/api/doc#90001/90143/91693

指定者:: getUserId 在接口中 WxCpTpUserService
参数:: mobile - 手机号码。长度为5~32个字节; corpId - – the corp id
返回:: userid mobile对应的成员userid
抛出:: WxErrorException - .

getExternalContact

public WxCpUserExternalContactInfo getExternalContact(String userId)
                                               throws WxErrorException

从接口复制的说明: WxCpTpUserService

获取外部联系人详情.

   企业可通过此接口，根据外部联系人的userid，拉取外部联系人详情。权限说明：
 企业需要使用外部联系人管理secret所获取的accesstoken来调用
 第三方应用需拥有“企业客户”权限。
 第三方应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。

指定者:: getExternalContact 在接口中 WxCpTpUserService
参数:: userId - 外部联系人的userid
返回:: 联系人详情 external contact
抛出:: WxErrorException - .

类 WxCpTpUserServiceImpl

构造器概要

方法概要

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

构造器详细资料

WxCpTpUserServiceImpl

方法详细资料

authenticate

create

update

delete

getById

listByDepartment

listSimpleByDepartment

invite

userId2Openid

openid2UserId

getUserId

getExternalContact