public class Employee extends Object
| 限定符和类型 | 方法和说明 |
|---|---|
CreateEmployeeResp |
create(CreateEmployeeReq req)
创建员工,本接口用于在企业下创建员工。
|
CreateEmployeeResp |
create(CreateEmployeeReq req,
RequestOptions reqOptions)
创建员工,本接口用于在企业下创建员工。
|
DeleteEmployeeResp |
delete(DeleteEmployeeReq req)
离职员工,本接口用于离职员工。
|
DeleteEmployeeResp |
delete(DeleteEmployeeReq req,
RequestOptions reqOptions)
离职员工,本接口用于离职员工。
|
FilterEmployeeResp |
filter(FilterEmployeeReq req)
批量获取员工列表,本接口用于依据指定条件,批量获取符合条件的员工详情列表。
|
FilterEmployeeResp |
filter(FilterEmployeeReq req,
RequestOptions reqOptions)
批量获取员工列表,本接口用于依据指定条件,批量获取符合条件的员工详情列表。
|
MgetEmployeeResp |
mget(MgetEmployeeReq req)
批量获取员工信息,本接口用于批量根据员工的ID查询员工的详情,比如员工姓名,手机号,邮箱,部门等信息。
|
MgetEmployeeResp |
mget(MgetEmployeeReq req,
RequestOptions reqOptions)
批量获取员工信息,本接口用于批量根据员工的ID查询员工的详情,比如员工姓名,手机号,邮箱,部门等信息。
|
PatchEmployeeResp |
patch(PatchEmployeeReq req)
更新员工信息,本接口用于更新在职/离职员工的信息、冻结/恢复员工。
|
PatchEmployeeResp |
patch(PatchEmployeeReq req,
RequestOptions reqOptions)
更新员工信息,本接口用于更新在职/离职员工的信息、冻结/恢复员工。
|
RegularEmployeeResp |
regular(RegularEmployeeReq req)
更新待离职成员为在职,本接口用于为待离职员工取消离职,将其更新为「在职」状态。
|
RegularEmployeeResp |
regular(RegularEmployeeReq req,
RequestOptions reqOptions)
更新待离职成员为在职,本接口用于为待离职员工取消离职,将其更新为「在职」状态。
|
ResurrectEmployeeResp |
resurrect(ResurrectEmployeeReq req)
恢复离职员工,该接口用于恢复已离职的成员,恢复已离职成员至在职状态。
|
ResurrectEmployeeResp |
resurrect(ResurrectEmployeeReq req,
RequestOptions reqOptions)
恢复离职员工,该接口用于恢复已离职的成员,恢复已离职成员至在职状态。
|
SearchEmployeeResp |
search(SearchEmployeeReq req)
搜索员工信息,本接口用于搜索员工信息,如通过关键词搜索员工的名称、手机号、邮箱等信息。
|
SearchEmployeeResp |
search(SearchEmployeeReq req,
RequestOptions reqOptions)
搜索员工信息,本接口用于搜索员工信息,如通过关键词搜索员工的名称、手机号、邮箱等信息。
|
ToBeResignedEmployeeResp |
toBeResigned(ToBeResignedEmployeeReq req)
更新在职员工为待离职,本接口用于为在职员工办理离职,将其更新为「待离职」状态。
|
ToBeResignedEmployeeResp |
toBeResigned(ToBeResignedEmployeeReq req,
RequestOptions reqOptions)
更新在职员工为待离职,本接口用于为在职员工办理离职,将其更新为「待离职」状态。
|
public Employee(Config config)
public CreateEmployeeResp create(CreateEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 只能在当前应用的通讯录授权范围内的部门下创建员工,如果要在根部门下创建员工,必须拥有全员权限。可以在开发者后台-应用详情-权限管理中查看通讯录授权范围。;- 本接口中支持的user_access_token 默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可创建员工时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 拥有本接口权限后,即可写入员工信息。但创建员工后仅返回应用有权限的字段数据,如果需要指定字段请按照文档中的描述申请对应权限。;- 本接口仅对自建应用开放。;- 创建出来的是在职状态的员工。;- 创建员工后,会发送邀请短信/邮件,需被邀请人点击同意后才可加入企业。 ;
Exceptionpublic CreateEmployeeResp create(CreateEmployeeReq req) throws Exception
注意:;- 只能在当前应用的通讯录授权范围内的部门下创建员工,如果要在根部门下创建员工,必须拥有全员权限。可以在开发者后台-应用详情-权限管理中查看通讯录授权范围。;- 本接口中支持的user_access_token 默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可创建员工时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 拥有本接口权限后,即可写入员工信息。但创建员工后仅返回应用有权限的字段数据,如果需要指定字段请按照文档中的描述申请对应权限。;- 本接口仅对自建应用开放。;- 创建出来的是在职状态的员工。;- 创建员工后,会发送邀请短信/邮件,需被邀请人点击同意后才可加入企业。 ;
Exceptionpublic DeleteEmployeeResp delete(DeleteEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,只能在当前应用的通讯录授权范围内离职员工。; - 若员工归属于多个部门,应用需要有员工所有所属部门的权限,才能离职成功。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可离职员工时,管理员管理范围取最大集。 ;
Exceptionpublic DeleteEmployeeResp delete(DeleteEmployeeReq req) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,只能在当前应用的通讯录授权范围内离职员工。; - 若员工归属于多个部门,应用需要有员工所有所属部门的权限,才能离职成功。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可离职员工时,管理员管理范围取最大集。 ;
Exceptionpublic FilterEmployeeResp filter(FilterEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档: [管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C) ;
Exceptionpublic FilterEmployeeResp filter(FilterEmployeeReq req) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档: [管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C) ;
Exceptionpublic MgetEmployeeResp mget(MgetEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档: [管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C) ;
Exceptionpublic MgetEmployeeResp mget(MgetEmployeeReq req) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档: [管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C) ;
Exceptionpublic PatchEmployeeResp patch(PatchEmployeeReq req, RequestOptions reqOptions) throws Exception
- 员工状态的修改遵循生命周期流转的规则,具体规则详见 [Directory-员工管理-资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/resources-introduction) 。;- 本接口支持tenant_access_token和user_access_token,接口获取方式参考[获取访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM);。; - 使用tenant_access_token时,只能在当前应用的通讯录授权范围内更新员工信息。可在开发者后台 > 权限管理 > 通讯录权限 中查看。; - 当变更员工的部门信息时,应用需要有变更前后的部门权限,才能变更成功。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可更新员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 变更「未加入」、「未激活」状态的员工的联系手机号、工作邮箱,会修改员工的登录凭证,并将员工重置为「未加入」状态,并发送邀请短信/邮件。其他状态的员工修改联系方式不影响登录凭证。;- 修改员工ID(employee_id)需要悉知以下影响:; - 员工ID(employee_id)是员工在企业内的唯一ID,可能会被应用引用来实现各种内部逻辑,唯一ID修改之后可能会导致引用失败,导致所有引用且保存了‘被修改 ID 员工’的业务全部受影响。;- 更新离职状态的员工信息时,以下字段不可更新:; - email、mobile、department_ids、leader_id、is_frozen、work_city_id ;
Exceptionpublic PatchEmployeeResp patch(PatchEmployeeReq req) throws Exception
- 员工状态的修改遵循生命周期流转的规则,具体规则详见 [Directory-员工管理-资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/resources-introduction) 。;- 本接口支持tenant_access_token和user_access_token,接口获取方式参考[获取访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM);。; - 使用tenant_access_token时,只能在当前应用的通讯录授权范围内更新员工信息。可在开发者后台 > 权限管理 > 通讯录权限 中查看。; - 当变更员工的部门信息时,应用需要有变更前后的部门权限,才能变更成功。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可更新员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 变更「未加入」、「未激活」状态的员工的联系手机号、工作邮箱,会修改员工的登录凭证,并将员工重置为「未加入」状态,并发送邀请短信/邮件。其他状态的员工修改联系方式不影响登录凭证。;- 修改员工ID(employee_id)需要悉知以下影响:; - 员工ID(employee_id)是员工在企业内的唯一ID,可能会被应用引用来实现各种内部逻辑,唯一ID修改之后可能会导致引用失败,导致所有引用且保存了‘被修改 ID 员工’的业务全部受影响。;- 更新离职状态的员工信息时,以下字段不可更新:; - email、mobile、department_ids、leader_id、is_frozen、work_city_id ;
Exceptionpublic RegularEmployeeResp regular(RegularEmployeeReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic RegularEmployeeResp regular(RegularEmployeeReq req) throws Exception
Exceptionpublic ResurrectEmployeeResp resurrect(ResurrectEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 恢复离职员工为在职,需要企业的版本在商业专业版及以上,可通过管理后台>设置>版本信息查看企业当前版本,且员工需要在离职 30 天内。恢复后,部分用户数据仍不可恢复,请谨慎调用。;- 待恢复成员的用户 ID 不能被企业内其他成员使用,可通过[批量获取员工列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter)接口查询用户ID是否存在。如有重复,请先离职对应的成员,否则接口会报错。;- 待恢复成员的手机号和邮箱不能被企业内其他成员使用,可通过[批量获取员工列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter)接口查询手机号/邮箱是否存在。如有重复,请先修改对应成员的信息,否则接口会报错。;- 本接口支持tenant_access_token和user_access_token,两种token的获取方式可参照[获取访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)。; - 使用tenant_access_token时,只能在将离职员工恢复到当前应用通讯录授权范围内的部门之下。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可恢复离职员工时,管理员管理范围取最大集。 ;
Exceptionpublic ResurrectEmployeeResp resurrect(ResurrectEmployeeReq req) throws Exception
注意:;- 恢复离职员工为在职,需要企业的版本在商业专业版及以上,可通过管理后台>设置>版本信息查看企业当前版本,且员工需要在离职 30 天内。恢复后,部分用户数据仍不可恢复,请谨慎调用。;- 待恢复成员的用户 ID 不能被企业内其他成员使用,可通过[批量获取员工列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter)接口查询用户ID是否存在。如有重复,请先离职对应的成员,否则接口会报错。;- 待恢复成员的手机号和邮箱不能被企业内其他成员使用,可通过[批量获取员工列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter)接口查询手机号/邮箱是否存在。如有重复,请先修改对应成员的信息,否则接口会报错。;- 本接口支持tenant_access_token和user_access_token,两种token的获取方式可参照[获取访问凭证](https://open.feishu.cn/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM)。; - 使用tenant_access_token时,只能在将离职员工恢复到当前应用通讯录授权范围内的部门之下。; - 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可恢复离职员工时,管理员管理范围取最大集。 ;
Exceptionpublic SearchEmployeeResp search(SearchEmployeeReq req, RequestOptions reqOptions) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 本接口无法搜索到外部企业或已离职的用户。 ;
Exceptionpublic SearchEmployeeResp search(SearchEmployeeReq req) throws Exception
注意:;- 本接口支持tenant_access_token和user_access_token。; - 使用tenant_access_token时,数据权限遵循应用的通讯录权限范围,返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。; - 使用user_access_token时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时,管理员管理范围取最大集。管理员权限可查看帮助中心文档:[管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C);- 本接口无法搜索到外部企业或已离职的用户。 ;
Exceptionpublic ToBeResignedEmployeeResp toBeResigned(ToBeResignedEmployeeReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic ToBeResignedEmployeeResp toBeResigned(ToBeResignedEmployeeReq req) throws Exception
ExceptionCopyright © 2026. All rights reserved.