com.jeecg.dingtalk.api.user

类 JdtUserAPI

java.lang.Object

com.jeecg.dingtalk.api.user.JdtUserAPI

public class JdtUserAPI
extends Object

钉钉用户接口

作者:

sunjianlei

构造器概要

构造器

构造器和说明
JdtUserAPI()

方法概要

限定符和类型	方法和说明
static List<Response<com.alibaba.fastjson.JSONObject>>	batchDeletePseudo(Collection<String> userIds, String accessToken) 伪批量删除用户（for循环调接口）
static Response<String>	create(User user, String accessToken) 创建用户 https://developers.dingtalk.com/document/app/user-information-creation
static Response<com.alibaba.fastjson.JSONObject>	delete(String userid, String accessToken) 删除用户 https://developers.dingtalk.com/document/app/delete-a-user
static Response<User>	getUserById(String userid, String accessToken) 根据userid获取用户详情 https://developers.dingtalk.com/document/app/query-user-details
static Response<Integer>	getUserCount(boolean onlyActive, String accessToken) 获取员工人数 调用本接口获取员工人数。
static Response<Integer>	getUserCount(String accessToken) 获取员工人数，包含未激活钉钉的人员数量
static Response<String>	getUseridByMobile(String mobile, String accessToken) 根据手机号获取userid https://developers.dingtalk.com/document/app/query-users-by-phone-number
static Response<String>	getUseridByUnionid(String unionid, String accessToken) 根据unionid获取用户userid https://developers.dingtalk.com/document/app/query-a-user-by-the-union-id
static Response<PageResult<User>>	getUserListByDeptId(GetUserListBody body, String accessToken) 获取部门用户详情。
static Response<List<String>>	getUserListIdByDeptId(int deptId, String accessToken) 获取部门用户userid列表。
static Response<PageResult<User>>	getUserListSimpleByDeptId(GetUserListBody body, String accessToken) 获取部门用户基础信息。
static Response<com.alibaba.fastjson.JSONObject>	update(User user, String accessToken) 更新用户信息 https://developers.dingtalk.com/document/app/user-information-update

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

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

构造器详细资料

JdtUserAPI

public JdtUserAPI()

方法详细资料

create

public static Response<String> create(User user,
                                      String accessToken)

创建用户
https://developers.dingtalk.com/document/app/user-information-creation

参数:

user - 用户实例

accessToken - 有效的access_token

返回:

Response<String> 成功返回userid

update

public static Response<com.alibaba.fastjson.JSONObject> update(User user,
                                                               String accessToken)

更新用户信息
https://developers.dingtalk.com/document/app/user-information-update

参数:

user - 用户实例

accessToken - 有效的access_token

返回:

Response<JSONObject>

delete

public static Response<com.alibaba.fastjson.JSONObject> delete(String userid,
                                                               String accessToken)

删除用户
https://developers.dingtalk.com/document/app/delete-a-user

参数:

userid - 用户唯一标识userid

accessToken - 有效的access_token

返回:

Response<JSONObject>

batchDeletePseudo

public static List<Response<com.alibaba.fastjson.JSONObject>> batchDeletePseudo(Collection<String> userIds,
                                                                                String accessToken)

伪批量删除用户（for循环调接口）

参数:

userIds - 用户ID列表

accessToken - 有效的access_token

返回:

List<Response<JSONObject>>

getUserById

public static Response<User> getUserById(String userid,
                                         String accessToken)

根据userid获取用户详情
https://developers.dingtalk.com/document/app/query-user-details

参数:

userid - 用户唯一标识userid

accessToken - 有效的access_token

返回:

Response<User>

getUserListByDeptId

public static Response<PageResult<User>> getUserListByDeptId(GetUserListBody body,
                                                             String accessToken)

获取部门用户详情。说明：只获取当前部门下的员工信息，不包含子部门内的员工。
https://developers.dingtalk.com/document/app/queries-the-complete-information-of-a-department-user

参数:

body - GetUserListBody实例

accessToken - 有效的access_token

返回:

Response<PageResult<User>> 分页对象

getUserListSimpleByDeptId

public static Response<PageResult<User>> getUserListSimpleByDeptId(GetUserListBody body,
                                                                   String accessToken)

获取部门用户基础信息。
调用本接口获取指定部门的用户userid和name。
说明：只获取当前部门下的员工信息，不包含子部门内的员工。
https://developers.dingtalk.com/document/app/queries-the-complete-information-of-a-department-user

参数:

body - GetUserListBody实例

accessToken - 有效的access_token

返回:

Response<PageResult<User>> 分页对象

getUserListIdByDeptId

public static Response<List<String>> getUserListIdByDeptId(int deptId,
                                                           String accessToken)

获取部门用户userid列表。
注意：目前暂不支持一次性获取企业下所有员工userid值，如果开发者希望获取企业下所有员工userid值，可以通过以下方法：
1. 调用“获取部门列表”接口，通过逐级遍历，获取该企业下所有部门ID。
2. 调用本接口，分别获取每个部门下的员工userid。

https://developers.dingtalk.com/document/app/query-the-list-of-department-userids

参数:

deptId - deptId

accessToken - 有效的access_token

返回:

Response<List<String>>

getUserCount

public static Response<Integer> getUserCount(boolean onlyActive,
                                             String accessToken)

获取员工人数
调用本接口获取员工人数。
https://developers.dingtalk.com/document/app/obtain-the-number-of-employees-v2

参数:

onlyActive - 是否包含未激活钉钉人数。 false：包含未激活钉钉的人员数量。 true：只包含激活钉钉的人员数量。

accessToken - 有效的access_token

返回:

Response<Integer>

getUserCount

public static Response<Integer> getUserCount(String accessToken)

获取员工人数，包含未激活钉钉的人员数量

返回:

Response<Integer>

getUseridByMobile

public static Response<String> getUseridByMobile(String mobile,
                                                 String accessToken)

根据手机号获取userid
https://developers.dingtalk.com/document/app/query-users-by-phone-number

参数:

mobile - 用户的手机号。

accessToken - 有效的access_token

返回:

Response<String>

getUseridByUnionid

public static Response<String> getUseridByUnionid(String unionid,
                                                  String accessToken)

根据unionid获取用户userid
https://developers.dingtalk.com/document/app/query-a-user-by-the-union-id

参数:

unionid - 员工在当前开发者企业账号范围内的唯一标识，系统生成，不会改变。

accessToken - 有效的access_token

返回:

Response<String>