cn.felord.api

Interface UserApi

public interface UserApi

通讯录管理-成员管理

Since:

2021 /6/17 11:09

Author:

n1

Method Summary

Modifier and Type	Method and Description
WeComResponse	batchDelUser(UserIds userIdList) 批量删除成员
GenericResponse<List<TmpUser>>	batchOpenUserIdToUserId(ConvertTmpUserRequest request) tmp_external_userid的转换
UserIdConvertResponse	batchOpenUserIdToUserId(UserIdConvertRequest request) 自建应用与第三方应用的对接
GenericResponse<String>	converToOpenid(UserId request) userid与openid互换
WeComResponse	createUser(UserInfoRequest request) 创建成员
WeComResponse	deleteUser(String userId) 删除成员
GenericResponse<List<UserDetail>>	getDeptUserDetails(long departmentId) 获取部门成员详情（自建）
GenericResponse<List<SimpleUser>>	getDeptUsers(long departmentId) 获取部门成员
GenericResponse<String>	getJoinQrcode(int userQrcodeSize) 获取加入企业二维码
UserInfoResponse	getUser(String userId) 读取成员（自建）
GenericResponse<String>	getUserIdByEmail(EmailUserRequest request) 邮箱获取userid
GenericResponse<String>	getUserIdByMobile(Mobile mobile) 手机号获取userid
BatchInviteResponse	inviteUsers(BatchInviteRequest request) 邀请成员
WeComResponse	updateUser(UserInfoRequest request) 更新成员，这里建议userid不可更改，虽然微信支持修改一次。
WeComResponse	userAuth(String userId) 二次验证
DeptUserListResponse	userList(String cursor, int limit) 获取成员ID列表

Method Detail

batchOpenUserIdToUserId

@POST(value="batch/openuserid_to_userid")
UserIdConvertResponse batchOpenUserIdToUserId(@Body
                                                                                        UserIdConvertRequest request)

自建应用与第三方应用的对接

Parameters:

request - the request

Returns:

the user id convert response

batchOpenUserIdToUserId

@POST(value="idconvert/convert_tmp_external_userid")
GenericResponse<List<TmpUser>> batchOpenUserIdToUserId(@Body
                                                                                                            ConvertTmpUserRequest request)

tmp_external_userid的转换

Parameters:

request - the request

Returns:

the user id convert response

createUser

@POST(value="user/create")
WeComResponse createUser(@Body
                                                    UserInfoRequest request)

创建成员

仅通讯录同步助手或第三方通讯录应用可调用。

Parameters:

request - the request

Returns:

WeComResponse we com response

getUser

@GET(value="user/get")
UserInfoResponse getUser(@Query(value="userid")
                                                String userId)

读取成员（自建）

敏感信息需要授权

Parameters:

userId - the user id

Returns:

UserInfoResponse user

updateUser

@POST(value="user/update")
WeComResponse updateUser(@Body
                                                    UserInfoRequest request)

更新成员，这里建议userid不可更改，虽然微信支持修改一次。

仅通讯录同步助手或第三方通讯录应用可调用。

Parameters:

request - the request

Returns:

WeComResponse we com response

deleteUser

@GET(value="user/delete")
WeComResponse deleteUser(@Query(value="userid")
                                                   String userId)

删除成员

若是绑定了腾讯企业邮，则会同时删除邮箱帐号。

Parameters:

userId - the user id

Returns:

WeComResponse we com response

userList

@GET(value="user/list_id")
DeptUserListResponse userList(@Query(value="cursor")
                                                         String cursor,
                                                         @Query(value="limit")
                                                         int limit)

获取成员ID列表

Parameters:

cursor - the cursor

limit - the limit

Returns:

the dept user list response

batchDelUser

@POST(value="user/batchdelete")
WeComResponse batchDelUser(@Body
                                                           UserIds userIdList)

批量删除成员

若是绑定了腾讯企业邮，则会同时删除邮箱帐号。

Parameters:

userIdList - the user id list

Returns:

WeComResponse we com response

getDeptUsers

@GET(value="user/simplelist")
GenericResponse<List<SimpleUser>> getDeptUsers(@Query(value="department_id")
                                                                             long departmentId)

获取部门成员

应用须拥有指定部门的查看权限。

Parameters:

departmentId - departmentId

Returns:

SimpleUserResponse dept users

getDeptUserDetails

@GET(value="user/list")
GenericResponse<List<UserDetail>> getDeptUserDetails(@Query(value="department_id")
                                                                             long departmentId)

获取部门成员详情（自建）

应用须拥有指定部门的查看权限。

Parameters:

departmentId - departmentId

Returns:

UserDetailResponse dept user details

converToOpenid

@POST(value="user/convert_to_openid")
GenericResponse<String> converToOpenid(@Body
                                                                             UserId request)

userid与openid互换

该接口使用场景为企业支付，在使用企业红包和向员工付款时，需要自行将企业微信的userid转成openid。

注：需要成员使用微信登录企业微信或者关注微工作台（原企业号）才能转成openid; 如果是外部联系人，请使用外部联系人openid转换接口转换openid

Parameters:

request - the request

Returns:

OpenIdResponse generic response

userAuth

@GET(value="user/authsucc")
WeComResponse userAuth(@Query(value="userid")
                                                   String userId)

二次验证

企业在开启二次验证时，必须在管理端填写企业二次验证页面的url。

Parameters:

userId - userId

Returns:

WeComResponse we com response

inviteUsers

@POST(value="batch/invite")
BatchInviteResponse inviteUsers(@Body
                                                            BatchInviteRequest request)

邀请成员

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

Parameters:

request - batchInviteRequest

Returns:

BatchInviteResponse batch invite response

getJoinQrcode

@GET(value="corp/get_join_qrcode")
GenericResponse<String> getJoinQrcode(@Query(value="size_type")
                                                                         int userQrcodeSize)

获取加入企业二维码

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

Parameters:

userQrcodeSize - 范围 [1,4]

Returns:

WeComResponse join qrcode

getUserIdByMobile

@POST(value="user/getuserid")
GenericResponse<String> getUserIdByMobile(@Body
                                                                        Mobile mobile)

手机号获取userid

错误率过高会被限流

Parameters:

mobile - mobile

Returns:

WeComResponse active stat

getUserIdByEmail

@POST(value="user/get_userid_by_email")
GenericResponse<String> getUserIdByEmail(@Body
                                                                                 EmailUserRequest request)

邮箱获取userid

Parameters:

request - the request

Returns:

WeComResponse active stat