查询人工任务列表，查询人工任务列表
官网API文档链接:
RecordsBatchUpdateWorkspaceTableResp |
WorkspaceTable.recordsBatchUpdate(RecordsBatchUpdateWorkspaceTableReq req,
RequestOptions reqOptions)
批量更新数据表中的记录，批量更新数据表中的记录
官网API文档链接:
RecordsDeleteWorkspaceTableResp |
WorkspaceTable.recordsDelete(RecordsDeleteWorkspaceTableReq req,
RequestOptions reqOptions)
删除数据表中的记录，删除数据表中的记录
官网API文档链接:
RecordsGetWorkspaceTableResp |
WorkspaceTable.recordsGet(RecordsGetWorkspaceTableReq req,
RequestOptions reqOptions)
查询数据表数据记录，查询数据表数据记录
官网API文档链接:
RecordsPatchWorkspaceTableResp |
WorkspaceTable.recordsPatch(RecordsPatchWorkspaceTableReq req,
RequestOptions reqOptions)
按条件更新数据表中的记录，按条件更新数据表中的记录
官网API文档链接:
RecordsPostWorkspaceTableResp |
WorkspaceTable.recordsPost(RecordsPostWorkspaceTableReq req,
RequestOptions reqOptions)
向数据表中添加或更新记录，向数据表中添加或更新记录
官网API文档链接:
RejectApprovalTaskResp |
ApprovalTask.reject(RejectApprovalTaskReq req,
RequestOptions reqOptions)
拒绝人工任务，对于人工任务进行拒绝操作
官网API文档链接:
RollbackUserTaskResp |
UserTask.rollback(RollbackUserTaskReq req,
RequestOptions reqOptions)
人工任务 - 退回，对当前任务进行一次退回
官网API文档链接:
RollbackPointsUserTaskResp |
UserTask.rollbackPoints(RollbackPointsUserTaskReq req,
RequestOptions reqOptions)
人工任务 - 查询可退回的位置，查询当前任务可以退回的位置
官网API文档链接:
SearchApplicationObjectResp |
ApplicationObject.search(SearchApplicationObjectReq req,
RequestOptions reqOptions)
搜索记录，在应用内搜索记录
官网API文档链接:
SqlCommandsWorkspaceResp |
Workspace.sqlCommands(SqlCommandsWorkspaceReq req,
RequestOptions reqOptions)
执行 SQL，在工作空间下执行 SQL 语句
官网API文档链接:
TableGetWorkspaceTableResp |
WorkspaceTable.tableGet(TableGetWorkspaceTableReq req,
RequestOptions reqOptions)
获取数据表详细信息，获取数据表详细信息
官网API文档链接:
TransferApprovalTaskResp |
ApprovalTask.transfer(TransferApprovalTaskReq req,
RequestOptions reqOptions)
转交人工任务，对于人工任务进行转交操作
官网API文档链接:
ViewsGetWorkspaceViewResp |
WorkspaceView.viewsGet(ViewsGetWorkspaceViewReq req,
RequestOptions reqOptions)
查询视图数据记录，查询视图数据记录
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.application.v6.resource中的方法
| 限定符和类型 |
方法和说明 |
ApplyScopeResp |
Scope.apply(RequestOptions reqOptions)
向管理员申请授权，调用该接口以应用身份向租户管理员申请应用内需要审核的 API 权限。
|
CheckWhiteBlackListApplicationVisibilityResp |
ApplicationVisibility.checkWhiteBlackList(CheckWhiteBlackListApplicationVisibilityReq req,
RequestOptions reqOptions)
|
ContactsRangeSuggestApplicationAppVersionResp |
ApplicationAppVersion.contactsRangeSuggest(ContactsRangeSuggestApplicationAppVersionReq req,
RequestOptions reqOptions)
获取应用版本中开发者申请的通讯录权限范围，该接口用于根据应用的 App ID 和版本 ID 获取企业自建应用某个版本的通讯录权限范围。
|
DepartmentOverviewApplicationAppUsageResp |
ApplicationAppUsage.departmentOverview(DepartmentOverviewApplicationAppUsageReq req,
RequestOptions reqOptions)
获取多部门应用使用概览，查看应用在某一天/某一周/某一个月的使用数据，可以根据部门做多层子部门的筛选
1.
|
GetApplicationAppVersionResp |
ApplicationAppVersion.get(GetApplicationAppVersionReq req,
RequestOptions reqOptions)
|
ListApplicationAppVersionResp |
ApplicationAppVersion.list(ListApplicationAppVersionReq req,
RequestOptions reqOptions)
获取应用版本列表，根据 app_id 获取对应应用版本列表。
|
ListApplicationFeedbackResp |
ApplicationFeedback.list(ListApplicationFeedbackReq req,
RequestOptions reqOptions)
|
ListAppRecommendRuleResp |
AppRecommendRule.list(ListAppRecommendRuleReq req,
RequestOptions reqOptions)
获取当前设置的推荐规则列表，获取当前设置的推荐规则列表。
|
ListScopeResp |
Scope.list(RequestOptions reqOptions)
查询租户授权状态，调用该接口查询当前应用向租户申请授权的状态。
|
MessagePushOverviewApplicationAppUsageResp |
ApplicationAppUsage.messagePushOverview(MessagePushOverviewApplicationAppUsageReq req,
RequestOptions reqOptions)
获取消息推送概览，目标：查看应用在某一天/某一周/某一个月的机器人消息推送数据，可以根据部门做筛选
1.
|
OverviewApplicationAppUsageResp |
ApplicationAppUsage.overview(OverviewApplicationAppUsageReq req,
RequestOptions reqOptions)
获取应用使用概览，查看应用在某一天/某一周/某一个月的使用数据，可以查看租户整体对应用的使用情况，也可以分部门查看。
|
PatchApplicationAppVersionResp |
ApplicationAppVersion.patch(PatchApplicationAppVersionReq req,
RequestOptions reqOptions)
更新应用审核状态，通过接口来更新应用版本的审核结果：通过后应用可以直接上架；拒绝后则开发者可以看到拒绝理由，并在修改后再次申请发布。
|
PatchApplicationContactsRangeResp |
ApplicationContactsRange.patch(PatchApplicationContactsRangeReq req,
RequestOptions reqOptions)
更新应用通讯录权限范围配置，该接口用于更新当前企业内自建应用或已安装的商店应用的通讯录权限范围配置。
|
PatchApplicationFeedbackResp |
ApplicationFeedback.patch(PatchApplicationFeedbackReq req,
RequestOptions reqOptions)
|
SetAppBadgeResp |
AppBadge.set(SetAppBadgeReq req,
RequestOptions reqOptions)
|
UpdateApplicationManagementResp |
ApplicationManagement.update(UpdateApplicationManagementReq req,
RequestOptions reqOptions)
启停用应用，可停用或启用企业内已安装的自建应用与商店应用。
|
UpdateApplicationOwnerResp |
ApplicationOwner.update(UpdateApplicationOwnerReq req,
RequestOptions reqOptions)
转移应用所有者，将某个自建应用的所有者转移给另外一个人。
|
参数类型为RequestOptions的com.lark.oapi.service.approval.v4.resource中的方法
| 限定符和类型 |
方法和说明 |
AddCcInstanceResp |
Instance.addCc(AddCcInstanceReq req,
RequestOptions reqOptions)
抄送审批实例，调用该接口将当前审批实例抄送给指定用户。
|
AddSignInstanceResp |
Instance.addSign(AddSignInstanceReq req,
RequestOptions reqOptions)
|
CancelInstanceResp |
Instance.cancel(CancelInstanceReq req,
RequestOptions reqOptions)
撤回审批实例，如果企业管理员在审批后台的某一审批定义的 **更多设置** 中，勾选了 **允许撤销审批中的申请** 或者 **允许撤销 x
天内通过的审批**，则在符合撤销规则的情况下，你可以调用本接口将指定提交人的审批实例撤回。
|
CcInstanceResp |
Instance.cc(CcInstanceReq req,
RequestOptions reqOptions)
抄送审批实例，调用该接口将当前审批实例抄送给指定用户。
|
CheckExternalInstanceResp |
ExternalInstance.check(CheckExternalInstanceReq req,
RequestOptions reqOptions)
校验三方审批实例，调用该接口校验三方审批实例数据，用于判断服务端数据是否为最新的。
|
CreateApprovalResp |
Approval.create(CreateApprovalReq req,
RequestOptions reqOptions)
创建审批定义，该接口用于创建审批定义，可以灵活指定审批定义的基础信息、表单和流程等。
|
CreateExternalApprovalResp |
ExternalApproval.create(CreateExternalApprovalReq req,
RequestOptions reqOptions)
同步三方审批定义，该接口用于将其他系统的审批定义同步至飞书审批，配合[同步三方审批实例](https://open.feishu.cn/document%2FuAjLw4CM%2FukTMukTMukTM%2Freference%2Fapproval-v4%2Fexternal_instance%2Fcreate),[三方快捷审批回调](https://open.feishu.cn/document%2FukTMukTMukTM%2FukjNyYjL5YjM24SO2IjN%2Fquick-approval-callback)使用可将企业内所有审批流集中在飞书审批中统一处理。
|
CreateExternalInstanceResp |
ExternalInstance.create(CreateExternalInstanceReq req,
RequestOptions reqOptions)
同步三方审批实例，审批中心不负责审批的流转，审批的流转在三方系统。
|
CreateInstanceCommentResp |
InstanceComment.create(CreateInstanceCommentReq req,
RequestOptions reqOptions)
创建评论，在指定审批实例下创建、修改评论或回复评论（不包含审批同意、拒绝、转交等附加的理由或意见）。
|
CreateInstanceResp |
Instance.create(CreateInstanceReq req,
RequestOptions reqOptions)
创建审批实例，调用本接口使用指定审批定义 Code 创建一个审批实例，接口调用者需对审批定义的表单有详细了解，按照定义的表单结构，将表单 Value 通过本接口传入。
|
DeleteInstanceCommentResp |
InstanceComment.delete(DeleteInstanceCommentReq req,
RequestOptions reqOptions)
删除评论，删除某审批实例下的一条评论或评论回复（不包含审批同意、拒绝、转交等附加的理由或意见），删除后在审批中心的审批实例内不再显示评论内容，而是显示 **评论已删除**。
|
DetailInstanceResp |
Instance.detail(DetailInstanceReq req,
RequestOptions reqOptions)
获取单个审批实例详情，通过审批实例 Code 获取指定审批实例的详细信息，包括审批实例的名称、创建时间、发起审批的用户、状态以及任务列表等信息。
|
ForwardTaskResp |
Task.forward(ForwardTaskReq req,
RequestOptions reqOptions)
转交审批任务，对于单个审批任务进行转交操作。
|
GetApprovalResp |
Approval.get(GetApprovalReq req,
RequestOptions reqOptions)
查看指定审批定义，根据审批定义 Code 以及语言、用户 ID
等筛选条件获取指定审批定义的信息，包括审批定义名称、状态、表单控件以及节点等信息。
|
GetExternalApprovalResp |
ExternalApproval.get(GetExternalApprovalReq req,
RequestOptions reqOptions)
查看指定三方审批定义，调用该接口通过三方审批定义 Code 获取审批定义的详细数据，包括三方审批定义的名称、说明、三方审批发起链接、回调 URL 以及审批定义可见人列表等信息。
|
GetInstanceResp |
Instance.get(GetInstanceReq req,
RequestOptions reqOptions)
获取单个审批实例详情，通过审批实例 Code 获取指定审批实例的详细信息，包括审批实例的名称、创建时间、发起审批的用户、状态以及任务列表等信息。
|
InitiatedInstanceResp |
Instance.initiated(InitiatedInstanceReq req,
RequestOptions reqOptions)
|
ListInstanceCommentResp |
InstanceComment.list(ListInstanceCommentReq req,
RequestOptions reqOptions)
获取评论，根据审批实例 Code 获取某个审批实例下，全部评论与评论回复（不包含审批同意、拒绝、转交等附加的理由或意见）。
|
ListInstanceResp |
Instance.list(ListInstanceReq req,
RequestOptions reqOptions)
批量获取审批实例 ID，根据审批定义的 approval_code 批量获取审批实例的 instance_code，用于拉取企业下某个审批定义的全部审批实例。
|
ListTaskResp |
Task.list(ListTaskReq req,
RequestOptions reqOptions)
获取审批任务列表，通过设置任务分组、审批定义 Code（审批流程的唯一标识）等，查询任务列表。
|
PassTaskResp |
Task.pass(PassTaskReq req,
RequestOptions reqOptions)
同意审批任务，对于单个审批任务进行同意操作。
|
PreviewInstanceResp |
Instance.preview(PreviewInstanceReq req,
RequestOptions reqOptions)
|
QueryTaskResp |
Task.query(QueryTaskReq req,
RequestOptions reqOptions)
查询用户的任务列表，通过设置用户、任务分组，查询任务信息。
|
RecallInstanceResp |
Instance.recall(RecallInstanceReq req,
RequestOptions reqOptions)
撤回审批实例，在符合撤销规则的情况下，你可以调用本接口将**当前用户身份提交的**的审批实例撤回。
|
RefuseTaskResp |
Task.refuse(RefuseTaskReq req,
RequestOptions reqOptions)
拒绝审批任务，对于单个审批任务进行拒绝操作。
|
RejectTaskResp |
Task.reject(RejectTaskReq req,
RequestOptions reqOptions)
拒绝审批任务，对于单个审批任务进行拒绝操作。
|
RemindInstanceResp |
Instance.remind(RemindInstanceReq req,
RequestOptions reqOptions)
|
ResubmitTaskResp |
Task.resubmit(ResubmitTaskReq req,
RequestOptions reqOptions)
重新提交审批任务，对于退回到发起人的审批任务进行重新发起操作。
|
RollbackTaskResp |
Task.rollback(RollbackTaskReq req,
RequestOptions reqOptions)
退回审批任务，从当前审批任务，退回到已审批的一个或多个任务节点。
|
SearchDistrictResp |
District.search(SearchDistrictReq req,
RequestOptions reqOptions)
|
SearchCcInstanceResp |
Instance.searchCc(SearchCcInstanceReq req,
RequestOptions reqOptions)
查询抄送列表，该接口通过不同条件查询审批系统中符合条件的审批抄送列表。
|
SpecifiedRollbackInstanceResp |
Instance.specifiedRollback(SpecifiedRollbackInstanceReq req,
RequestOptions reqOptions)
退回审批任务，从当前审批任务，退回到已审批的一个或多个任务节点。
|
SubscribeApprovalResp |
Approval.subscribe(SubscribeApprovalReq req,
RequestOptions reqOptions)
订阅审批事件，当应用[订阅审批事件](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)后，需要调用该接口指定审批定义
Code（approval_code）开启订阅，开启后应用才可以接收该审批定义对应的事件。
|
SubscriptionInstanceResp |
Instance.subscription(SubscriptionInstanceReq req,
RequestOptions reqOptions)
订阅审批实例状态变更事件，当应用[订阅审批事件](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)后，对于事件type为[审批实例状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/events/status_changed)的事件;，需要调用该接口指定需要接收通知的审批任务范围，指定后才可以接收到对应范围内的事件。
|
SubscriptionTaskResp |
Task.subscription(SubscriptionTaskReq req,
RequestOptions reqOptions)
订阅审批任务状态变更事件，当应用[订阅审批事件](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)后，对于事件type为[审批任务状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/events/status_changed)的事件;，需要调用该接口指定需要接收通知的审批任务范围，指定后才可以接收到对应范围内的事件。
|
TransferTaskResp |
Task.transfer(TransferTaskReq req,
RequestOptions reqOptions)
转交审批任务，对于单个审批任务进行转交操作。
|
UnsubscribeApprovalResp |
Approval.unsubscribe(UnsubscribeApprovalReq req,
RequestOptions reqOptions)
取消订阅审批事件，调用[订阅审批事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe)接口订阅审批定义
Code 后，如果不再需要接收该审批定义下的事件订阅通知，可以调用本接口取消订阅审批定义 Code，取消后应用无法再收到该审批定义对应实例的事件通知。
|
UnsubscriptionInstanceResp |
Instance.unsubscription(UnsubscriptionInstanceReq req,
RequestOptions reqOptions)
退订审批实例状态变更事件，当不再希望收到任务状态变更事件时，调用此接口，该接口用于撤销[订阅审批实例状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/subscription)中的操作
官网API文档链接:
UnsubscriptionTaskResp |
Task.unsubscription(UnsubscriptionTaskReq req,
RequestOptions reqOptions)
退订审批任务状态变更事件，当不再希望收到任务状态变更事件时，调用此接口，该接口用于撤销[订阅审批任务状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/subscription)中的操作
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.attendance.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchCreateUserDailyShiftResp |
UserDailyShift.batchCreate(BatchCreateUserDailyShiftReq req,
RequestOptions reqOptions)
创建或修改排班表，排班表是用来描述考勤组内人员每天按哪个班次进行上班。
|
BatchCreateUserFlowResp |
UserFlow.batchCreate(BatchCreateUserFlowReq req,
RequestOptions reqOptions)
导入打卡流水，导入员工的打卡流水记录。
|
BatchCreateTempUserDailyShiftResp |
UserDailyShift.batchCreateTemp(BatchCreateTempUserDailyShiftReq req,
RequestOptions reqOptions)
创建或更改临时排班，可在排班表上创建或修改临时班次，并用于排班。
|
BatchDelUserFlowResp |
UserFlow.batchDel(BatchDelUserFlowReq req,
RequestOptions reqOptions)
删除打卡流水，删除员工从开放平台导入的打卡记录。
|
CreateGroupResp |
Group.create(CreateGroupReq req,
RequestOptions reqOptions)
创建或修改考勤组，考勤组，是对部门或者员工在某个特定场所及特定时间段内的出勤情况（包括上下班、迟到、早退、病假、婚假、丧假、公休、工作时间、加班情况等）的一种规则设定。
|
CreateShiftResp |
Shift.create(CreateShiftReq req,
RequestOptions reqOptions)
创建班次，该接口用于创建企业的考勤班次。
|
CreateUserApprovalResp |
UserApproval.create(CreateUserApprovalReq req,
RequestOptions reqOptions)
写入审批结果，由于部分企业使用的是自己的审批系统，而不是飞书审批系统，因此员工的请假、加班等数据无法流入到飞书考勤系统中，导致员工在请假时间段内依然收到打卡提醒，并且被记为缺卡。
|
CreateUserTaskRemedyResp |
UserTaskRemedy.create(CreateUserTaskRemedyReq req,
RequestOptions reqOptions)
通知补卡审批发起，对于只使用飞书考勤系统而未使用飞书审批系统的企业，可以通过该接口，将在三方审批系统中发起的补卡审批数据，写入到飞书考勤系统中，状态为审批中。
|
DeleteGroupResp |
Group.delete(DeleteGroupReq req,
RequestOptions reqOptions)
删除考勤组，通过考勤组 ID
删除考勤组。
|
DeleteShiftResp |
Shift.delete(DeleteShiftReq req,
RequestOptions reqOptions)
删除班次，通过班次 ID
删除班次。
|
DelReportArchiveRuleResp |
ArchiveRule.delReport(DelReportArchiveRuleReq req,
RequestOptions reqOptions)
|
GetGroupResp |
Group.get(GetGroupReq req,
RequestOptions reqOptions)
按 ID 查询考勤组，通过考勤组 ID 获取考勤组详情。
|
GetLeaveEmployExpireRecordResp |
LeaveEmployExpireRecord.get(GetLeaveEmployExpireRecordReq req,
RequestOptions reqOptions)
|
GetUserFlowResp |
UserFlow.get(GetUserFlowReq req,
RequestOptions reqOptions)
查询打卡流水，通过打卡记录 ID 获取用户的打卡流水记录。
|
ListArchiveRuleResp |
ArchiveRule.list(ListArchiveRuleReq req,
RequestOptions reqOptions)
查询所有归档规则，查询所有归档规则，对应后台假勤管理-考勤统计-报表-[归档报表](https://example.feishu.cn/people/workforce-management/manage/statistics/report)功能
官网API文档链接:
ListGroupResp |
Group.list(ListGroupReq req,
RequestOptions reqOptions)
查询所有考勤组，翻页获取所有考勤组列表。
|
|
ListShiftResp |
Shift.list(ListShiftReq req,
RequestOptions reqOptions)
|
PatchLeaveAccrualRecordResp |
LeaveAccrualRecord.patch(PatchLeaveAccrualRecordReq req,
RequestOptions reqOptions)
修改发放记录;，更新发放记录的发放数量和失效日期，对应假勤管理-休假管理-[发放记录](https://example.feishu.cn/people/workforce-management/manage/leave/leave_admin/granting_record)
官网API文档链接:
ProcessApprovalInfoResp |
ApprovalInfo.process(ProcessApprovalInfoReq req,
RequestOptions reqOptions)
通知审批状态更新，对于只使用飞书考勤系统而未使用飞书审批系统的企业，可以通过该接口更新写入飞书考勤系统中的三方系统审批状态，例如请假、加班、外出、出差、补卡等审批，状态包括通过、不通过、撤销等。
|
|
QueryShiftResp |
Shift.query(QueryShiftReq req,
RequestOptions reqOptions)
|
QueryUserDailyShiftResp |
UserDailyShift.query(QueryUserDailyShiftReq req,
RequestOptions reqOptions)
查询班表信息，支持查询多个用户的排班情况，注意此接口返回的是用户维度的排班结果，与页面功能并不对应。
|
QueryUserFlowResp |
UserFlow.query(QueryUserFlowReq req,
RequestOptions reqOptions)
批量查询打卡流水，通过用户 ID 获取用户的打卡流水记录。
|
QueryUserSettingResp |
UserSetting.query(QueryUserSettingReq req,
RequestOptions reqOptions)
批量查询用户人脸识别信息，批量查询授权内员工的用户设置信息，包括人脸照片文件
ID、人脸照片更新时间。
|
QueryUserStatsDataResp |
UserStatsData.query(QueryUserStatsDataReq req,
RequestOptions reqOptions)
查询统计数据，查询日度统计或月度统计的统计数据。
|
QueryUserStatsFieldResp |
UserStatsField.query(QueryUserStatsFieldReq req,
RequestOptions reqOptions)
查询统计表头，查询考勤统计支持的日度统计或月度统计的统计表头。
|
QueryUserStatsViewResp |
UserStatsView.query(QueryUserStatsViewReq req,
RequestOptions reqOptions)
查询统计设置，查询考勤统计支持的日度统计或月度统计的统计表头。
|
QueryUserTaskRemedyResp |
UserTaskRemedy.query(QueryUserTaskRemedyReq req,
RequestOptions reqOptions)
获取补卡记录，补卡：用户通过审批的方式，在某一次上/下班的打卡时间范围内，补充一条打卡记录，用以修正用户的考勤结果。
|
QueryUserTaskResp |
UserTask.query(QueryUserTaskReq req,
RequestOptions reqOptions)
查询打卡结果，获取企业内员工的实际打卡结果，包括： * 打卡任务列表 * 打卡记录id * 用户信息 * 考勤组ID * 班次 ID * 考勤记录 * 上班记录 * 下班记录 *
上班打卡结果 * 下班打卡结果 * 上班打卡结果补充 * 下班打卡结果补充 * 上班打卡时间 * 下班打卡时间 * 无效用户 ID 列表 * 没有权限用户ID列表
- 如果企业给一个员工设定的班次是上午 9 点和下午 6 点各打一次上下班卡，即使员工在这期间打了多次卡，该接口也只会返回 1 条记录。
|
QueryUserAllowedRemedysUserTaskRemedyResp |
UserTaskRemedy.queryUserAllowedRemedys(QueryUserAllowedRemedysUserTaskRemedyReq req,
RequestOptions reqOptions)
获取可补卡时间，获取用户某天可以补的第几次上 / 下班卡的时间。
|
SearchGroupResp |
Group.search(SearchGroupReq req,
RequestOptions reqOptions)
按名称查询考勤组，按考勤组名称查询考勤组摘要信息。
|
UpdateUserStatsViewResp |
UserStatsView.update(UpdateUserStatsViewReq req,
RequestOptions reqOptions)
更新统计设置，更新开发者定制的日度统计或月度统计的统计报表表头设置信息。
|
UploadFileResp |
File.upload(UploadFileReq req,
RequestOptions reqOptions)
|
UserStatsFieldsQueryArchiveRuleResp |
ArchiveRule.userStatsFieldsQuery(UserStatsFieldsQueryArchiveRuleReq req,
RequestOptions reqOptions)
查询归档报表表头，查询归档报表表头，对应后台假勤管理-考勤统计-报表-[归档报表](https://example.feishu.cn/people/workforce-management/manage/statistics/report)中一个归档报表的表头信息。
|
参数类型为RequestOptions的com.lark.oapi.service.baike.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateDraftResp |
Draft.create(CreateDraftReq req,
RequestOptions reqOptions)
创建草稿，草稿并非词条，而是指通过 API 发起创建新词条或更新现有词条的申请。
|
CreateEntityResp |
Entity.create(CreateEntityReq req,
RequestOptions reqOptions)
创建免审词条，通过此接口创建的词条，无需经过词典管理员审核，直接写入词库。
|
DownloadFileResp |
File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载图片，通过 file_token 下载原图片。
|
ExtractEntityResp |
Entity.extract(ExtractEntityReq req,
RequestOptions reqOptions)
提取潜在的词条，提取文本中可能成为词条的词语，且不会过滤已经成为词条的词语。
|
GetEntityResp |
Entity.get(GetEntityReq req,
RequestOptions reqOptions)
获取词条详情，通过词条 id 拉取对应的词条详情信息。
|
HighlightEntityResp |
Entity.highlight(HighlightEntityReq req,
RequestOptions reqOptions)
词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现词条智能高亮。
|
ListClassificationResp |
Classification.list(ListClassificationReq req,
RequestOptions reqOptions)
获取词典分类，获取飞书词典当前分类。
|
ListEntityResp |
Entity.list(ListEntityReq req,
RequestOptions reqOptions)
获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。
|
MatchEntityResp |
Entity.match(MatchEntityReq req,
RequestOptions reqOptions)
精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。
|
SearchEntityResp |
Entity.search(SearchEntityReq req,
RequestOptions reqOptions)
模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。
|
UpdateDraftResp |
Draft.update(UpdateDraftReq req,
RequestOptions reqOptions)
更新草稿，根据 draft_id 更新草稿内容，已审批的草稿无法编辑。
|
UpdateEntityResp |
Entity.update(UpdateEntityReq req,
RequestOptions reqOptions)
更新免审词条，通过此接口更新已有的词条，无需经过词典管理员审核，直接写入词库。
|
UploadFileResp |
File.upload(UploadFileReq req,
RequestOptions reqOptions)
上传图片，词条图片资源上传。
|
参数类型为RequestOptions的com.lark.oapi.service.bitable.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchCreateAppRoleMemberResp |
AppRoleMember.batchCreate(BatchCreateAppRoleMemberReq req,
RequestOptions reqOptions)
批量新增协作者，批量新增多维表格高级权限中自定义角色的协作者。
|
BatchCreateAppTableRecordResp |
AppTableRecord.batchCreate(BatchCreateAppTableRecordReq req,
RequestOptions reqOptions)
新增多条记录，在多维表格数据表中新增多条记录，单次调用最多新增 1,000 条记录。
|
BatchCreateAppTableResp |
AppTable.batchCreate(BatchCreateAppTableReq req,
RequestOptions reqOptions)
新增多个数据表，新增多个数据表，仅可指定数据表名称。
|
BatchDeleteAppRoleMemberResp |
AppRoleMember.batchDelete(BatchDeleteAppRoleMemberReq req,
RequestOptions reqOptions)
批量删除协作者，删除多维表格高级权限中自定义角色的协作者。
|
BatchDeleteAppTableRecordResp |
AppTableRecord.batchDelete(BatchDeleteAppTableRecordReq req,
RequestOptions reqOptions)
删除多条记录，删除多维表格数据表中现有的多条记录。
|
BatchDeleteAppTableResp |
AppTable.batchDelete(BatchDeleteAppTableReq req,
RequestOptions reqOptions)
删除多个数据表，通过 app_token 和 table_id 删除多个数据表。
|
BatchGetAppTableRecordResp |
AppTableRecord.batchGet(BatchGetAppTableRecordReq req,
RequestOptions reqOptions)
批量获取记录，通过多个记录 ID 查询记录信息。
|
BatchUpdateAppTableRecordResp |
AppTableRecord.batchUpdate(BatchUpdateAppTableRecordReq req,
RequestOptions reqOptions)
更新多条记录，更新数据表中的多条记录，单次调用最多更新 1,000 条记录。
|
CopyAppDashboardResp |
AppDashboard.copy(CopyAppDashboardReq req,
RequestOptions reqOptions)
复制仪表盘，基于现有仪表盘复制出新的仪表盘。
|
CopyAppResp |
App.copy(CopyAppReq req,
RequestOptions reqOptions)
复制多维表格，复制一个多维表格，可以指定复制到某个有权限的文件夹下。
|
CreateAppResp |
App.create(CreateAppReq req,
RequestOptions reqOptions)
创建多维表格，在指定文件夹中创建一个多维表格，包含一个空白的数据表。
|
CreateAppRoleMemberResp |
AppRoleMember.create(CreateAppRoleMemberReq req,
RequestOptions reqOptions)
新增协作者，新增多维表格高级权限中自定义角色的协作者。
|
CreateAppRoleResp |
AppRole.create(CreateAppRoleReq req,
RequestOptions reqOptions)
新增自定义角色，新增多维表格高级权限中自定义的角色。
|
CreateAppTableFieldGroupResp |
AppTableFieldGroup.create(CreateAppTableFieldGroupReq req,
RequestOptions reqOptions)
创建字段编组，该接口用于为多维表格数据表的字段创建编组。
|
CreateAppTableFieldResp |
AppTableField.create(CreateAppTableFieldReq req,
RequestOptions reqOptions)
新增字段，在多维表格数据表中新增一个字段。
|
CreateAppTableRecordResp |
AppTableRecord.create(CreateAppTableRecordReq req,
RequestOptions reqOptions)
新增记录，在多维表格数据表中新增一条记录。
|
CreateAppTableResp |
AppTable.create(CreateAppTableReq req,
RequestOptions reqOptions)
新增一个数据表，新增一个数据表，支持传入数据表名称、视图名称和字段。
|
CreateAppTableViewResp |
AppTableView.create(CreateAppTableViewReq req,
RequestOptions reqOptions)
新增视图，在多维表格数据表中新增一个视图，可指定视图类型，包括表格视图、看板视图、画册视图、甘特视图和表单视图。
|
DeleteAppRoleMemberResp |
AppRoleMember.delete(DeleteAppRoleMemberReq req,
RequestOptions reqOptions)
删除协作者，删除多维表格高级权限中自定义角色的协作者。
|
DeleteAppRoleResp |
AppRole.delete(DeleteAppRoleReq req,
RequestOptions reqOptions)
删除自定义角色，删除多维表格高级权限中自定义的角色。
|
DeleteAppTableFieldResp |
AppTableField.delete(DeleteAppTableFieldReq req,
RequestOptions reqOptions)
删除字段，删除多维表格数据表中的一个字段。
|
DeleteAppTableRecordResp |
AppTableRecord.delete(DeleteAppTableRecordReq req,
RequestOptions reqOptions)
删除记录，删除多维表格数据表中的一条记录。
|
DeleteAppTableResp |
AppTable.delete(DeleteAppTableReq req,
RequestOptions reqOptions)
删除一个数据表，通过 app_token 和 table_id 删除指定的多维表格数据表。
|
DeleteAppTableViewResp |
AppTableView.delete(DeleteAppTableViewReq req,
RequestOptions reqOptions)
删除视图，通过 app_token、table_id 和 view_id，删除多维表格数据表中的指定视图。
|
GetAppResp |
App.get(GetAppReq req,
RequestOptions reqOptions)
获取多维表格元数据，获取指定多维表格的元数据信息，包括多维表格名称、多维表格版本号、多维表格是否开启高级权限等。
|
GetAppTableFormResp |
AppTableForm.get(GetAppTableFormReq req,
RequestOptions reqOptions)
获取表单元数据，获取表单的所有元数据，包括表单名称、描述、是否共享等。
|
GetAppTableRecordResp |
AppTableRecord.get(GetAppTableRecordReq req,
RequestOptions reqOptions)
检索记录，该接口用于根据 record_id 的值检索现有记录。
|
GetAppTableViewResp |
AppTableView.get(GetAppTableViewReq req,
RequestOptions reqOptions)
获取视图，根据视图 ID 获取现有视图信息，包括视图名称、类型、属性等。
|
ListAppBlockWorkflowResp |
AppBlockWorkflow.list(ListAppBlockWorkflowReq req,
RequestOptions reqOptions)
|
ListAppRoleMemberResp |
AppRoleMember.list(ListAppRoleMemberReq req,
RequestOptions reqOptions)
列出协作者，列出多维表格高级权限中自定义角色的协作者。
|
ListAppRoleResp |
AppRole.list(ListAppRoleReq req,
RequestOptions reqOptions)
列出自定义角色，列出多维表格高级权限中用户自定义的角色。
|
ListAppTableFieldResp |
AppTableField.list(ListAppTableFieldReq req,
RequestOptions reqOptions)
列出字段，获取多维表格数据表中的的所有字段。
|
ListAppTableFormFieldResp |
AppTableFormField.list(ListAppTableFormFieldReq req,
RequestOptions reqOptions)
列出表单问题，列出表单中的所有问题项。
|
ListAppTableRecordResp |
AppTableRecord.list(ListAppTableRecordReq req,
RequestOptions reqOptions)
列出记录，该接口用于列出数据表中的现有记录，单次最多列出 500 行记录，支持分页获取。
|
ListAppTableResp |
AppTable.list(ListAppTableReq req,
RequestOptions reqOptions)
列出数据表，列出多维表格中的所有数据表，包括其 ID、版本号和名称。
|
ListAppTableViewResp |
AppTableView.list(ListAppTableViewReq req,
RequestOptions reqOptions)
列出视图，获取多维表格数据表中的所有视图。
|
ListAppWorkflowResp |
AppWorkflow.list(ListAppWorkflowReq req,
RequestOptions reqOptions)
列出自动化流程，该接口用于列出多维表格的自动化流程。
|
PatchAppTableFormFieldResp |
AppTableFormField.patch(PatchAppTableFormFieldReq req,
RequestOptions reqOptions)
更新表单问题，更新表单中的问题项。
|
PatchAppTableFormResp |
AppTableForm.patch(PatchAppTableFormReq req,
RequestOptions reqOptions)
更新表单元数据，更新表单视图中的元数据，包括表单名称、描述、是否共享等。
|
PatchAppTableResp |
AppTable.patch(PatchAppTableReq req,
RequestOptions reqOptions)
更新数据表，更新数据表的名称。
|
PatchAppTableViewResp |
AppTableView.patch(PatchAppTableViewReq req,
RequestOptions reqOptions)
更新视图，增量更新视图信息，包括视图名称、属性等，可设置视图的筛选条件。
|
SearchAppTableRecordResp |
AppTableRecord.search(SearchAppTableRecordReq req,
RequestOptions reqOptions)
查询记录，该接口用于查询数据表中的现有记录，单次最多查询 500 行记录，支持分页获取。
|
UpdateAppResp |
App.update(UpdateAppReq req,
RequestOptions reqOptions)
更新多维表格元数据，更新多维表格元数据，包括多维表格的名称、是否开启高级权限。
|
UpdateAppRoleResp |
AppRole.update(UpdateAppRoleReq req,
RequestOptions reqOptions)
更新自定义角色，更新多维表格高级权限中自定义的角色。
|
UpdateAppTableFieldResp |
AppTableField.update(UpdateAppTableFieldReq req,
RequestOptions reqOptions)
更新字段，在多维表格数据表中更新一个字段。
|
UpdateAppTableRecordResp |
AppTableRecord.update(UpdateAppTableRecordReq req,
RequestOptions reqOptions)
更新记录，更新多维表格数据表中的一条记录。
|
UpdateAppWorkflowResp |
AppWorkflow.update(UpdateAppWorkflowReq req,
RequestOptions reqOptions)
更新自动化流程状态，开启或关闭自动化流程。
|
UpgradeAppTableFormResp |
AppTableForm.upgrade(UpgradeAppTableFormReq req,
RequestOptions reqOptions)
升级旧版表单，升级旧版表单至收集表
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.calendar.v4.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchFreebusyResp |
Freebusy.batch(BatchFreebusyReq req,
RequestOptions reqOptions)
批量查询主日历日程忙闲信息，根据user id列表，批量查询指定用户的主日历在指定时间段内的忙碌时间段信息，适用于团队协作中，快速了解成员忙闲状态以安排会议或任务的场景。
|
BatchDeleteCalendarEventAttendeeResp |
CalendarEventAttendee.batchDelete(BatchDeleteCalendarEventAttendeeReq req,
RequestOptions reqOptions)
删除日程参与人，调用该接口以当前身份（应用或用户）删除指定日程的一个或多个参与人。
|
CreateCalendarAclResp |
CalendarAcl.create(CreateCalendarAclReq req,
RequestOptions reqOptions)
创建访问控制，调用该接口以当前身份（应用或用户）为指定日历添加访问控制，即日历成员权限。
|
CreateCalendarEventAttendeeResp |
CalendarEventAttendee.create(CreateCalendarEventAttendeeReq req,
RequestOptions reqOptions)
添加日程参与人，调用该接口以当前身份（应用或用户）为指定日程添加一个或多个参与人，参与人类型包括用户、群组、会议室以及邮箱。
|
CreateCalendarEventMeetingChatResp |
CalendarEventMeetingChat.create(CreateCalendarEventMeetingChatReq req,
RequestOptions reqOptions)
创建会议群，调用该接口以当前身份（应用或用户）为指定日程创建一个会议群。
|
CreateCalendarEventMeetingMinuteResp |
CalendarEventMeetingMinute.create(CreateCalendarEventMeetingMinuteReq req,
RequestOptions reqOptions)
创建会议纪要，调用该接口为指定的日程创建会议纪要。
|
CreateCalendarEventResp |
CalendarEvent.create(CreateCalendarEventReq req,
RequestOptions reqOptions)
创建日程，调用该接口以当前身份（应用或用户）在指定日历上创建一个日程。
|
CreateCalendarResp |
Calendar.create(CreateCalendarReq req,
RequestOptions reqOptions)
创建共享日历，调用该接口为当前身份（应用或用户）创建一个共享日历。
|
CreateExchangeBindingResp |
ExchangeBinding.create(CreateExchangeBindingReq req,
RequestOptions reqOptions)
将 Exchange 账户绑定到飞书账户，调用该接口将 Exchange 账户绑定到飞书账户，进而支持 Exchange 日历的导入。
|
CreateTimeoffEventResp |
TimeoffEvent.create(CreateTimeoffEventReq req,
RequestOptions reqOptions)
创建请假日程，调用该接口为指定用户创建一个请假日程。
|
DeleteCalendarAclResp |
CalendarAcl.delete(DeleteCalendarAclReq req,
RequestOptions reqOptions)
删除访问控制，调用该接口以当前身份（应用或用户）删除指定日历内的某一访问控制，即成员权限。
|
DeleteCalendarEventMeetingChatResp |
CalendarEventMeetingChat.delete(DeleteCalendarEventMeetingChatReq req,
RequestOptions reqOptions)
解绑会议群，调用该接口以当前身份（应用或用户）为日程解绑已创建的会议群。
|
DeleteCalendarEventResp |
CalendarEvent.delete(DeleteCalendarEventReq req,
RequestOptions reqOptions)
删除日程，调用该接口以当前身份（应用或用户）删除指定日历上的一个日程。
|
DeleteCalendarResp |
Calendar.delete(DeleteCalendarReq req,
RequestOptions reqOptions)
删除共享日历，调用该接口以当前身份（应用或用户）删除某一指定的共享日历。
|
DeleteExchangeBindingResp |
ExchangeBinding.delete(DeleteExchangeBindingReq req,
RequestOptions reqOptions)
解除 Exchange 账户绑定，调用该接口解除 Exchange 账户和飞书账户的绑定关系，Exchange 账户解除绑定后才能和其他飞书账户继续绑定。
|
DeleteTimeoffEventResp |
TimeoffEvent.delete(DeleteTimeoffEventReq req,
RequestOptions reqOptions)
删除请假日程，调用该接口删除一个指定的请假日程。
|
GenerateCaldavConfSettingResp |
Setting.generateCaldavConf(GenerateCaldavConfSettingReq req,
RequestOptions reqOptions)
生成 CalDAV 配置，调用该接口为当前用户生成一个 CalDAV 账号密码，用于将飞书日历信息同步到本地设备日历。
|
GetCalendarEventResp |
CalendarEvent.get(GetCalendarEventReq req,
RequestOptions reqOptions)
获取日程，调用该接口以当前身份（应用或用户）获取指定日历内的某一日程信息，包括日程的标题、时间段、视频会议信息、公开范围以及参与人权限等。
|
GetCalendarResp |
Calendar.get(GetCalendarReq req,
RequestOptions reqOptions)
查询日历信息，调用该接口以当前身份（应用或用户）查询指定日历的信息。
|
GetExchangeBindingResp |
ExchangeBinding.get(GetExchangeBindingReq req,
RequestOptions reqOptions)
查询 Exchange 账户的绑定状态，调用该接口获取 Exchange 账户的绑定状态，包括 Exchange 日历的同步状态。
|
InstancesCalendarEventResp |
CalendarEvent.instances(InstancesCalendarEventReq req,
RequestOptions reqOptions)
获取重复日程实例，调用该接口以当前身份（应用或用户）获取指定日历中的某一重复日程信息。
|
InstanceViewCalendarEventResp |
CalendarEvent.instanceView(InstanceViewCalendarEventReq req,
RequestOptions reqOptions)
查询日程视图，调用该接口以用户身份查询指定日历下的日程视图。
|
ListCalendarAclResp |
CalendarAcl.list(ListCalendarAclReq req,
RequestOptions reqOptions)
获取访问控制列表，调用该接口以当前身份（应用或用户）获取指定日历的访问控制列表。
|
ListCalendarEventAttendeeChatMemberResp |
CalendarEventAttendeeChatMember.list(ListCalendarEventAttendeeChatMemberReq req,
RequestOptions reqOptions)
获取日程参与群成员列表，调用该接口以当前身份（应用或用户）获取日程的群组类型参与人的群成员列表。
|
ListCalendarEventAttendeeResp |
CalendarEventAttendee.list(ListCalendarEventAttendeeReq req,
RequestOptions reqOptions)
获取日程参与人列表，调用该接口以当前身份（应用或用户）获取日程的参与人列表。
|
ListCalendarEventResp |
CalendarEvent.list(ListCalendarEventReq req,
RequestOptions reqOptions)
获取日程列表，调用该接口以当前身份（应用或用户）获取指定日历下的日程列表。
|
ListCalendarResp |
Calendar.list(ListCalendarReq req,
RequestOptions reqOptions)
查询日历列表，调用该接口分页查询当前身份（应用或用户）的日历列表。
|
ListFreebusyResp |
Freebusy.list(ListFreebusyReq req,
RequestOptions reqOptions)
查询主日历日程忙闲信息，调用该接口查询指定用户的主日历忙闲信息，或者查询指定会议室的忙闲信息。
|
MgetCalendarResp |
Calendar.mget(MgetCalendarReq req,
RequestOptions reqOptions)
批量查询日历信息，调用该接口批量查询指定日历的标题、描述、公开范围等信息。
|
PatchCalendarEventResp |
CalendarEvent.patch(PatchCalendarEventReq req,
RequestOptions reqOptions)
更新日程，以当前身份（应用或用户）更新指定日历上的一个日程，包括日程标题、描述、开始与结束时间、视频会议以及日程地点等信息。
|
PatchCalendarResp |
Calendar.patch(PatchCalendarReq req,
RequestOptions reqOptions)
更新日历信息，调用该接口以当前身份（应用或用户）修改指定日历的标题、描述、公开范围等信息。
|
PrimaryCalendarResp |
Calendar.primary(PrimaryCalendarReq req,
RequestOptions reqOptions)
查询主日历信息，调用该接口获取当前身份（应用或用户）的主日历信息。
|
PrimarysCalendarResp |
Calendar.primarys(PrimarysCalendarReq req,
RequestOptions reqOptions)
批量获取主日历信息，根据user id列表批量查询指定用户的主日历信息。
|
ReplyCalendarEventResp |
CalendarEvent.reply(ReplyCalendarEventReq req,
RequestOptions reqOptions)
回复日程，调用该接口以当前身份（应用或用户）回复日程。
|
SearchCalendarEventResp |
CalendarEvent.search(SearchCalendarEventReq req,
RequestOptions reqOptions)
搜索日程，调用该接口搜索指定日历下的相关日程，支持关键词搜索、过滤条件搜索。
|
SearchCalendarResp |
Calendar.search(SearchCalendarReq req,
RequestOptions reqOptions)
搜索日历，调用该接口通过关键字搜索日历，搜索结果为标题或描述包含关键字的公共日历或用户主日历。
|
SubscribeCalendarResp |
Calendar.subscribe(SubscribeCalendarReq req,
RequestOptions reqOptions)
订阅日历，调用该接口以当前身份（应用或用户）订阅指定的日历。
|
SubscriptionCalendarResp |
Calendar.subscription(RequestOptions reqOptions)
订阅日历变更事件，调用该接口为当前用户身份订阅[日历变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/events/changed)。
|
SubscriptionCalendarAclResp |
CalendarAcl.subscription(SubscriptionCalendarAclReq req,
RequestOptions reqOptions)
订阅日历访问控制变更事件;，调用该接口以用户身份订阅指定日历下的访问控制变更事件。
|
SubscriptionCalendarEventResp |
CalendarEvent.subscription(SubscriptionCalendarEventReq req,
RequestOptions reqOptions)
订阅日程变更事件，调用该接口以用户身份订阅指定日历下的日程变更事件。
|
UnsubscribeCalendarResp |
Calendar.unsubscribe(UnsubscribeCalendarReq req,
RequestOptions reqOptions)
取消订阅日历，调用该接口以当前身份（应用或用户）取消指定日历的订阅状态。
|
UnsubscriptionCalendarResp |
Calendar.unsubscription(RequestOptions reqOptions)
取消订阅日历变更事件，调用该接口为当前用户身份取消订阅[日历变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/events/changed)。
|
UnsubscriptionCalendarAclResp |
CalendarAcl.unsubscription(UnsubscriptionCalendarAclReq req,
RequestOptions reqOptions)
取消订阅日历访问控制变更事件，调用该接口以用户身份取消订阅指定日历下的访问控制变更事件。
|
UnsubscriptionCalendarEventResp |
CalendarEvent.unsubscription(UnsubscriptionCalendarEventReq req,
RequestOptions reqOptions)
取消订阅日程变更事件，调用该接口以用户身份取消订阅指定日历下的日程变更事件。
|
参数类型为RequestOptions的com.lark.oapi.service.cardkit.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchUpdateCardResp |
Card.batchUpdate(BatchUpdateCardReq req,
RequestOptions reqOptions)
局部更新卡片实体，更新卡片实体局部内容，包括配置和组件。
|
ContentCardElementResp |
CardElement.content(ContentCardElementReq req,
RequestOptions reqOptions)
流式更新文本，对卡片中的普通文本元素（tag 为 plain_text 的元素）或富文本组件（tag 为 markdown 的组件）传入全量文本内容，以实现“打字机”式的文字输出效果。
|
CreateCardElementResp |
CardElement.create(CreateCardElementReq req,
RequestOptions reqOptions)
新增组件，为指定卡片实体新增组件，以扩展卡片内容，如在卡片中添加一个点击按钮。
|
CreateCardResp |
Card.create(CreateCardReq req,
RequestOptions reqOptions)
创建卡片实体，基于卡片 JSON 代码或卡片搭建工具搭建的卡片，创建卡片实体。
|
DeleteCardElementResp |
CardElement.delete(DeleteCardElementReq req,
RequestOptions reqOptions)
删除组件，删除指定卡片实体中的组件。
|
IdConvertCardResp |
Card.idConvert(IdConvertCardReq req,
RequestOptions reqOptions)
转换 ID，将[消息
ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/intro#44c58e1c)（
`message_id` ）转换为卡片实体
ID（`card_id`）。
|
PatchCardElementResp |
CardElement.patch(PatchCardElementReq req,
RequestOptions reqOptions)
更新组件属性，通过传入 `card_id`（卡片实体 ID）和 `element_id`（组件 ID），更新卡片实体中对应组件的属性。
|
SettingsCardResp |
Card.settings(SettingsCardReq req,
RequestOptions reqOptions)
更新卡片配置，更新指定卡片实体的配置，支持卡片配置 `config` 字段和卡片跳转链接 `card_link` 字段。
|
UpdateCardElementResp |
CardElement.update(UpdateCardElementReq req,
RequestOptions reqOptions)
更新组件，更新卡片实体中的指定组件为新组件。
|
UpdateCardResp |
Card.update(UpdateCardReq req,
RequestOptions reqOptions)
全量更新卡片实体，传入新的卡片 JSON 代码，覆盖更新指定的卡片实体的所有内容。
|
参数类型为RequestOptions的com.lark.oapi.service.compensation.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchCreateLumpSumPaymentResp |
LumpSumPayment.batchCreate(BatchCreateLumpSumPaymentReq req,
RequestOptions reqOptions)
|
BatchUpdateRecurringPaymentResp |
RecurringPayment.batchUpdate(BatchUpdateRecurringPaymentReq req,
RequestOptions reqOptions)
|
ListChangeReasonResp |
ChangeReason.list(ListChangeReasonReq req,
RequestOptions reqOptions)
|
QueryArchiveResp |
Archive.query(QueryArchiveReq req,
RequestOptions reqOptions)
批量查询员工薪资档案，批量查询员工薪资档案
该接口会按照应用拥有的「薪资档案资源」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限」中已申请「薪资档案资源」权限范围 ;
官网API文档链接:
QueryLumpSumPaymentResp |
LumpSumPayment.query(QueryLumpSumPaymentReq req,
RequestOptions reqOptions)
查询一次性支付授予记录，根据筛选条件查询一次性支付授予记录
请求体中的多个筛选项为”且“的关系 ;
官网API文档链接:
QueryRecurringPaymentResp |
RecurringPayment.query(QueryRecurringPaymentReq req,
RequestOptions reqOptions)
查询经常性支付记录，通过筛选条件，批量查询经常性支付记录
官网API文档链接:
QuerySocialArchiveAdjustRecordResp |
SocialArchiveAdjustRecord.query(QuerySocialArchiveAdjustRecordReq req,
RequestOptions reqOptions)
批量获取社保增减员记录，通过员工ID批量获取社保增减员记录;
官网API文档链接:
QuerySocialArchiveResp |
SocialArchive.query(QuerySocialArchiveReq req,
RequestOptions reqOptions)
批量获取员工参保档案，通过用户ID列表和生效日期查询
官网API文档链接:
QuerySocialPlanResp |
SocialPlan.query(QuerySocialPlanReq req,
RequestOptions reqOptions)
根据方案ID和生效日期批量查询参保方案;，通过plan_ids列表和effective_date联合过滤数据库中的参保方案数据
官网API文档链接:
QueryDetailLumpSumPaymentResp |
LumpSumPayment.queryDetail(QueryDetailLumpSumPaymentReq req,
RequestOptions reqOptions)
查询一次性授予明细，根据筛选条件查询一次性授予明细
一条一次性支付授予记录可能会存在多条明细，明细与记录之间通过其他薪酬记录id关联在一起，查询一次性授予记录接口也会返回授予明细 ;
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.contact.v3.resource中的方法
| 限定符和类型 |
方法和说明 |
AddGroupMemberResp |
GroupMember.add(AddGroupMemberReq req,
RequestOptions reqOptions)
添加用户组成员，调用该接口向指定的普通用户组内添加成员。
|
BasicBatchUserResp |
User.basicBatch(BasicBatchUserReq req,
RequestOptions reqOptions)
获取用户姓名，根据用户 ID 获取用户姓名，仅返回核心信息（姓名），不含扩展字段及敏感信息。
|
BatchDepartmentResp |
Department.batch(BatchDepartmentReq req,
RequestOptions reqOptions)
批量获取部门信息，调用该接口获取一个或多个部门的信息，包括部门名称、ID、父部门、负责人、状态以及成员个数等。
|
BatchUserResp |
User.batch(BatchUserReq req,
RequestOptions reqOptions)
批量获取用户信息，调用该接口获取通讯录内一个或多个用户的信息，包括用户 ID、名称、邮箱、手机号、状态以及所属部门等信息。
|
BatchAddGroupMemberResp |
GroupMember.batchAdd(BatchAddGroupMemberReq req,
RequestOptions reqOptions)
批量添加用户组成员，调用该接口向指定的普通用户组内添加一个或多个成员。
|
BatchCreateFunctionalRoleMemberResp |
FunctionalRoleMember.batchCreate(BatchCreateFunctionalRoleMemberReq req,
RequestOptions reqOptions)
批量添加角色成员，调用该接口在指定角色内添加一个或多个成员。
|
BatchDeleteFunctionalRoleMemberResp |
FunctionalRoleMember.batchDelete(BatchDeleteFunctionalRoleMemberReq req,
RequestOptions reqOptions)
删除角色下的成员，调用该接口在指定角色内删除一个或多个成员。
|
BatchGetIdUserResp |
User.batchGetId(BatchGetIdUserReq req,
RequestOptions reqOptions)
通过手机号或邮箱获取用户 ID，调用该接口通过手机号或邮箱获取一个或多个用户的 ID （包括 user_id、open_id、union_id）与状态信息。
|
BatchRemoveGroupMemberResp |
GroupMember.batchRemove(BatchRemoveGroupMemberReq req,
RequestOptions reqOptions)
批量移除用户组成员，调用该接口从指定普通用户组内移除一个或多个成员。
|
BindDepartmentUnitResp |
Unit.bindDepartment(BindDepartmentUnitReq req,
RequestOptions reqOptions)
建立部门与单位的绑定关系，调用该接口建立部门与单位的绑定关系。
|
ChildrenDepartmentResp |
Department.children(ChildrenDepartmentReq req,
RequestOptions reqOptions)
获取子部门列表，调用该接口查询指定部门下的子部门列表，列表内包含部门的名称、ID、父部门、负责人以及状态等信息。
|
CreateDepartmentResp |
Department.create(CreateDepartmentReq req,
RequestOptions reqOptions)
创建部门，调用该接口在通讯录内创建一个部门。
|
CreateEmployeeTypeEnumResp |
EmployeeTypeEnum.create(CreateEmployeeTypeEnumReq req,
RequestOptions reqOptions)
新增人员类型，调用该接口新增一个自定义的人员类型。
|
CreateFunctionalRoleResp |
FunctionalRole.create(CreateFunctionalRoleReq req,
RequestOptions reqOptions)
创建角色，调用该接口创建一个角色。
|
CreateGroupResp |
Group.create(CreateGroupReq req,
RequestOptions reqOptions)
创建用户组，调用该接口创建一个用户组。
|
CreateJobFamilyResp |
JobFamily.create(CreateJobFamilyReq req,
RequestOptions reqOptions)
创建序列，调用该接口创建一个序列。
|
CreateJobLevelResp |
JobLevel.create(CreateJobLevelReq req,
RequestOptions reqOptions)
创建职级，调用该接口创建一个职级。
|
CreateUnitResp |
Unit.create(CreateUnitReq req,
RequestOptions reqOptions)
创建单位，调用该接口创建一个单位。
|
CreateUserResp |
User.create(CreateUserReq req,
RequestOptions reqOptions)
创建用户，调用该接口向通讯录创建一个用户（该动作可以理解为员工入职）。
|
DeleteDepartmentResp |
Department.delete(DeleteDepartmentReq req,
RequestOptions reqOptions)
删除部门，调用该接口从通讯录中删除指定的部门。
|
DeleteEmployeeTypeEnumResp |
EmployeeTypeEnum.delete(DeleteEmployeeTypeEnumReq req,
RequestOptions reqOptions)
删除人员类型，调用该接口删除指定的自定义人员类型。
|
DeleteFunctionalRoleResp |
FunctionalRole.delete(DeleteFunctionalRoleReq req,
RequestOptions reqOptions)
删除角色，调用该接口删除指定角色。
|
DeleteGroupResp |
Group.delete(DeleteGroupReq req,
RequestOptions reqOptions)
删除用户组，调用该接口删除指定用户组。
|
DeleteJobFamilyResp |
JobFamily.delete(DeleteJobFamilyReq req,
RequestOptions reqOptions)
删除序列，调用该接口删除指定序列。
|
DeleteJobLevelResp |
JobLevel.delete(DeleteJobLevelReq req,
RequestOptions reqOptions)
删除职级，调用该接口删除指定的职级。
|
DeleteUnitResp |
Unit.delete(DeleteUnitReq req,
RequestOptions reqOptions)
删除单位，调用该接口删除指定单位。
|
DeleteUserResp |
User.delete(DeleteUserReq req,
RequestOptions reqOptions)
删除用户，调用该接口从通讯录内删除一个指定用户（该动作可以理解为员工离职），删除时可通过请求参数将用户所有的群组、文档、日程和应用等数据转让至他人。
|
FindByDepartmentUserResp |
User.findByDepartment(FindByDepartmentUserReq req,
RequestOptions reqOptions)
获取部门直属用户列表，调用该接口获取指定部门直属的用户信息列表。
|
GetDepartmentResp |
Department.get(GetDepartmentReq req,
RequestOptions reqOptions)
获取单个部门信息，调用该接口获取单个部门信息，包括部门名称、ID、父部门、负责人、状态以及成员个数等。
|
GetFunctionalRoleMemberResp |
FunctionalRoleMember.get(GetFunctionalRoleMemberReq req,
RequestOptions reqOptions)
查询角色下某个成员的管理范围，调用本接口查询指定角色内的指定成员的管理范围。
|
GetGroupResp |
Group.get(GetGroupReq req,
RequestOptions reqOptions)
查询指定用户组，调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。
|
GetJobFamilyResp |
JobFamily.get(GetJobFamilyReq req,
RequestOptions reqOptions)
获取单个序列信息，调用该接口获取指定序列的信息，包括序列的名称、描述、启用状态以及 ID 等。
|
GetJobLevelResp |
JobLevel.get(GetJobLevelReq req,
RequestOptions reqOptions)
获取单个职级信息，调用该接口获取指定职级的信息，包括职级名称、描述、排序、状态以及多语言等。
|
GetJobTitleResp |
JobTitle.get(GetJobTitleReq req,
RequestOptions reqOptions)
获取单个职务信息，调用该接口获取指定职务的信息，包括职务的 ID、名称、多语言名称以及启用状态。
|
GetUnitResp |
Unit.get(GetUnitReq req,
RequestOptions reqOptions)
获取单位信息，调用该接口获取指定单位的信息，包括单位 ID、名字、类型。
|
GetUserResp |
User.get(GetUserReq req,
RequestOptions reqOptions)
获取单个用户信息，调用该接口获取通讯录中某一用户的信息，包括用户 ID、名称、邮箱、手机号、状态以及所属部门等信息。
|
GetWorkCityResp |
WorkCity.get(GetWorkCityReq req,
RequestOptions reqOptions)
获取单个工作城市信息，调用该接口获取指定工作城市的信息，包括工作城市的 ID、名称、多语言名称以及启用状态。
|
ListCustomAttrResp |
CustomAttr.list(ListCustomAttrReq req,
RequestOptions reqOptions)
获取企业自定义用户字段，调用该接口查询当前企业内自定义用户字段的配置信息。
|
ListDepartmentResp |
Department.list(ListDepartmentReq req,
RequestOptions reqOptions)
获取部门信息列表，该接口用于获取当前部门子部门列表。
|
ListEmployeeTypeEnumResp |
EmployeeTypeEnum.list(ListEmployeeTypeEnumReq req,
RequestOptions reqOptions)
查询人员类型，调用该接口查询当前租户下所有的人员类型信息，包括选项 ID、类型、编号以及内容等。
|
ListFunctionalRoleMemberResp |
FunctionalRoleMember.list(ListFunctionalRoleMemberReq req,
RequestOptions reqOptions)
查询角色下的所有成员信息，调用本接口查询指定角色内的所有成员信息，包括成员的用户 ID、管理范围。
|
ListJobFamilyResp |
JobFamily.list(ListJobFamilyReq req,
RequestOptions reqOptions)
获取租户序列列表，调用该接口获取当前租户下的序列信息，包含序列的名称、描述、启用状态以及 ID 等。
|
ListJobLevelResp |
JobLevel.list(ListJobLevelReq req,
RequestOptions reqOptions)
获取租户职级列表，调用该接口获取当前租户下的职级信息，包括职级名称、描述、排序、状态以及多语言等。
|
ListJobTitleResp |
JobTitle.list(ListJobTitleReq req,
RequestOptions reqOptions)
获取租户职务列表，调用该接口获取当前租户下的职务信息，包括职务的 ID、名称、多语言名称以及启用状态。
|
ListScopeResp |
Scope.list(ListScopeReq req,
RequestOptions reqOptions)
获取通讯录授权范围，调用该接口获取当前应用被授权可访问的通讯录范围，包括可访问的部门列表、用户列表和用户组列表。
|
ListUnitResp |
Unit.list(ListUnitReq req,
RequestOptions reqOptions)
获取单位列表，调用该接口获取当前租户内的单位列表。
|
ListUserResp |
User.list(ListUserReq req,
RequestOptions reqOptions)
获取用户列表，基于部门ID获取部门下直属用户列表。
|
ListWorkCityResp |
WorkCity.list(ListWorkCityReq req,
RequestOptions reqOptions)
获取租户工作城市列表，调用该接口获取当前租户下所有工作城市信息，包括工作城市的 ID、名称、多语言名称以及启用状态。
|
ListDepartmentUnitResp |
Unit.listDepartment(ListDepartmentUnitReq req,
RequestOptions reqOptions)
获取单位绑定的部门列表，调用该接口获取指定单位绑定的部门列表。
|
MemberBelongGroupResp |
Group.memberBelong(MemberBelongGroupReq req,
RequestOptions reqOptions)
查询用户所属用户组，调用该接口查询指定用户所属的用户组列表。
|
ParentDepartmentResp |
Department.parent(ParentDepartmentReq req,
RequestOptions reqOptions)
获取父部门信息，调用该接口递归获取指定部门的父部门信息，包括部门名称、ID、负责人以及状态等。
|
PatchDepartmentResp |
Department.patch(PatchDepartmentReq req,
RequestOptions reqOptions)
修改部门部分信息，调用该接口更新指定部门的部分信息，包括名称、父部门、排序以及负责人等。
|
PatchGroupResp |
Group.patch(PatchGroupReq req,
RequestOptions reqOptions)
更新用户组，调用该接口更新指定用户组的名称或描述。
|
PatchUnitResp |
Unit.patch(PatchUnitReq req,
RequestOptions reqOptions)
修改单位信息，调用该接口修改指定单位的名字。
|
PatchUserResp |
User.patch(PatchUserReq req,
RequestOptions reqOptions)
修改用户部分信息，调用该接口更新通讯录中指定用户的信息，包括名称、邮箱、手机号、所属部门以及自定义字段等信息。
|
RemoveGroupMemberResp |
GroupMember.remove(RemoveGroupMemberReq req,
RequestOptions reqOptions)
移除用户组成员，调用该接口移除指定普通用户组内的某一成员。
|
ResurrectUserResp |
User.resurrect(ResurrectUserReq req,
RequestOptions reqOptions)
恢复已删除用户，该接口用于恢复已删除用户（已离职的成员）。
|
ScopesFunctionalRoleMemberResp |
FunctionalRoleMember.scopes(ScopesFunctionalRoleMemberReq req,
RequestOptions reqOptions)
批量设置角色成员管理范围，调用该接口为指定角色内的一个或多个角色成员设置管理范围。
|
SearchDepartmentResp |
Department.search(SearchDepartmentReq req,
RequestOptions reqOptions)
搜索部门，调用该接口以用户身份通过部门名称关键词查询可见部门的信息，包括部门的 ID、父部门、负责人以及状态等。
|
SimplelistGroupMemberResp |
GroupMember.simplelist(SimplelistGroupMemberReq req,
RequestOptions reqOptions)
查询用户组成员列表，调用该接口查询指定用户组内的成员列表，列表内主要包括成员 ID 信息。
|
SimplelistGroupResp |
Group.simplelist(SimplelistGroupReq req,
RequestOptions reqOptions)
查询用户组列表，调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。
|
UnbindDepartmentUnitResp |
Unit.unbindDepartment(UnbindDepartmentUnitReq req,
RequestOptions reqOptions)
解除部门与单位的绑定关系，调用该接口解除部门与单位的绑定关系。
|
UnbindDepartmentChatDepartmentResp |
Department.unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req,
RequestOptions reqOptions)
部门群转为普通群，调用该接口将指定部门的部门群转为普通群。
|
UpdateDepartmentResp |
Department.update(UpdateDepartmentReq req,
RequestOptions reqOptions)
更新部门所有信息，调用该接口更新指定部门的信息，包括名称、父部门以及负责人等信息。
|
UpdateEmployeeTypeEnumResp |
EmployeeTypeEnum.update(UpdateEmployeeTypeEnumReq req,
RequestOptions reqOptions)
更新人员类型，调用该接口更新指定的自定义人员类型信息。
|
UpdateFunctionalRoleResp |
FunctionalRole.update(UpdateFunctionalRoleReq req,
RequestOptions reqOptions)
修改角色名称，调用本接口修改指定角色的角色名称。
|
UpdateJobFamilyResp |
JobFamily.update(UpdateJobFamilyReq req,
RequestOptions reqOptions)
更新序列，调用该接口更新指定序列的信息。
|
UpdateJobLevelResp |
JobLevel.update(UpdateJobLevelReq req,
RequestOptions reqOptions)
更新职级，调用该接口更新指定职级的信息。
|
UpdateUserResp |
User.update(UpdateUserReq req,
RequestOptions reqOptions)
更新用户所有信息，该接口用于更新通讯录中用户的字段。
|
UpdateDepartmentIdDepartmentResp |
Department.updateDepartmentId(UpdateDepartmentIdDepartmentReq req,
RequestOptions reqOptions)
更新部门ID，调用该接口可以更新部门的自定义 ID，即 department_id。
|
UpdateUserIdUserResp |
User.updateUserId(UpdateUserIdUserReq req,
RequestOptions reqOptions)
更新用户ID，调用该接口更新用户的 user_id。
|
参数类型为RequestOptions的com.lark.oapi.service.corehr.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AddEnumOptionCommonDataMetaDataResp |
CommonDataMetaData.addEnumOption(AddEnumOptionCommonDataMetaDataReq req,
RequestOptions reqOptions)
增加字段枚举值选项，对于当前已有的所有自定义枚举字段，以及部分系统预置枚举字段，通过本接口可在字段中批量新增可选项
本接口当前允许修改的系统预置字段如下：; - person（个人信息）：gender（性别）、marital_status（婚姻状态）; -
address（地址）：address_type（地址类型）; - national_id（证件）：national_id_type（证件类型）; -
education（教育经历）：degree（学位）、level_of_education（学历）; - person_info_chn (个人附加信息) ：
hukou_type（户口类型）; - emergency_contact（紧急联系人）：relationship（关系）; -
dependent（家庭成员）：relationship_with_dependent（关系）; - job_data （任职信息）：employee_type (人员类型); -
probation （试用期对象）：final_assessment_grade （试用期最终考核等级）; - department（部门）：subtype（部门类型） ;
官网API文档链接:
AddRoleAssignAuthorizationResp |
Authorization.addRoleAssign(AddRoleAssignAuthorizationReq req,
RequestOptions reqOptions)
为用户授权角色，为用户授权角色及管理范围 ;对已被授权某个角色的用户继续授权，将在原授权的数据范围基础上追加数据范围。
|
|
CalendarByScopeLeaveResp |
Leave.calendarByScope(CalendarByScopeLeaveReq req,
RequestOptions reqOptions)
根据适用条件获取工作日历 ID，根据日历的适用范围，获取工作日历 ID。
|
ConvertCommonDataIdResp |
CommonDataId.convert(ConvertCommonDataIdReq req,
RequestOptions reqOptions)
|
CreateDepartmentResp |
Department.create(CreateDepartmentReq req,
RequestOptions reqOptions)
创建部门，支持在单个接口中进行部门信息添加，包括部门基本信息、部门负责人、部门自定义字段信息等
此接口字段是否必填以【飞书人事-组织配置】为准。
|
CreateEmployeeTypeResp |
EmployeeType.create(CreateEmployeeTypeReq req,
RequestOptions reqOptions)
创建人员类型，创建人员类型。
|
CreateEmploymentResp |
Employment.create(CreateEmploymentReq req,
RequestOptions reqOptions)
创建雇佣信息，创建人员的雇佣信息，需要先[创建个人信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create)。
|
CreateJobChangeResp |
JobChange.create(CreateJobChangeReq req,
RequestOptions reqOptions)
发起员工异动（不推荐），该接口用于发起员工异动（变更员工雇佣信息），若发起成功，会生成一条员工的异动数据，同时产生相应的事件：[异动状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_change/events/updated)
本事件不再推荐使用，请使用新版本[发起员工异动](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/create)
;
官网API文档链接:
CreateJobDataResp |
JobData.create(CreateJobDataReq req,
RequestOptions reqOptions)
创建任职信息，在系统中第一次创建员工任职数据，通常在员工入职或者做数据批量导入的时候使用，【任职原因】只支持填写“onboarding”。
|
|
CreateJobFamilyResp |
JobFamily.create(CreateJobFamilyReq req,
RequestOptions reqOptions)
|
CreateLeaveGrantingRecordResp |
LeaveGrantingRecord.create(CreateLeaveGrantingRecordReq req,
RequestOptions reqOptions)
创建假期发放记录，向飞书人事休假系统写入假期发放记录。
|
CreateLocationResp |
Location.create(CreateLocationReq req,
RequestOptions reqOptions)
|
CreatePersonResp |
Person.create(CreatePersonReq req,
RequestOptions reqOptions)
创建个人信息，创建人员的个人信息。
|
CreateWorkingHoursTypeResp |
WorkingHoursType.create(CreateWorkingHoursTypeReq req,
RequestOptions reqOptions)
创建工时制度，创建工时制度。
|
DeleteCompanyResp |
Company.delete(DeleteCompanyReq req,
RequestOptions reqOptions)
删除公司，删除公司
删除后无法恢复， 并且在系统中无法搜索到对应公司信息，请谨慎操作。
|
DeleteContractResp |
Contract.delete(DeleteContractReq req,
RequestOptions reqOptions)
删除合同，通过本接口可以删除合同数据，删除后即无法查询到。
|
DeleteDepartmentResp |
Department.delete(DeleteDepartmentReq req,
RequestOptions reqOptions)
删除部门，可以通过该接口通过部门ID删除一个部门记录
删除后无法恢复，
并且在系统中无法查看到对应部门信息，请谨慎操作。
|
DeleteEmployeeTypeResp |
EmployeeType.delete(DeleteEmployeeTypeReq req,
RequestOptions reqOptions)
删除人员类型，删除人员类型。
|
DeleteEmploymentResp |
Employment.delete(DeleteEmploymentReq req,
RequestOptions reqOptions)
删除雇佣信息，删除人员的雇佣信息。
|
DeleteJobDataResp |
JobData.delete(DeleteJobDataReq req,
RequestOptions reqOptions)
删除任职信息，删除人员的任职信息。
|
DeleteJobFamilyResp |
JobFamily.delete(DeleteJobFamilyReq req,
RequestOptions reqOptions)
删除序列，该接口支持通过序列ID删除单个序列信息。
|
DeleteJobLevelResp |
JobLevel.delete(DeleteJobLevelReq req,
RequestOptions reqOptions)
删除职级，可以通过该接口通过职级ID删除一个职级对象。
|
DeleteJobResp |
Job.delete(DeleteJobReq req,
RequestOptions reqOptions)
删除职务，你可以通过该接口删除一个职务信息。
|
DeleteLeaveGrantingRecordResp |
LeaveGrantingRecord.delete(DeleteLeaveGrantingRecordReq req,
RequestOptions reqOptions)
删除假期发放记录，删除飞书人事休假系统中的发放记录，假勤管理-休假管理-[发放记录](https://example.feishu.cn/people/workforce-management/manage/leave/leave_admin/granting_record)（仅支持删除发放来源是「手动发放」或「外部系统发放」的记录）。
|
DeleteLocationResp |
Location.delete(DeleteLocationReq req,
RequestOptions reqOptions)
删除地点，删除地点信息;
删除后无法恢复， 并且在系统中无法搜索到对应地点信息，请谨慎操作。
|
DeleteNationalIdTypeResp |
NationalIdType.delete(DeleteNationalIdTypeReq req,
RequestOptions reqOptions)
删除国家证件类型，删除国家证件类型，已删除的数据将无法通过查询接口获取。
|
DeletePersonResp |
Person.delete(DeletePersonReq req,
RequestOptions reqOptions)
删除个人信息，删除人员的个人信息。
|
DeletePreHireResp |
PreHire.delete(DeletePreHireReq req,
RequestOptions reqOptions)
删除待入职人员（不推荐），删除待入职人员接口，本接口直接删除待入职数据，不会判断入职流程，推荐使用新接口进行删除[【删除待入职】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/delete)。
|
DeleteWorkingHoursTypeResp |
WorkingHoursType.delete(DeleteWorkingHoursTypeReq req,
RequestOptions reqOptions)
删除工时制度，删除工时制度。
|
EditEnumOptionCommonDataMetaDataResp |
CommonDataMetaData.editEnumOption(EditEnumOptionCommonDataMetaDataReq req,
RequestOptions reqOptions)
修改字段枚举值选项，对于当前已有的所有自定义枚举字段，以及部分系统预置枚举字段，通过本接口可修改字段中已有可选项的展示名称、停启用状态
本接口当前允许修改的系统预置字段如下：; - person（个人信息）：gender（性别）、marital_status（婚姻状态）; -
address（地址）：address_type（地址类型）; - national_id（证件）：national_id_type（证件类型）; -
education（教育经历）：degree（学位）、level_of_education（学历）; - person_info_chn (个人附加信息) ：
hukou_type（户口类型）; - emergency_contact（紧急联系人）：relationship（关系）; -
dependent（家庭成员）：relationship_with_dependent（关系）; - job_data （任职信息）：employee_type (人员类型); -
probation （试用期对象）：final_assessment_grade （试用期最终考核等级）; - department（部门）：subtype（部门类型） ;
官网API文档链接:
GetCompanyResp |
Company.get(GetCompanyReq req,
RequestOptions reqOptions)
查询单个公司，根据 ID 查询单个公司。
|
|
GetContractResp |
Contract.get(GetContractReq req,
RequestOptions reqOptions)
查询单个合同，该接口用于根据合同 ID 查询单个合同详细信息，包括合同开始日期、结束日期、公司主体等信息
如需要一次性查询多份合同，请检索[批量查询接口](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/contract/list)，更适合分批查询合同列表的场景
;
官网API文档链接:
GetCountryRegionResp |
CountryRegion.get(GetCountryRegionReq req,
RequestOptions reqOptions)
查询单条国家/地区信息，查询单条国家/地区信息。
|
|
GetCurrencyResp |
Currency.get(GetCurrencyReq req,
RequestOptions reqOptions)
查询单个货币信息，查询单个货币信息。
|
GetDepartmentResp |
Department.get(GetDepartmentReq req,
RequestOptions reqOptions)
查询单个部门，该接口支持通过部门id批量查询当天的部门详情信息，包括部门包含的名称、描述、启用状态等。
|
GetEmployeeTypeResp |
EmployeeType.get(GetEmployeeTypeReq req,
RequestOptions reqOptions)
查询单个人员类型，根据 ID 查询单个人员类型。
|
GetFileResp |
File.get(GetFileReq req,
RequestOptions reqOptions)
|
GetJobFamilyResp |
JobFamily.get(GetJobFamilyReq req,
RequestOptions reqOptions)
查询单个序列详情，该接口通过序列ID查询单个序列详情信息，如序列名称、描述、状态等
延迟说明：数据库主从延迟2s以内，即：直接创建序列后2s内调用此接口可能查询不到数据。
|
GetJobLevelResp |
JobLevel.get(GetJobLevelReq req,
RequestOptions reqOptions)
查询单个职级，该接口通过职级id 查询单个职级详情信息，包括职级包含的名称、描述、启用状态等
注意事项：数据库主从延迟 2s 以内，直接创建职级后2s内调用此接口可能查询不到数据。
|
GetJobResp |
Job.get(GetJobReq req,
RequestOptions reqOptions)
查询单个职务，该接口支持通过职务id批量查询当天的职务详情信息，包括职务包含的名称、描述、启用状态等。
|
GetLocationResp |
Location.get(GetLocationReq req,
RequestOptions reqOptions)
查询单个地点，该接口用于根据地点 ID查询地点信息，信息包含地点名称、描述、地点用途、工时制度、区域设置、时区以及关联的地址信息等。
|
GetNationalIdTypeResp |
NationalIdType.get(GetNationalIdTypeReq req,
RequestOptions reqOptions)
查询单个国家证件类型，根据 ID 查询单个国家证件类型。
|
GetPersonResp |
Person.get(GetPersonReq req,
RequestOptions reqOptions)
查询单个个人信息，根据 ID 查询单个人员的个人信息。
|
GetPreHireResp |
PreHire.get(GetPreHireReq req,
RequestOptions reqOptions)
查询单个待入职信息，根据 ID
查询单个待入职人员，本接口不再推荐使用（个人信息相关数据不完整），请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。
|
GetProcessFormVariableDataResp |
ProcessFormVariableData.get(GetProcessFormVariableDataReq req,
RequestOptions reqOptions)
获取流程表单数据，根据流程实例 id（process_id）获取流程表单字段数据，包括表单里的业务字段和自定义字段。
|
GetSubdivisionResp |
Subdivision.get(GetSubdivisionReq req,
RequestOptions reqOptions)
查询单条省份/行政区信息，查询单条省份/行政区信息。
|
GetSubregionResp |
Subregion.get(GetSubregionReq req,
RequestOptions reqOptions)
查询单条城市/区域信息，查询单条城市/区域信息。
|
GetWorkingHoursTypeResp |
WorkingHoursType.get(GetWorkingHoursTypeReq req,
RequestOptions reqOptions)
查询单个工时制度，根据 ID 查询单个工时制度。
|
GetByParamAuthorizationResp |
Authorization.getByParam(GetByParamAuthorizationReq req,
RequestOptions reqOptions)
查询单个用户授权，查询[飞书人事管理后台](https://people.feishu.cn/people/)里
-「设置」-「权限设置」中的单个用户授权信息。
|
GetByParamCustomFieldResp |
CustomField.getByParam(GetByParamCustomFieldReq req,
RequestOptions reqOptions)
获取字段详情，获取「飞书人事」对象下某字段的详细信息，支持系统预置字段和自定义字段。
|
LeaveBalancesLeaveResp |
Leave.leaveBalances(LeaveBalancesLeaveReq req,
RequestOptions reqOptions)
批量查询员工假期余额，批量获取员工各个假期的余额数据。
|
LeaveRequestHistoryLeaveResp |
Leave.leaveRequestHistory(LeaveRequestHistoryLeaveReq req,
RequestOptions reqOptions)
批量查询员工请假记录，批量获取员工的请假记录数据。
|
LeaveTypesLeaveResp |
Leave.leaveTypes(LeaveTypesLeaveReq req,
RequestOptions reqOptions)
获取假期类型列表，获取休假设置后台配置的假期类型列表（比如年假、事假、婚假等）。
|
ListCompanyResp |
Company.list(ListCompanyReq req,
RequestOptions reqOptions)
批量查询公司，分页查询公司，可分页遍历全量公司数据。
|
ListContractResp |
Contract.list(ListContractReq req,
RequestOptions reqOptions)
批量查询合同，通过接口可以批量查询合同列表信息，目前暂不支持其他筛选条件且一次查询最多支持50条数据。
|
ListCountryRegionResp |
CountryRegion.list(ListCountryRegionReq req,
RequestOptions reqOptions)
批量查询国家/地区信息，批量查询国家/地区信息。
|
ListCurrencyResp |
Currency.list(ListCurrencyReq req,
RequestOptions reqOptions)
批量查询货币信息，批量查询货币信息。
|
ListDepartmentResp |
Department.list(ListDepartmentReq req,
RequestOptions reqOptions)
批量查询部门（不推荐），批量查询部门信息，包括部门基本信息、自定义字段信息等
本接口不再推荐使用（不支持更复杂的字段鉴权功能），请使用[批量查询部门V2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get)接口（支持对成本中心、部门负责人、自定义字段鉴权）。
|
ListEmployeeTypeResp |
EmployeeType.list(ListEmployeeTypeReq req,
RequestOptions reqOptions)
批量查询人员类型，批量查询人员类型。
|
ListJobDataResp |
JobData.list(ListJobDataReq req,
RequestOptions reqOptions)
|
ListJobLevelResp |
JobLevel.list(ListJobLevelReq req,
RequestOptions reqOptions)
批量查询职级，获取租户下的所有职级详情，包括职级数值、编码、名称等;
延迟说明：数据库主从延迟 2s 以内，即：直接创建职级后2s内调用此接口可能查询不到数据。
|
ListJobResp |
Job.list(ListJobReq req,
RequestOptions reqOptions)
批量查询职务，批量查询职务。
|
ListLocationResp |
Location.list(ListLocationReq req,
RequestOptions reqOptions)
批量分页查询地点信息，该接口用于批量查询地点信息，信息包含地点名称、描述、地点用途、工时制度、区域设置、时区以及关联的地址信息等。
|
ListNationalIdTypeResp |
NationalIdType.list(ListNationalIdTypeReq req,
RequestOptions reqOptions)
批量查询国家证件类型，批量查询国家证件类型。
|
ListPreHireResp |
PreHire.list(ListPreHireReq req,
RequestOptions reqOptions)
批量查询待入职信息，可通过本接口批量查询待入职人员信息，本接口不再推荐使用（个人信息相关数据不完整），请使用[查询待入职](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/query)接口获取更完整信息。
|
ListSecurityGroupResp |
SecurityGroup.list(ListSecurityGroupReq req,
RequestOptions reqOptions)
批量获取角色列表，用于查询飞书人事中的角色列表（对应[飞书人事管理后台](https://people.feishu.cn/people/) - 设置 - 权限设置 -
角色设置中的角色列表），列表内包含角色 ID、名称、状态以及描述等信息。
|
ListSubdivisionResp |
Subdivision.list(ListSubdivisionReq req,
RequestOptions reqOptions)
批量查询省份/行政区信息，批量查询省份/行政区信息。
|
ListSubregionResp |
Subregion.list(ListSubregionReq req,
RequestOptions reqOptions)
批量查询城市/区域信息，批量查询城市/区域信息。
|
ListWorkingHoursTypeResp |
WorkingHoursType.list(ListWorkingHoursTypeReq req,
RequestOptions reqOptions)
批量查询工时制度，批量查询工时制度。
|
ListObjectApiNameCustomFieldResp |
CustomField.listObjectApiName(ListObjectApiNameCustomFieldReq req,
RequestOptions reqOptions)
获取飞书人事对象列表，获取「飞书人事」中的对象列表，含系统预置对象与自定义对象。
|
MatchCompensationStandardResp |
CompensationStandard.match(MatchCompensationStandardReq req,
RequestOptions reqOptions)
获取员工薪资标准，- 调用此接口来获取员工匹配的薪资标准信息;- 请求时，可选传递员工的部门 ID、职级 ID、职务ID 、序列 ID 等筛选条件，用于匹配薪资标准;-
此接口将返回员工可匹配到的薪资标准全部信息，包括薪资标准表 ID、薪级薪等、薪资带宽、薪资标准值等
该接口会按照应用拥有的「薪资标准资源」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限-飞书人事(企业版)数据权限范围」中已申请「薪资标准资源」权限范围 ;
官网API文档链接:
PatchCompanyResp |
Company.patch(PatchCompanyReq req,
RequestOptions reqOptions)
| |
PatchEmployeeTypeResp |
EmployeeType.patch(PatchEmployeeTypeReq req,
RequestOptions reqOptions)
更新人员类型，更新人员类型。
|
PatchEmploymentResp |
Employment.patch(PatchEmploymentReq req,
RequestOptions reqOptions)
|
PatchJobFamilyResp |
JobFamily.patch(PatchJobFamilyReq req,
RequestOptions reqOptions)
更新单个序列;，可以通过序列ID更新单个序列详情信息，例如序列名称、上级序列ID等。
|
PatchJobLevelResp |
JobLevel.patch(PatchJobLevelReq req,
RequestOptions reqOptions)
更新单个职级，该接口通过职级ID更新单个职级信息，包括职级数值、名称等信息。
|
PatchJobResp |
Job.patch(PatchJobReq req,
RequestOptions reqOptions)
更新单个职务，可以通过职务ID更新单个职务详情信息，例如职务名称、描述等。
|
PatchNationalIdTypeResp |
NationalIdType.patch(PatchNationalIdTypeReq req,
RequestOptions reqOptions)
更新国家证件类型，更新国家证件类型。
|
PatchPersonResp |
Person.patch(PatchPersonReq req,
RequestOptions reqOptions)
更新个人信息，更新个人信息。
|
PatchPreHireResp |
PreHire.patch(PatchPreHireReq req,
RequestOptions reqOptions)
更新待入职信息（不推荐），更新待入职信息接口，本接口只是会更新待入职数据，不会校验数据规则，推荐使用新接口[【更新待入职信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/pre_hire/patch)。
|
PatchWorkingHoursTypeResp |
WorkingHoursType.patch(PatchWorkingHoursTypeReq req,
RequestOptions reqOptions)
更新工时制度，更新工时制度。
|
QueryAuthorizationResp |
Authorization.query(QueryAuthorizationReq req,
RequestOptions reqOptions)
批量查询用户授权，批量查询[飞书人事管理后台](https://people.feishu.cn/people/)
-「设置」-「权限设置」中的用户授权信息。
|
QueryCustomFieldResp |
CustomField.query(QueryCustomFieldReq req,
RequestOptions reqOptions)
获取自定义字段列表，根据对象的 API name，获取「飞书人事」具体对象下的自定义字段列表
在人事设置[「人员档案配置」页面](https://people.feishu.cn/people/hr-settings/profile)添加的分组，实际上都是自定义对象，可以通过该接口查询分组内的所有字段。
|
QueryOffboardingResp |
Offboarding.query(QueryOffboardingReq req,
RequestOptions reqOptions)
查询员工离职原因列表，该接口用于查询[离职配置](https://people.feishu.cn/people/hr-settings/dimission/setting)>
离职原因的选项信息，包括离职原因选项的唯一标识、名称和启用状态等信息。
|
QuerySecurityGroupResp |
SecurityGroup.query(QuerySecurityGroupReq req,
RequestOptions reqOptions)
查询部门 / 地点的 HRBP / 属地 BP，通过部门或工作地点，查询对应的 HRBP / 属地 BP，返回的信息中包含BP的员工ID、部门ID、属地ID等信息。
|
QueryTransferReasonResp |
TransferReason.query(QueryTransferReasonReq req,
RequestOptions reqOptions)
获取异动原因列表，该接口用于查询[异动配置](https://people.feishu.cn/people/hr-settings/transaction/setting) >
异动原因的选项信息，包括异动原因选项的唯一标识、名称和启用状态等信息。
|
QueryTransferTypeResp |
TransferType.query(QueryTransferTypeReq req,
RequestOptions reqOptions)
获取异动类型列表，该接口用于查询[异动配置](https://people.feishu.cn/people/hr-settings/transaction/setting) >
异动类型的选项信息，包括异动类型选项的唯一标识、名称和启用状态等信息。
|
RemoveRoleAssignAuthorizationResp |
Authorization.removeRoleAssign(RemoveRoleAssignAuthorizationReq req,
RequestOptions reqOptions)
移除用户被授权的角色，移除用户被授权的指定角色及授权范围，已经存在授权可通过[查询单个用户授权](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/authorization/get_by_param)获得。
|
SearchAssignedUserResp |
AssignedUser.search(SearchAssignedUserReq req,
RequestOptions reqOptions)
获取组织类角色授权列表，查询组织类角色的授权信息，返回的授权列表中包含被授权的用户ID和被授权的管理维度等信息。
|
SearchOffboardingResp |
Offboarding.search(SearchOffboardingReq req,
RequestOptions reqOptions)
搜索离职信息，该接口支持根据员工ID、离职审批发起时间和离职日期等字段搜索离职信息，可获取包括离职日期、离职原因、离职状态和流程审批状态等信息。
|
SubmitOffboardingResp |
Offboarding.submit(SubmitOffboardingReq req,
RequestOptions reqOptions)
操作员工离职，该接口用于发起员工离职。
|
UpdateRoleAssignAuthorizationResp |
Authorization.updateRoleAssign(UpdateRoleAssignAuthorizationReq req,
RequestOptions reqOptions)
更新用户被授权的数据范围，更新角色被授权的管理范围 ;更新后的数据范围，以本次提交的数据范围为准，本次未提交的部分将被移除。
|
UploadPersonResp |
Person.upload(UploadPersonReq req,
RequestOptions reqOptions)
上传文件，上传文件。
|
WorkCalendarLeaveResp |
Leave.workCalendar(WorkCalendarLeaveReq req,
RequestOptions reqOptions)
获取工作日历信息，获取工作日历信息，如名称，状态等
官网API文档链接:
WorkCalendarDateLeaveResp |
Leave.workCalendarDate(WorkCalendarDateLeaveReq req,
RequestOptions reqOptions)
获取工作日历日期详情，获取工作日历每一天的日期详情，如日期、日期类型等
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.corehr.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
ActiveCompanyResp |
Company.active(ActiveCompanyReq req,
RequestOptions reqOptions)
启用/停用公司，对公司进行启用或停用操作
停用公司时请确认有无在职员工、异动单据、待入职单据关联此公司，如有会导致停用失败。
|
ActiveCustomOrgResp |
CustomOrg.active(ActiveCustomOrgReq req,
RequestOptions reqOptions)
启用/停用自定义组织，对自定义组织进行启用或停用操作
- 停用自定义组织时请确认有无在职员工、异动单据、待入职单据关联此自定义组织，如有会导致停用失败。
|
ActiveLocationResp |
Location.active(ActiveLocationReq req,
RequestOptions reqOptions)
|
BatchWorkforcePlanDetailResp |
WorkforcePlanDetail.batch(BatchWorkforcePlanDetailReq req,
RequestOptions reqOptions)
查询编制规划明细信息（不支持自定义组织），查询编制规划明细，包括维度信息、编制数和预估在职人数
延迟说明：搜索同步延迟 10s 以内，即：直接创建编制明细后 10s 内调用此接口可能查询不到数据。
|
BatchDeleteReportDetailRowResp |
ReportDetailRow.batchDelete(BatchDeleteReportDetailRowReq req,
RequestOptions reqOptions)
批量删除填报行，批量删除填报行后，可在【设置-编制规划设置-编制规划XXX-集中填报-查看数据】进行查看。
|
BatchDeleteWorkforcePlanDetailRowResp |
WorkforcePlanDetailRow.batchDelete(BatchDeleteWorkforcePlanDetailRowReq req,
RequestOptions reqOptions)
批量删除明细行，批量删除明细行后，可在【设置-编制规划设置-编制规划XXX-编辑数据】进行查看明细行是否被删除。
|
BatchGetCompanyResp |
Company.batchGet(BatchGetCompanyReq req,
RequestOptions reqOptions)
通过 ID 批量查询公司信息，通过 ID 批量查询公司信息
延迟说明：;- **数据库主从延迟2s以内，即：直接创建公司后2s内调用此接口可能查询不到数据**;- **响应体registered_office_address_info
（注册地址）、office_address_info
（办公地址）下的full_address_local_script（完整地址，本地文字）、full_address_western_script（完整地址，西方文字）字段为计算字段，延迟5s以内，堆积时会延长**;;如果你只需要查询某一条公司信息，建议通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取公司信息。
|
BatchGetDepartmentResp |
Department.batchGet(BatchGetDepartmentReq req,
RequestOptions reqOptions)
批量查询部门，批量查询部门信息，**该接口只返回部门当前内容**。
|
BatchGetEmployeeResp |
Employee.batchGet(BatchGetEmployeeReq req,
RequestOptions reqOptions)
批量查询员工信息，通过员工 ID 、个人信息 ID、工作邮箱等筛选项批量查询员工的工作信息、个人信息。
|
BatchGetEmployeesBpResp |
EmployeesBp.batchGet(BatchGetEmployeesBpReq req,
RequestOptions reqOptions)
查询员工 HRBP / 属地 BP，查询员工的 HRBP 和属地 BP，包括来自上级部门的 HRBP 和属地 BP。
|
BatchGetEmployeesJobDataResp |
EmployeesJobData.batchGet(BatchGetEmployeesJobDataReq req,
RequestOptions reqOptions)
批量查询员工任职信息，通过员工雇佣 ID 批量查询任职信息。
|
BatchGetJobFamilyResp |
JobFamily.batchGet(BatchGetJobFamilyReq req,
RequestOptions reqOptions)
根据条件批量查询序列信息，通过序列 ID 或序列 Code 批量查询当前生效版本序列的详情信息，包括序列名称、启用状态、上级序列等。
|
BatchGetJobLevelResp |
JobLevel.batchGet(BatchGetJobLevelReq req,
RequestOptions reqOptions)
根据条件批量获取职级信息，该接口支持通过职级ID或职级Code批量查询职级详情信息，包括名称、描述、启用状态等。
|
BatchGetJobResp |
Job.batchGet(BatchGetJobReq req,
RequestOptions reqOptions)
根据条件批量获取职务，根据传入的职务ID或职务Code批量获取当前生效版本职务信息。
|
BatchGetLocationResp |
Location.batchGet(BatchGetLocationReq req,
RequestOptions reqOptions)
通过地点 ID 批量获取地点信息，该接口用于根据地点 ID批量查询地点信息，信息包含地点名称、描述、地点用途、工时制度、区域设置、时区以及关联的地址信息等。
|
BatchGetPathwayResp |
Pathway.batchGet(BatchGetPathwayReq req,
RequestOptions reqOptions)
获取通道信息，根据通道的ID批量获取通道的名称、编码、描述信息
由于该接口为ByID批量查询接口，当请求参数中的某个通道ID错误或者被删除时，接口不会报错。
|
BatchQueryCostAllocationResp |
CostAllocation.batchQuery(BatchQueryCostAllocationReq req,
RequestOptions reqOptions)
|
BatchSaveWorkforcePlanDetailRowResp |
WorkforcePlanDetailRow.batchSave(BatchSaveWorkforcePlanDetailRowReq req,
RequestOptions reqOptions)
批量创建/更新明细行，批量创建/更新明细行后，可在【设置-编制规划设置-编制规划XXX-编辑数据】进行查看。
|
BatchV2WorkforcePlanDetailResp |
WorkforcePlanDetail.batchV2(BatchV2WorkforcePlanDetailReq req,
RequestOptions reqOptions)
查询编制规划明细信息（支持自定义组织），查询编制规划明细，包括维度信息、编制数、预估在职人数、在职人数和预增/预减人数。
|
CompletePreHireResp |
PreHire.complete(CompletePreHireReq req,
RequestOptions reqOptions)
|
CreateEmployeeResp |
Employee.create(CreateEmployeeReq req,
RequestOptions reqOptions)
添加人员，支持在单个接口中进行人员全信息添加，包括人员的基本信息，雇佣信息，入职任职记录及其他分组信息
- 此接口参数校验规则与【人事系统-人员档案配置】的校验规则一致，字段是否必填以【人事系统-人员档案配置】为准。
|
CreateEmployeesAdditionalJobResp |
EmployeesAdditionalJob.create(CreateEmployeesAdditionalJobReq req,
RequestOptions reqOptions)
|
CreateJobChangeResp |
JobChange.create(CreateJobChangeReq req,
RequestOptions reqOptions)
发起员工异动，该接口用于发起员工异动（变更员工雇佣信息），若发起成功，会生成一条员工的异动数据
该接口会按照应用拥有的「异动记录资源」的权限范围返回数据，请确定在「开发者后台 - 权限管理 -
数据权限」中申请了「异动记录资源」权限范围;;;本接口会产生事件：[异动状态变更事件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/job_change/events/status_updated)
;
官网API文档链接:
CreateJobGradeResp |
JobGrade.create(CreateJobGradeReq req,
RequestOptions reqOptions)
| |
CreatePreHireResp |
PreHire.create(CreatePreHireReq req,
RequestOptions reqOptions)
直接创建待入职，使用指定数据创建一个待入职人员信息。
|
CreateProbationAssessmentResp |
ProbationAssessment.create(CreateProbationAssessmentReq req,
RequestOptions reqOptions)
|
CreateProcessStartResp |
ProcessStart.create(CreateProcessStartReq req,
RequestOptions reqOptions)
发起流程，发起一个流程实例，目前只支持发起自定义业务类型的流程。
|
CreateEmpCustomOrgEmployeeCustomOrgResp |
EmployeeCustomOrg.createEmpCustomOrg(CreateEmpCustomOrgEmployeeCustomOrgReq req,
RequestOptions reqOptions)
|
DeleteCostCenterVersionResp |
CostCenterVersion.delete(DeleteCostCenterVersionReq req,
RequestOptions reqOptions)
撤销成本中心版本，该接口支持通过成本中心的版本ID撤销成本中心版本信息
撤销后无法恢复， 并且在系统中无法搜索到对应成本中心版本信息，请谨慎操作。
|
DeleteDepartmentResp |
Department.delete(DeleteDepartmentReq req,
RequestOptions reqOptions)
删除部门，可以通过该接口通过部门ID删除一个部门记录，带数据行权限判权
删除后无法恢复， 并且在系统中无法查看到对应部门信息，请谨慎操作。
|
DeleteEmployeesAdditionalJobResp |
EmployeesAdditionalJob.delete(DeleteEmployeesAdditionalJobReq req,
RequestOptions reqOptions)
|
DeletePathwayResp |
Pathway.delete(DeletePathwayReq req,
RequestOptions reqOptions)
删除通道，根据传入的通道 ID 删除一个相应的通道信息;
删除后无法恢复， 并且在系统中无法搜索到对应通道信息，请谨慎操作。
|
DeletePreHireResp |
PreHire.delete(DeletePreHireReq req,
RequestOptions reqOptions)
|
DelPositionPositionResp |
Position.delPosition(DelPositionPositionReq req,
RequestOptions reqOptions)
|
EditProbationResp |
Probation.edit(EditProbationReq req,
RequestOptions reqOptions)
|
EnableDisableAssessmentProbationResp |
Probation.enableDisableAssessment(EnableDisableAssessmentProbationReq req,
RequestOptions reqOptions)
|
GetApprovalGroupsResp |
ApprovalGroups.get(GetApprovalGroupsReq req,
RequestOptions reqOptions)
根据流程 ID 查询组织架构调整记录，用户通过『飞书人事-我的团队-组织架构』 发起一个组织架构调整会根据 审批流配置发起 一个或多个审批。
|
GetDraftResp |
Draft.get(GetDraftReq req,
RequestOptions reqOptions)
根据组织架构调整 ID 查询发起的流程信息，用户通过『飞书人事-我的团队/人员管理-组织架构』 发起一个组织架构调整会根据 审批流配置发起 一个或多个审批。
|
GetJobResp |
Job.get(GetJobReq req,
RequestOptions reqOptions)
查询单个职务，根据 ID 查询单个职务的详细信息，如职务名称、描述等
延迟说明：数据库主从延迟2s以内，即：直接创建对象后2s内调用此接口可能查询不到数据。
|
GetProcessFormVariableDataResp |
ProcessFormVariableData.get(GetProcessFormVariableDataReq req,
RequestOptions reqOptions)
获取流程表单数据，根据流程实例 id（process_id）获取流程表单字段数据，包括表单里的业务字段和自定义字段。
|
GetProcessResp |
Process.get(GetProcessReq req,
RequestOptions reqOptions)
获取单个流程详情，根据流程实例
id（process_id）获取单个流程详情（此功能不受数据权限范围控制）。
|
GetByDepartmentBpResp |
Bp.getByDepartment(GetByDepartmentBpReq req,
RequestOptions reqOptions)
查询部门 HRBP，查询部门的 HRBP 信息，包括来自上级部门的 HRBP。
|
ListApproverResp |
Approver.list(ListApproverReq req,
RequestOptions reqOptions)
获取指定人员审批任务列表，审批任务依赖于流程节点实例存在，每一个流程节点实例可能包含有一或多个审批任务，每一个任务表明当前节点的审批人是谁，该接口可获取指定人员的审批任务列表（此功能不受数据权限范围控制）。
|
ListBpResp |
Bp.list(ListBpReq req,
RequestOptions reqOptions)
获取 HRBP 列表，获取 HRBP 列表。
|
ListEmployeesInternationalAssignmentResp |
EmployeesInternationalAssignment.list(ListEmployeesInternationalAssignmentReq req,
RequestOptions reqOptions)
批量查询外派信息，查询员工的外派信息：外派类型、外派地点、职务、职级、上级等。
|
ListJobResp |
Job.list(ListJobReq req,
RequestOptions reqOptions)
批量查询职务，查询全部职务详情，包括职务编码、名称等信息
延迟说明：数据库主从延迟2s以内，即：直接创建对象后2s内调用此接口可能查询不到数据。
|
ListProcessResp |
Process.list(ListProcessReq req,
RequestOptions reqOptions)
查询流程实例列表，本接口用于查询流程实例列表，支持通过流程定义 ID 等进行查询（此功能不受数据权限范围控制），其中：;;-
流程实例：是指用户在业务功能或者飞书人事的审批中心发起的具体流程，process_id 是其唯一标识。
|
ListSignatureFileResp |
SignatureFile.list(ListSignatureFileReq req,
RequestOptions reqOptions)
|
ListWorkforcePlanResp |
WorkforcePlan.list(ListWorkforcePlanReq req,
RequestOptions reqOptions)
查询编制规划方案，根据传入的筛选项获取编制规划的方案列表
该接口会按照应用拥有的「部门数据」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限」中有申请「部门资源」权限范围;;-
请求体入参如果没有特殊说明，不填写默认为空，不参与筛选。
|
ListByBizIdSignatureFileResp |
SignatureFile.listByBizId(ListByBizIdSignatureFileReq req,
RequestOptions reqOptions)
|
OpenQueryJobChangeListByIdsApprovalGroupsResp |
ApprovalGroups.openQueryJobChangeListByIds(OpenQueryJobChangeListByIdsApprovalGroupsReq req,
RequestOptions reqOptions)
批量查询人员调整内容，根据人员异动记录 ID 批量查询人员调整内容
- 用户使用该接口前需提前获取 组织架构调整流程信息 权限;- 延迟说明：数据库主从延迟2s以内，即：用户接收到流程状态变更消息后2s内调用此接口可能查询不到数据。
|
OpenQueryPositionChangeListByIdsApprovalGroupsResp |
ApprovalGroups.openQueryPositionChangeListByIds(OpenQueryPositionChangeListByIdsApprovalGroupsReq req,
RequestOptions reqOptions)
批量查询岗位调整内容，根据岗位调整记录 ID 批量查询岗位调整内容
- 用户使用该接口前需提前获取 组织架构调整岗位调整内容 权限。
|
ParentsDepartmentResp |
Department.parents(ParentsDepartmentReq req,
RequestOptions reqOptions)
获取父部门信息，该接口用来递归获取部门的父部门信息，并按照由子到父的顺序返回有权限的父部门信息列表。
|
PatchCostCenterResp |
CostCenter.patch(PatchCostCenterReq req,
RequestOptions reqOptions)
启用 / 停用成本中心，该接口支持对单个成本中心进行启用和停用操作。
|
PatchCostCenterVersionResp |
CostCenterVersion.patch(PatchCostCenterVersionReq req,
RequestOptions reqOptions)
更正成本中心版本，对成本中心的版本记录进行更正，可更正的字段包括：名称，上级成本中心，成本中心负责人列表，成本中心的描述，生效时间
官网API文档链接:
PatchCustomOrgResp |
CustomOrg.patch(PatchCustomOrgReq req,
RequestOptions reqOptions)
更新自定义组织基础信息，更新一个自定义组织基础信息，不支持更新自动匹配规则，如需更新自动匹配规则请使用[更新匹配规则](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/custom_org/update_rule)
如果是新建版本时，会将停用版本更新为启用版本;;- 非必填字段，不传时即不做变更。
|
|
PatchDepartmentResp |
Department.patch(PatchDepartmentReq req,
RequestOptions reqOptions)
|
PatchPreHireResp |
PreHire.patch(PatchPreHireReq req,
RequestOptions reqOptions)
|
QueryEmployeesJobDataResp |
EmployeesJobData.query(QueryEmployeesJobDataReq req,
RequestOptions reqOptions)
获取任职信息列表，获取任职信息列表。
|
QueryJobGradeResp |
JobGrade.query(QueryJobGradeReq req,
RequestOptions reqOptions)
查询职等信息，查询职等的详细信息。
|
QueryPositionResp |
Position.query(QueryPositionReq req,
RequestOptions reqOptions)
查询岗位信息，支持通过岗位 ID、部门 ID 查询岗位的详细信息，例如岗位关联的职务、职级、序列，以及岗位描述，是否关键岗位等
;#### 限制说明:;- 在筛选 ID 和
查询字段对象个数过多时，可能出现超时现象，请减少筛选项和字段对象个数。
|
QueryPreHireResp |
PreHire.query(QueryPreHireReq req,
RequestOptions reqOptions)
查询待入职，该接口用于根据待入职人员 ID(支持批量)查询待入职人员信息，信息包含姓名、手机号等个人信息和任职信息。
|
QuerySignatureFileResp |
SignatureFile.query(QuerySignatureFileReq req,
RequestOptions reqOptions)
|
QueryMultiTimelineDepartmentResp |
Department.queryMultiTimeline(QueryMultiTimelineDepartmentReq req,
RequestOptions reqOptions)
批量查询部门版本信息，根据部门ID列表，批量查询开始结束时间内的所有部门版本信息，含部门名称、部门类型、上级、编码、负责人、是否启用、描述等信息
- 延迟说明：数据库主从延迟 2s 以内，即：直接创建部门后2s内调用此接口可能查询不到数据。
|
QueryMultiTimelineJobFamilyResp |
JobFamily.queryMultiTimeline(QueryMultiTimelineJobFamilyReq req,
RequestOptions reqOptions)
查询指定时间范围序列版本，- 接口支持查询出对象生效时间段在指定的start_date和end_date之间的版本;-
接口支持对象版本相关字段的查询和返回（默认返回id和version_id）;- 适用于需要回顾某段时间内对象版本变化的场景
延迟说明：数据库主从延迟2s以内，即：直接创建对象后2s内调用此接口可能查询不到数据。
|
QueryMultiTimelineJobResp |
Job.queryMultiTimeline(QueryMultiTimelineJobReq req,
RequestOptions reqOptions)
查询指定时间范围职务版本，- 接口支持查询出对象生效时间段在指定的start_date和end_date之间的版本（即：会查询出生效时间段和查询时间段有交集的版本）;-
接口支持对象版本相关字段的查询和返回（默认返回id和version_id）
延迟说明：数据库主从延迟2s以内，即：直接创建对象后2s内调用此接口可能查询不到数据。
|
QueryMultiTimelineLocationResp |
Location.queryMultiTimeline(QueryMultiTimelineLocationReq req,
RequestOptions reqOptions)
查询指定时间范围地点版本，- 接口支持查询出对象生效时间段在指定的start_date和end_date之间的版本（即：会查询出生效时间段和查询时间段有交集的版本）;-
接口支持对象版本相关字段的查询和返回（默认返回id和version_id）
延迟说明：数据库主从延迟2s以内，即：直接创建对象后2s内调用此接口可能查询不到数据。
|
QueryOperationLogsDepartmentResp |
Department.queryOperationLogs(QueryOperationLogsDepartmentReq req,
RequestOptions reqOptions)
批量查询部门操作日志，批量查询指定时间范围内的部门操作日志
-
时间窗支持大范围查询，限定查询范围在366天以内，例如要查询2020年1月1日至2023年1月1日的数据，建议分成两次查询，分别为2020年1月1日至2021年1月1日，2022年1月2日至2023年1月1日，不建议查询大时间范围数据;-
支持查询批量部门的操作日志，限定查询最大部门数为100，查询部门数量大于100时，建议分批查询;;- 默认排序条件：默认以操作时间倒序排序;-
仅支持查询部门基础字段变更的操作日志，对于角色字段变更的操作日志查询功能待上线; ;
官网API文档链接:
QueryRecentChangeCompanyResp |
Company.queryRecentChange(QueryRecentChangeCompanyReq req,
RequestOptions reqOptions)
查询当前生效信息变更公司，查询指定时间范围内当前生效信息发生变更的公司，即只有公司当前生效版本的生效时间在查询时间范围内，才返回该公司id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
|
QueryRecentChangeCostCenterResp |
CostCenter.queryRecentChange(QueryRecentChangeCostCenterReq req,
RequestOptions reqOptions)
查询当前生效信息变更的成本中心，查询指定时间范围内当前生效信息发生变更的成本中心，即只有部门当前生效版本的生效时间在查询时间范围内，才返回该成本中心id;
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeCustomOrgResp |
CustomOrg.queryRecentChange(QueryRecentChangeCustomOrgReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的自定义组织，查询指定时间范围内当前生效信息发生变更的自定义组织，即只有部门当前生效版本的生效时间在查询时间范围内，才返回该自定义组织id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeDepartmentResp |
Department.queryRecentChange(QueryRecentChangeDepartmentReq req,
RequestOptions reqOptions)
查询指定时间范围内当前生效信息发生变更的部门，查询指定时间范围内当前生效信息发生变更的部门，即只有部门当前生效版本的生效时间在查询时间范围内，才返回该部门id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeJobFamilyResp |
JobFamily.queryRecentChange(QueryRecentChangeJobFamilyReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的序列，查询指定时间范围内当前生效信息发生变更的序列，即只有序列前生效版本的生效时间在查询时间范围内，才返回该序列id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeJobGradeResp |
JobGrade.queryRecentChange(QueryRecentChangeJobGradeReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的职等，查询指定时间范围内当前生效信息发生变更的职等，即只有职等当前生效版本的生效时间在查询时间范围内，才返回该地点id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeJobLevelResp |
JobLevel.queryRecentChange(QueryRecentChangeJobLevelReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的职级，查询指定时间范围内当前生效信息发生变更的职级，即只有地点当前生效版本的生效时间在查询时间范围内，才返回该职级id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeJobResp |
Job.queryRecentChange(QueryRecentChangeJobReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的职务，查询指定时间范围内当前生效信息发生变更的职务，即只有职务当前生效版本的生效时间在查询时间范围内，才返回该职务id
-
时间窗支持大范围查询，**限定查询范围在90天以内**，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangeLocationResp |
Location.queryRecentChange(QueryRecentChangeLocationReq req,
RequestOptions reqOptions)
查询当前生效信息发生变更的地点，查询指定时间范围内当前生效信息发生变更的地点，即只有地点当前生效版本的生效时间在查询时间范围内，才返回该地点id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryRecentChangePositionResp |
Position.queryRecentChange(QueryRecentChangePositionReq req,
RequestOptions reqOptions)
查询指定时范围内当前版本信息发生变更的岗位，查询指定时间范围内信息发生变更的岗位，仅当岗位当前生效版本的生效时间在查询时间范围内，才返回该岗位id
-
时间窗支持大范围查询，限定查询范围在90天以内，例如要查询2020年1月1日至2020年6月30日的数据，建议分成两次查询，分别为2020年1月1日至2020年3月31日，2020年4月1日至2020年6月30日，不建议查询大时间范围数据
;- 未来生效的版本数据，会在生效日期当天凌晨产生变更事件。
|
QueryTimelineDepartmentResp |
Department.queryTimeline(QueryTimelineDepartmentReq req,
RequestOptions reqOptions)
查询指定日期的部门基本信息，查询指定生效的部门基本信息，含部门名称、部门类型、上级、编码、负责人、是否启用、描述等信息
延迟说明：数据库主从延迟 2s 以内，即：直接创建部门后2s内调用此接口可能查询不到数据。
|
RemoveVersionCostAllocationResp |
CostAllocation.removeVersion(RemoveVersionCostAllocationReq req,
RequestOptions reqOptions)
|
RevokeOffboardingResp |
Offboarding.revoke(RevokeOffboardingReq req,
RequestOptions reqOptions)
撤销离职，通过离职ID撤销飞书人事的[离职信息](https://people.feishu.cn/people/members/dimission/management)。
|
SearchBasicInfoBankBranchResp |
BasicInfoBankBranch.search(SearchBasicInfoBankBranchReq req,
RequestOptions reqOptions)
|
SearchCostCenterResp |
CostCenter.search(SearchCostCenterReq req,
RequestOptions reqOptions)
搜索成本中心信息，搜索成本中心信息；支持通过成本中心ID，成本中心名称，成本中心编码，成本中心上级搜索成本中心的信息，有分页功能。
|
SearchDepartmentResp |
Department.search(SearchDepartmentReq req,
RequestOptions reqOptions)
搜索部门信息，该接口支持通过部门id、上级部门ID、部门负责人、名称、编码字段批量搜索当天的部门详情信息，包括部门包含的名称、描述、启用状态等。
|
SearchEmployeeResp |
Employee.search(SearchEmployeeReq req,
RequestOptions reqOptions)
搜索员工信息，查询员工的工作信息、个人信息等数据
- 请求体入参不填写默认为空;- 所有筛选项可一起使用，之间为 AND 关系;- 字段未返回请检查：字段权限、用户该字段有值，以及飞书人事档案配置中字段是否启用;-
在人事系统开启【复用工号】后，存在一个工号对应多个员工的情况，请勿依赖工号做唯一性检查;- 基于 `id_type` 类型字段（如
employment_id），在部分转换失败（ID映射不存在）的场景会返回 lark_id，无法区分值是否为对应 `id_type`。
|
SearchEnumResp |
Enum.search(SearchEnumReq req,
RequestOptions reqOptions)
查询枚举信息，根据枚举的APIName查询枚举详细信息，用于BPM等场景获取枚举选项。
|
SearchJobChangeResp |
JobChange.search(SearchJobChangeReq req,
RequestOptions reqOptions)
|
SearchProbationResp |
Probation.search(SearchProbationReq req,
RequestOptions reqOptions)
|
SubmitProbationResp |
Probation.submit(SubmitProbationReq req,
RequestOptions reqOptions)
|
TerminateSignatureFileResp |
SignatureFile.terminate(TerminateSignatureFileReq req,
RequestOptions reqOptions)
|
TreeDepartmentResp |
Department.tree(TreeDepartmentReq req,
RequestOptions reqOptions)
查询指定生效日期的部门架构树，支持传入部门ID（不传默认根部门），任意日期（不传默认当前日期）。
|
UpdateProcessApproverResp |
ProcessApprover.update(UpdateProcessApproverReq req,
RequestOptions reqOptions)
通过/拒绝审批任务，对于单个审批任务进行通过（提交）或拒绝操作。
|
UpdateProcessExtraResp |
ProcessExtra.update(UpdateProcessExtraReq req,
RequestOptions reqOptions)
加签审批任务，给单个流程中的节点或审批任务加签，加签方式有前加签、并加签、后加签三种。
|
UpdateProcessRevokeResp |
ProcessRevoke.update(UpdateProcessRevokeReq req,
RequestOptions reqOptions)
撤销流程，撤销单个流程，状态为已完成的流程能够进行撤销，使用时需指定操作人，目前支持流程管理员和审批单管理员。
|
UpdateProcessTransferResp |
ProcessTransfer.update(UpdateProcessTransferReq req,
RequestOptions reqOptions)
转交审批任务，对于单个审批任务进行转交操作。
|
UpdateProcessWithdrawResp |
ProcessWithdraw.update(UpdateProcessWithdrawReq req,
RequestOptions reqOptions)
|
UpdateVersionCostAllocationResp |
CostAllocation.updateVersion(UpdateVersionCostAllocationReq req,
RequestOptions reqOptions)
更新成本分摊，更新成本分摊
官网API文档链接:
UpdateVersionDefaultCostCenterResp |
DefaultCostCenter.updateVersion(UpdateVersionDefaultCostCenterReq req,
RequestOptions reqOptions)
更新默认成本中心，更新默认成本中心
官网API文档链接:
WithdrawProbationResp |
Probation.withdraw(WithdrawProbationReq req,
RequestOptions reqOptions)
撤销转正，可通过本接口撤销对员工之前发起的转正
官网API文档链接:
WithdrawOnboardingPreHireResp |
PreHire.withdrawOnboarding(WithdrawOnboardingPreHireReq req,
RequestOptions reqOptions)
撤销入职，通过本接口对指定待入职，入职准备就绪的员工执行撤销入职操作，对应入职管理页面撤销入职按钮
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.directory.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateCollaborationRuleResp |
CollaborationRule.create(CreateCollaborationRuleReq req,
RequestOptions reqOptions)
新增可搜可见规则，管理员视角新增可搜可见规则。
|
CreateDepartmentResp |
Department.create(CreateDepartmentReq req,
RequestOptions reqOptions)
创建部门，本接口用于用于在企业通讯录中创建新部门，支持设置部门名称、父部门、负责人等信息。
|
CreateEmployeeResp |
Employee.create(CreateEmployeeReq req,
RequestOptions reqOptions)
创建员工，本接口用于在企业下创建员工。
|
DeleteCollaborationRuleResp |
CollaborationRule.delete(DeleteCollaborationRuleReq req,
RequestOptions reqOptions)
删除可搜可见规则，管理员视角删除可搜可见规则。
|
DeleteDepartmentResp |
Department.delete(DeleteDepartmentReq req,
RequestOptions reqOptions)
删除部门，本接口用于删除部门。
|
DeleteEmployeeResp |
Employee.delete(DeleteEmployeeReq req,
RequestOptions reqOptions)
离职员工，本接口用于离职员工。
|
FilterDepartmentResp |
Department.filter(FilterDepartmentReq req,
RequestOptions reqOptions)
获取部门列表，本接口用于依据指定条件，批量获取符合条件的部门详情列表。
|
FilterEmployeeResp |
Employee.filter(FilterEmployeeReq req,
RequestOptions reqOptions)
批量获取员工列表，本接口用于依据指定条件，批量获取符合条件的员工详情列表。
|
ListCollaborationRuleResp |
CollaborationRule.list(ListCollaborationRuleReq req,
RequestOptions reqOptions)
查询可搜可见规则，管理员视角查询可搜可见规则。
|
ListCollaborationTenantResp |
CollaborationTenant.list(ListCollaborationTenantReq req,
RequestOptions reqOptions)
管理员获取所有关联组织列表，在创建规则时，需要知道对方组织的tenant key，可通过该接口获取有效的tenant key。
|
ListCollborationShareEntityResp |
CollborationShareEntity.list(ListCollborationShareEntityReq req,
RequestOptions reqOptions)
获取关联组织双方共享成员范围，在创建规则时，需要获取本组织以及对方组织人员、部门和用户组的ID，且这些实体都应该在关联组织的共享范围内。
|
MgetDepartmentResp |
Department.mget(MgetDepartmentReq req,
RequestOptions reqOptions)
批量获取部门信息，该接口支持传入多个部门ID，返回每个部门的详细信息（如名称、负责人、子部门等）。
|
MgetEmployeeResp |
Employee.mget(MgetEmployeeReq req,
RequestOptions reqOptions)
批量获取员工信息，本接口用于批量根据员工的ID查询员工的详情，比如员工姓名，手机号，邮箱，部门等信息。
|
PatchDepartmentResp |
Department.patch(PatchDepartmentReq req,
RequestOptions reqOptions)
更新部门，本接口用于更新部门信息。
|
PatchEmployeeResp |
Employee.patch(PatchEmployeeReq req,
RequestOptions reqOptions)
更新员工信息，本接口用于更新在职/离职员工的信息、冻结/恢复员工。
|
RegularEmployeeResp |
Employee.regular(RegularEmployeeReq req,
RequestOptions reqOptions)
更新待离职成员为在职，本接口用于为待离职员工取消离职，将其更新为「在职」状态。
|
ResurrectEmployeeResp |
Employee.resurrect(ResurrectEmployeeReq req,
RequestOptions reqOptions)
恢复离职员工，该接口用于恢复已离职的成员，恢复已离职成员至在职状态。
|
SearchDepartmentResp |
Department.search(SearchDepartmentReq req,
RequestOptions reqOptions)
搜索部门，本接口用于搜索部门信息，通过部门名称等关键词搜索部门信息，返回符合条件的部门列表。
|
SearchEmployeeResp |
Employee.search(SearchEmployeeReq req,
RequestOptions reqOptions)
搜索员工信息，本接口用于搜索员工信息，如通过关键词搜索员工的名称、手机号、邮箱等信息。
|
ToBeResignedEmployeeResp |
Employee.toBeResigned(ToBeResignedEmployeeReq req,
RequestOptions reqOptions)
更新在职员工为待离职，本接口用于为在职员工办理离职，将其更新为「待离职」状态。
|
UpdateCollaborationRuleResp |
CollaborationRule.update(UpdateCollaborationRuleReq req,
RequestOptions reqOptions)
更新可搜可见规则，管理员视角更新可搜可见规则。
|
参数类型为RequestOptions的com.lark.oapi.service.document_ai.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
FieldExtractionContractResp |
Contract.fieldExtraction(FieldExtractionContractReq req,
RequestOptions reqOptions)
提取文件中的合同字段，支持从doc、docx和pdf文件类型中提取合同字段。
|
ParseResumeResp |
Resume.parse(ParseResumeReq req,
RequestOptions reqOptions)
识别文件中的简历信息，简历信息解析接口，支持PDF/DOCX/PNG/JPG四种文件类型的一次性的识别。
|
RecognizeBankCardResp |
BankCard.recognize(RecognizeBankCardReq req,
RequestOptions reqOptions)
识别文件中的银行卡，银行卡识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeBusinessCardResp |
BusinessCard.recognize(RecognizeBusinessCardReq req,
RequestOptions reqOptions)
识别文件中的名片，名片识别接口，通过上传 JPG / PNG / PDF 等文件类型进行一次性的名片识别。
|
RecognizeBusinessLicenseResp |
BusinessLicense.recognize(RecognizeBusinessLicenseReq req,
RequestOptions reqOptions)
识别文件中的营业执照，营业执照识别接口，支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。
|
RecognizeChinesePassportResp |
ChinesePassport.recognize(RecognizeChinesePassportReq req,
RequestOptions reqOptions)
识别文件中的中国护照，中国护照识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeDrivingLicenseResp |
DrivingLicense.recognize(RecognizeDrivingLicenseReq req,
RequestOptions reqOptions)
识别文件中的驾驶证，驾驶证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeFoodManageLicenseResp |
FoodManageLicense.recognize(RecognizeFoodManageLicenseReq req,
RequestOptions reqOptions)
识别文件中的食品经营许可证，食品经营许可证识别接口，支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。
|
RecognizeFoodProduceLicenseResp |
FoodProduceLicense.recognize(RecognizeFoodProduceLicenseReq req,
RequestOptions reqOptions)
识别文件中的食品生产许可证，食品生产许可证识别接口，支持JPG/JPEG/PNG/BMP/PDF五种文件类型的一次性的识别。
|
RecognizeHealthCertificateResp |
HealthCertificate.recognize(RecognizeHealthCertificateReq req,
RequestOptions reqOptions)
识别文件中的健康证，健康证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeHkmMainlandTravelPermitResp |
HkmMainlandTravelPermit.recognize(RecognizeHkmMainlandTravelPermitReq req,
RequestOptions reqOptions)
识别文件中的港澳居民来往内地通行证，港澳居民来往内地通行证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeIdCardResp |
IdCard.recognize(RecognizeIdCardReq req,
RequestOptions reqOptions)
识别文件中的身份证，身份证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeTaxiInvoiceResp |
TaxiInvoice.recognize(RecognizeTaxiInvoiceReq req,
RequestOptions reqOptions)
识别文件中的出租车发票，出租车发票识别接口，支持JPG/JPEG/PNG/PDF/OFD五种文件类型的一次性的识别。
|
RecognizeTrainInvoiceResp |
TrainInvoice.recognize(RecognizeTrainInvoiceReq req,
RequestOptions reqOptions)
识别文件中的火车票，火车票识别接口，支持JPG/JPEG/PNG/PDF/OFD五种文件类型的一次性的识别。
|
RecognizeTwMainlandTravelPermitResp |
TwMainlandTravelPermit.recognize(RecognizeTwMainlandTravelPermitReq req,
RequestOptions reqOptions)
识别文件中的台湾居民来往大陆通行证，台湾居民来往大陆通行证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeVatInvoiceResp |
VatInvoice.recognize(RecognizeVatInvoiceReq req,
RequestOptions reqOptions)
识别文件中的增值税发票，增值税发票识别接口，支持JPG/JPEG/PNG/PDF/BMP/OFD六种文件类型的一次性的识别。
|
RecognizeVehicleInvoiceResp |
VehicleInvoice.recognize(RecognizeVehicleInvoiceReq req,
RequestOptions reqOptions)
识别文件中的机动车发票，机动车发票识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
RecognizeVehicleLicenseResp |
VehicleLicense.recognize(RecognizeVehicleLicenseReq req,
RequestOptions reqOptions)
识别文件中的行驶证，行驶证识别接口，支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
|
参数类型为RequestOptions的com.lark.oapi.service.docx.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchDeleteChatAnnouncementBlockChildrenResp |
ChatAnnouncementBlockChildren.batchDelete(BatchDeleteChatAnnouncementBlockChildrenReq req,
RequestOptions reqOptions)
删除群公告中的块;，指定需要操作的块，删除其指定范围的子块。
|
BatchDeleteDocumentBlockChildrenResp |
DocumentBlockChildren.batchDelete(BatchDeleteDocumentBlockChildrenReq req,
RequestOptions reqOptions)
删除块，指定需要操作的块，删除其指定范围的子块。
|
BatchUpdateChatAnnouncementBlockResp |
ChatAnnouncementBlock.batchUpdate(BatchUpdateChatAnnouncementBlockReq req,
RequestOptions reqOptions)
批量更新群公告块的内容，批量更新块的富文本内容。
|
BatchUpdateDocumentBlockResp |
DocumentBlock.batchUpdate(BatchUpdateDocumentBlockReq req,
RequestOptions reqOptions)
批量更新块的内容，批量更新块的富文本内容。
|
ConvertDocumentResp |
Document.convert(ConvertDocumentReq req,
RequestOptions reqOptions)
Markdown/HTML 内容转换为文档块，将 Markdown/HTML 格式的内容转换为文档块，以便于将 Markdown/HTML
格式的内容插入到文档中。
|
CreateChatAnnouncementBlockChildrenResp |
ChatAnnouncementBlockChildren.create(CreateChatAnnouncementBlockChildrenReq req,
RequestOptions reqOptions)
在群公告中创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。
|
CreateDocumentBlockChildrenResp |
DocumentBlockChildren.create(CreateDocumentBlockChildrenReq req,
RequestOptions reqOptions)
创建块，在指定块的子块列表中，新创建一批子块，并放置到指定位置。
|
CreateDocumentBlockDescendantResp |
DocumentBlockDescendant.create(CreateDocumentBlockDescendantReq req,
RequestOptions reqOptions)
创建嵌套块，在指定块的子块列表中，新创建一批有父子关系的子块，并放置到指定位置。
|
CreateDocumentResp |
Document.create(CreateDocumentReq req,
RequestOptions reqOptions)
创建文档，创建文档类型为 docx 的文档。
|
GetChatAnnouncementBlockChildrenResp |
ChatAnnouncementBlockChildren.get(GetChatAnnouncementBlockChildrenReq req,
RequestOptions reqOptions)
获取所有子块;，获取群公告中指定块的所有子块的富文本内容并分页返回。
|
GetChatAnnouncementBlockResp |
ChatAnnouncementBlock.get(GetChatAnnouncementBlockReq req,
RequestOptions reqOptions)
获取群公告块的内容;，获取指定块的富文本内容。
|
GetChatAnnouncementResp |
ChatAnnouncement.get(GetChatAnnouncementReq req,
RequestOptions reqOptions)
获取群公告基本信息;，获取指定群组中的群公告基本信息。
|
GetDocumentBlockChildrenResp |
DocumentBlockChildren.get(GetDocumentBlockChildrenReq req,
RequestOptions reqOptions)
获取所有子块，获取文档中指定块的所有子块的富文本内容并分页返回。
|
GetDocumentBlockResp |
DocumentBlock.get(GetDocumentBlockReq req,
RequestOptions reqOptions)
获取块的内容，指定块的 block id 获取指定块的富文本内容数据。
|
GetDocumentResp |
Document.get(GetDocumentReq req,
RequestOptions reqOptions)
获取文档基本信息，获取文档标题和最新版本 ID。
|
ListChatAnnouncementBlockResp |
ChatAnnouncementBlock.list(ListChatAnnouncementBlockReq req,
RequestOptions reqOptions)
获取群公告所有块;，获取群公告所有块的富文本内容并分页返回。
|
ListDocumentBlockResp |
DocumentBlock.list(ListDocumentBlockReq req,
RequestOptions reqOptions)
获取文档所有块，获取文档所有块的富文本内容并分页返回。
|
PatchDocumentBlockResp |
DocumentBlock.patch(PatchDocumentBlockReq req,
RequestOptions reqOptions)
更新块的内容，更新指定块的内容。
|
RawContentDocumentResp |
Document.rawContent(RawContentDocumentReq req,
RequestOptions reqOptions)
获取文档纯文本内容，获取文档的纯文本内容。
|
参数类型为RequestOptions的com.lark.oapi.service.drive.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AuthPermissionMemberResp |
PermissionMember.auth(AuthPermissionMemberReq req,
RequestOptions reqOptions)
判断用户权限，判断当前请求的应用或用户是否具有指定云文档的指定权限，权限包括阅读、编辑、分享、评论、导出等权限。
|
BatchCreatePermissionMemberResp |
PermissionMember.batchCreate(BatchCreatePermissionMemberReq req,
RequestOptions reqOptions)
批量增加协作者权限，为指定云文档批量添加多个协作者，协作者可以是用户、群组、部门、用户组等。
|
BatchGetTmpDownloadUrlMediaResp |
Media.batchGetTmpDownloadUrl(BatchGetTmpDownloadUrlMediaReq req,
RequestOptions reqOptions)
获取素材临时下载链接，该接口用于获取云文档中素材的临时下载链接。
|
BatchQueryFileCommentResp |
FileComment.batchQuery(BatchQueryFileCommentReq req,
RequestOptions reqOptions)
批量获取评论，该接口用于根据评论 ID 列表批量获取云文档评论信息，包括评论和回复 ID、回复的内容、评论人和回复人的用户 ID 等。
|
BatchQueryMetaResp |
Meta.batchQuery(BatchQueryMetaReq req,
RequestOptions reqOptions)
获取文件元数据，该接口用于根据文件 token （文件的唯一标识）获取其元数据，包括标题、所有者、创建时间、密级、访问链接等数据。
|
CopyFileResp |
File.copy(CopyFileReq req,
RequestOptions reqOptions)
复制文件，将用户云空间中的文件复制至其它文件夹下。
|
CreateExportTaskResp |
ExportTask.create(CreateExportTaskReq req,
RequestOptions reqOptions)
创建导出任务，该接口用于创建导出文件的任务，并返回导出任务 ID。
|
CreateFileCommentReplyResp |
FileCommentReply.create(CreateFileCommentReplyReq req,
RequestOptions reqOptions)
添加回复，使用该接口可对云文档中的某条评论进行回复，回复内容支持普通文本、云文档链接等。
|
CreateFileCommentResp |
FileComment.create(CreateFileCommentReq req,
RequestOptions reqOptions)
添加全文评论，在文档中添加一条全局评论，不支持局部评论。
|
CreateFileSubscriptionResp |
FileSubscription.create(CreateFileSubscriptionReq req,
RequestOptions reqOptions)
|
CreateImportTaskResp |
ImportTask.create(CreateImportTaskReq req,
RequestOptions reqOptions)
创建导入任务，该接口用于创建导入文件的任务，并返回导入任务 ID。
|
CreatePermissionMemberResp |
PermissionMember.create(CreatePermissionMemberReq req,
RequestOptions reqOptions)
增加协作者权限，为指定云文档添加协作者，协作者可以是用户、群组、部门、用户组等。
|
CreatePermissionPublicPasswordResp |
PermissionPublicPassword.create(CreatePermissionPublicPasswordReq req,
RequestOptions reqOptions)
启用云文档密码，启用指定云文档的密码。
|
CreateFolderFileResp |
File.createFolder(CreateFolderFileReq req,
RequestOptions reqOptions)
新建文件夹，该接口用于在用户云空间指定文件夹中创建一个空文件夹。
|
CreateShortcutFileResp |
File.createShortcut(CreateShortcutFileReq req,
RequestOptions reqOptions)
创建文件快捷方式，创建指定文件的快捷方式到云空间的其它文件夹中。
|
DeleteFileCommentReplyResp |
FileCommentReply.delete(DeleteFileCommentReplyReq req,
RequestOptions reqOptions)
删除回复，删除云文档中的某条回复。
|
DeleteFileResp |
File.delete(DeleteFileReq req,
RequestOptions reqOptions)
删除文件或文件夹，删除用户在云空间内的文件或者文件夹。
|
DeleteFileVersionResp |
FileVersion.delete(DeleteFileVersionReq req,
RequestOptions reqOptions)
删除文档版本，删除基于在线文档或电子表格创建的版本。
|
DeletePermissionMemberResp |
PermissionMember.delete(DeletePermissionMemberReq req,
RequestOptions reqOptions)
移除协作者权限，通过云文档 token 和协作者 ID 移除指定云文档协作者的权限。
|
DeletePermissionPublicPasswordResp |
PermissionPublicPassword.delete(DeletePermissionPublicPasswordReq req,
RequestOptions reqOptions)
停用云文档密码，停用指定云文档的密码。
|
DeleteSubscribeFileResp |
File.deleteSubscribe(DeleteSubscribeFileReq req,
RequestOptions reqOptions)
取消云文档事件订阅，该接口用于取消订阅云文档的通知事件。
|
DownloadExportTaskResp |
ExportTask.download(DownloadExportTaskReq req,
RequestOptions reqOptions)
下载导出文件，根据[查询导出任务结果](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get)返回的导出文件的
token，下载导出产物到本地。
|
DownloadFileResp |
File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件，下载云空间中的文件，如 PDF 文件。
|
DownloadMediaResp |
Media.download(DownloadMediaReq req,
RequestOptions reqOptions)
下载素材，下载各类云文档中的素材，例如电子表格中的图片。
|
GetExportTaskResp |
ExportTask.get(GetExportTaskReq req,
RequestOptions reqOptions)
查询导出任务结果，根据[创建导出任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create)返回的导出任务
ID（ticket）轮询导出任务结果，并返回导出文件的 token。
|
GetFileCommentResp |
FileComment.get(GetFileCommentReq req,
RequestOptions reqOptions)
获取全文评论，获取云文档中的某条全文评论，不支持局部评论。
|
GetFileStatisticsResp |
FileStatistics.get(GetFileStatisticsReq req,
RequestOptions reqOptions)
获取文件统计信息，此接口用于获取各类文件的流量统计信息和互动信息，包括阅读人数、阅读次数和点赞数。
|
GetFileSubscriptionResp |
FileSubscription.get(GetFileSubscriptionReq req,
RequestOptions reqOptions)
|
GetImportTaskResp |
ImportTask.get(GetImportTaskReq req,
RequestOptions reqOptions)
查询导入结果，根据[创建导入任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create)返回的导入任务
ID（ticket）轮询导入结果。
|
GetPermissionPublicResp |
PermissionPublic.get(GetPermissionPublicReq req,
RequestOptions reqOptions)
获取云文档权限设置，获取指定云文档的权限设置，包括是否允许内容被分享到组织外、谁可以查看、添加、移除协作者等设置。
|
GetSubscribeFileResp |
File.getSubscribe(GetSubscribeFileReq req,
RequestOptions reqOptions)
查询云文档事件订阅状态，该接口用于查询云文档事件的订阅状态。
|
ListFileCommentReplyResp |
FileCommentReply.list(ListFileCommentReplyReq req,
RequestOptions reqOptions)
获取回复信息，该接口用于根据评论 ID，获取该条评论对应的回复信息，包括回复 ID、回复内容、回复人的用户 ID 等。
|
ListFileCommentResp |
FileComment.list(ListFileCommentReq req,
RequestOptions reqOptions)
获取云文档所有评论，该接口用于根据云文档 Token 分页获取文档所有评论信息，包括评论和回复 ID、回复的内容、评论人和回复人的用户 ID 等。
|
ListFileResp |
File.list(ListFileReq req,
RequestOptions reqOptions)
获取文件夹中的文件清单，该接口用于获取用户云空间指定文件夹中文件信息清单。
|
ListFileVersionResp |
FileVersion.list(ListFileVersionReq req,
RequestOptions reqOptions)
获取文档版本列表，获取文档或电子表格的版本列表。
|
ListFileViewRecordResp |
FileViewRecord.list(ListFileViewRecordReq req,
RequestOptions reqOptions)
获取文件访问记录，获取文档、电子表格、多维表格等文件的历史访问记录，包括访问者的 ID、姓名、头像和最近访问时间。
|
ListPermissionMemberResp |
PermissionMember.list(ListPermissionMemberReq req,
RequestOptions reqOptions)
获取云文档协作者，获取指定云文档的协作者，支持查询人、群、组织架构、用户组、知识库成员五种类型的协作者。
|
MoveFileResp |
File.move(MoveFileReq req,
RequestOptions reqOptions)
移动文件或文件夹，将文件或者文件夹移动到用户云空间的其他位置。
|
PatchFileCommentResp |
FileComment.patch(PatchFileCommentReq req,
RequestOptions reqOptions)
解决/恢复评论，解决或恢复云文档中的评论。
|
PatchFileSubscriptionResp |
FileSubscription.patch(PatchFileSubscriptionReq req,
RequestOptions reqOptions)
|
RemoveSubscriptionUserResp |
User.removeSubscription(RemoveSubscriptionUserReq req,
RequestOptions reqOptions)
取消用户云文档事件订阅，该接口用于取消订阅用户云文档的通知事件。
|
SubscribeFileResp |
File.subscribe(SubscribeFileReq req,
RequestOptions reqOptions)
订阅云文档事件，订阅云文档的各类通知事件。
|
SubscriptionUserResp |
User.subscription(SubscriptionUserReq req,
RequestOptions reqOptions)
订阅用户云文档事件，订阅用户云文档的各类通知事件，调用后目前可获取接收者视角的云文档评论、回复添加事件。
|
SubscriptionStatusUserResp |
User.subscriptionStatus(SubscriptionStatusUserReq req,
RequestOptions reqOptions)
查询用户云文档事件订阅状态，该接口用于查询用户云文档事件的订阅状态。
|
TaskCheckFileResp |
File.taskCheck(TaskCheckFileReq req,
RequestOptions reqOptions)
查询异步任务状态，查询异步任务的状态信息。
|
TransferOwnerPermissionMemberResp |
PermissionMember.transferOwner(TransferOwnerPermissionMemberReq req,
RequestOptions reqOptions)
转移云文档所有者，转移指定云文档的所有者。
|
UpdateFileCommentReplyResp |
FileCommentReply.update(UpdateFileCommentReplyReq req,
RequestOptions reqOptions)
更新回复的内容，更新云文档中的某条回复的内容。
|
UpdatePermissionMemberResp |
PermissionMember.update(UpdatePermissionMemberReq req,
RequestOptions reqOptions)
更新协作者权限，更新指定云文档中指定协作者的权限，包括可阅读、可编辑、可管理权限。
|
UpdatePermissionPublicPasswordResp |
PermissionPublicPassword.update(UpdatePermissionPublicPasswordReq req,
RequestOptions reqOptions)
刷新云文档密码，刷新指定云文档的密码。
|
UploadAllFileResp |
File.uploadAll(UploadAllFileReq req,
RequestOptions reqOptions)
上传文件，将指定文件上传至云空间指定目录中。
|
UploadAllMediaResp |
Media.uploadAll(UploadAllMediaReq req,
RequestOptions reqOptions)
上传素材，将文件、图片、视频等素材上传到指定云文档中。
|
UploadFinishFileResp |
File.uploadFinish(UploadFinishFileReq req,
RequestOptions reqOptions)
分片上传文件-完成上传，调用[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)接口将分片全部上传完毕后，你需调用本接口触发完成上传。
|
UploadFinishMediaResp |
Media.uploadFinish(UploadFinishMediaReq req,
RequestOptions reqOptions)
分片上传素材-完成上传，调用[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part)接口将分片全部上传完毕后，你需调用本接口触发完成上传。
|
UploadPartFileResp |
File.uploadPart(UploadPartFileReq req,
RequestOptions reqOptions)
分片上传文件-上传分片，根据
[预上传](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare)接口返回的上传事务
ID
和分片策略上传对应的文件分片。
|
UploadPartMediaResp |
Media.uploadPart(UploadPartMediaReq req,
RequestOptions reqOptions)
分片上传素材-上传分片，根据
[预上传](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare)接口返回的上传事务
ID 和分片策略上传对应的素材分片。
|
UploadPrepareFileResp |
File.uploadPrepare(UploadPrepareFileReq req,
RequestOptions reqOptions)
分片上传文件-预上传，发送初始化请求，以获取上传事务 ID
和分片策略，为[上传分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part)做准备。
|
UploadPrepareMediaResp |
Media.uploadPrepare(UploadPrepareMediaReq req,
RequestOptions reqOptions)
分片上传素材-预上传，发送初始化请求，以获取上传事务 ID
和分片策略，为[上传素材分片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part)做准备。
|
参数类型为RequestOptions的com.lark.oapi.service.helpdesk.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AgentEmailAgentResp |
Agent.agentEmail(RequestOptions reqOptions)
获取客服邮箱，该接口用于获取客服邮箱地址。
|
AnswerUserQueryTicketResp |
Ticket.answerUserQuery(AnswerUserQueryTicketReq req,
RequestOptions reqOptions)
回复用户在工单里的提问，该接口用于回复用户提问结果至工单，需要工单仍处于进行中且未接入人工状态。
|
CancelApproveNotificationResp |
Notification.cancelApprove(CancelApproveNotificationReq req,
RequestOptions reqOptions)
取消审核，提交审核后，如果需要取消审核，则调用此接口。
|
CancelSendNotificationResp |
Notification.cancelSend(CancelSendNotificationReq req,
RequestOptions reqOptions)
取消推送，取消推送接口，审核通过后待调度可以调用，发送过程中可以调用（会撤回已发送的消息），发送完成后可以需要推送（会撤回所有已发送的消息）。
|
CreateAgentScheduleResp |
AgentSchedule.create(CreateAgentScheduleReq req,
RequestOptions reqOptions)
创建客服工作日程，该接口用于创建客服日程。
|
CreateAgentSkillResp |
AgentSkill.create(CreateAgentSkillReq req,
RequestOptions reqOptions)
创建客服技能，该接口用于创建客服技能。
|
CreateBotMessageResp |
BotMessage.create(CreateBotMessageReq req,
RequestOptions reqOptions)
服务台机器人向工单绑定的群内发送消息，通过服务台机器人给指定用户的服务台专属群或私聊发送消息，支持文本、富文本、卡片、图片。
|
CreateCategoryResp |
Category.create(CreateCategoryReq req,
RequestOptions reqOptions)
创建知识库分类，该接口用于创建知识库分类。
|
CreateFaqResp |
Faq.create(CreateFaqReq req,
RequestOptions reqOptions)
创建知识库，该接口用于创建知识库。
|
CreateNotificationResp |
Notification.create(CreateNotificationReq req,
RequestOptions reqOptions)
创建推送，调用接口创建推送，创建成功后为草稿状态。
|
CreateTicketCustomizedFieldResp |
TicketCustomizedField.create(CreateTicketCustomizedFieldReq req,
RequestOptions reqOptions)
|
CustomizedFieldsTicketResp |
Ticket.customizedFields(CustomizedFieldsTicketReq req,
RequestOptions reqOptions)
获取服务台自定义字段，该接口用于获取服务台自定义字段详情。
|
DeleteAgentSchedulesResp |
AgentSchedules.delete(DeleteAgentSchedulesReq req,
RequestOptions reqOptions)
删除客服工作日程，该接口用于删除客服日程。
|
DeleteAgentSkillResp |
AgentSkill.delete(DeleteAgentSkillReq req,
RequestOptions reqOptions)
删除客服技能，该接口用于删除客服技能。
|
DeleteCategoryResp |
Category.delete(DeleteCategoryReq req,
RequestOptions reqOptions)
删除知识库分类详情，该接口用于删除知识库分类详情。
|
DeleteFaqResp |
Faq.delete(DeleteFaqReq req,
RequestOptions reqOptions)
删除知识库，该接口用于删除知识库。
|
DeleteTicketCustomizedFieldResp |
TicketCustomizedField.delete(DeleteTicketCustomizedFieldReq req,
RequestOptions reqOptions)
删除工单自定义字段，该接口用于删除工单自定义字段。
|
ExecuteSendNotificationResp |
Notification.executeSend(ExecuteSendNotificationReq req,
RequestOptions reqOptions)
执行推送，审核通过后调用此接口设置推送时间，等待调度系统调度，发送消息。
|
FaqImageFaqResp |
Faq.faqImage(FaqImageFaqReq req,
RequestOptions reqOptions)
获取知识库图像，该接口用于获取知识库图像。
|
GetAgentSchedulesResp |
AgentSchedules.get(GetAgentSchedulesReq req,
RequestOptions reqOptions)
查询指定客服工作日程，该接口用于获取客服信息。
|
GetAgentSkillResp |
AgentSkill.get(GetAgentSkillReq req,
RequestOptions reqOptions)
查询指定客服技能，该接口用于获取客服技能。
|
GetCategoryResp |
Category.get(GetCategoryReq req,
RequestOptions reqOptions)
获取知识库分类，该接口用于获取知识库分类。
|
GetFaqResp |
Faq.get(GetFaqReq req,
RequestOptions reqOptions)
获取指定知识库详情，该接口用于获取服务台知识库详情。
|
GetNotificationResp |
Notification.get(GetNotificationReq req,
RequestOptions reqOptions)
查询推送，查询推送详情。
|
GetTicketCustomizedFieldResp |
TicketCustomizedField.get(GetTicketCustomizedFieldReq req,
RequestOptions reqOptions)
|
ListAgentScheduleResp |
AgentSchedule.list(ListAgentScheduleReq req,
RequestOptions reqOptions)
查询全部客服工作日程，该接口用于获取所有客服信息。
|
ListCategoryResp |
Category.list(ListCategoryReq req,
RequestOptions reqOptions)
|
ListTicketCustomizedFieldResp |
TicketCustomizedField.list(ListTicketCustomizedFieldReq req,
RequestOptions reqOptions)
|
ListTicketResp |
Ticket.list(ListTicketReq req,
RequestOptions reqOptions)
查询全部工单详情，该接口用于获取全部工单详情。
|
ListAgentSkillResp |
AgentSkill.list(RequestOptions reqOptions)
查询全部客服技能，获取全部客服技能。
|
ListAgentSkillRuleResp |
AgentSkillRule.list(RequestOptions reqOptions)
获取客服技能列表，该接口用于获取全部客服技能。
|
PatchAgentResp |
Agent.patch(PatchAgentReq req,
RequestOptions reqOptions)
更新客服信息，更新客服状态等信息。
|
PatchAgentSchedulesResp |
AgentSchedules.patch(PatchAgentSchedulesReq req,
RequestOptions reqOptions)
更新客服工作日程，该接口用于更新客服的日程。
|
PatchAgentSkillResp |
AgentSkill.patch(PatchAgentSkillReq req,
RequestOptions reqOptions)
更新客服技能，该接口用于更新客服技能。
|
PatchCategoryResp |
Category.patch(PatchCategoryReq req,
RequestOptions reqOptions)
更新知识库分类详情，该接口用于更新知识库分类详情。
|
PatchFaqResp |
Faq.patch(PatchFaqReq req,
RequestOptions reqOptions)
修改知识库，该接口用于修改知识库。
|
PatchNotificationResp |
Notification.patch(PatchNotificationReq req,
RequestOptions reqOptions)
更新推送，更新推送信息，只有在草稿状态下才可以调用此接口进行更新。
|
PatchTicketCustomizedFieldResp |
TicketCustomizedField.patch(PatchTicketCustomizedFieldReq req,
RequestOptions reqOptions)
|
SearchFaqResp |
Faq.search(SearchFaqReq req,
RequestOptions reqOptions)
搜索知识库，该接口用于搜索服务台知识库。
|
StartServiceTicketResp |
Ticket.startService(StartServiceTicketReq req,
RequestOptions reqOptions)
创建服务台对话，该接口用于创建服务台对话。
|
SubmitApproveNotificationResp |
Notification.submitApprove(SubmitApproveNotificationReq req,
RequestOptions reqOptions)
提交审核，正常情况下调用创建推送接口后，就可以调用提交审核接口，如果创建人是服务台owner则会自动审核通过，否则会通知服务台owner审核此推送信息。
|
SubscribeEventResp |
Event.subscribe(SubscribeEventReq req,
RequestOptions reqOptions)
订阅服务台事件，本接口用于订阅服务台事件。
|
TicketImageTicketResp |
Ticket.ticketImage(TicketImageTicketReq req,
RequestOptions reqOptions)
获取工单内图像，该接口用于获取服务台工单消息图象。
|
UnsubscribeEventResp |
Event.unsubscribe(UnsubscribeEventReq req,
RequestOptions reqOptions)
取消订阅服务台事件，本接口用于取消订阅服务台事件。
|
UpdateTicketResp |
Ticket.update(UpdateTicketReq req,
RequestOptions reqOptions)
更新工单详情，该接口用于更新服务台工单详情。
|
参数类型为RequestOptions的com.lark.oapi.service.hire.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AddToFolderTalentResp |
Talent.addToFolder(AddToFolderTalentReq req,
RequestOptions reqOptions)
将人才加入指定文件夹，根据人才 ID 列表将人才加入指定文件夹。
|
BatchChangeTalentPoolTalentPoolResp |
TalentPool.batchChangeTalentPool(BatchChangeTalentPoolTalentPoolReq req,
RequestOptions reqOptions)
批量加入/移除人才库中人才，对于同一个人才库，可批量执行人才加入或移除操作;;- 执行加入操作：当传入不存在人才 ID 时，接口会报错返回不存在人才 ID 列表。
|
BatchDeleteEcoAccountCustomFieldResp |
EcoAccountCustomField.batchDelete(BatchDeleteEcoAccountCustomFieldReq req,
RequestOptions reqOptions)
删除账号自定义字段，飞书招聘的背调或笔试服务商，可通过此接口删除账号自定义字段（如客户在服务商处的租户 ID、账号 ID等）。
|
BatchDeleteEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.batchDelete(BatchDeleteEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
删除背调自定义字段，删除用户在发起背调时展示的表单自定义字段。
|
BatchDeleteEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.batchDelete(BatchDeleteEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
删除背调套餐和附加调查项，删除背调帐号下的背调套餐和附加调查项信息。
|
BatchDeleteEcoExamPaperResp |
EcoExamPaper.batchDelete(BatchDeleteEcoExamPaperReq req,
RequestOptions reqOptions)
删除试卷列表，飞书招聘的笔试服务商，可通过该接口删除客户笔试帐号下的试卷列表。
|
BatchGetIdTalentResp |
Talent.batchGetId(BatchGetIdTalentReq req,
RequestOptions reqOptions)
批量获取人才ID，通过手机号、邮箱、证件号，批量查询人才ID
- 入参的手机号、邮箱、证件号至少需要传一种，否则无法查询到人才数据;- 入参的手机号、邮箱、证件号是AND的逻辑关系。
|
BatchQueryAgencyResp |
Agency.batchQuery(BatchQueryAgencyReq req,
RequestOptions reqOptions)
搜索猎头供应商列表，可根据猎头供应商 ID 列表或关键字、筛选项查询供应商信息。
|
BatchQueryBackgroundCheckOrderResp |
BackgroundCheckOrder.batchQuery(BatchQueryBackgroundCheckOrderReq req,
RequestOptions reqOptions)
查询背调信息列表，可根据背调 ID 列表或投递 ID 等过滤条件查询背调订单信息。
|
BatchQueryExternalBackgroundCheckResp |
ExternalBackgroundCheck.batchQuery(BatchQueryExternalBackgroundCheckReq req,
RequestOptions reqOptions)
查询外部背调列表，可根据外部投递 ID 或外部背调 ID 列表查询外部背调信息。
|
BatchQueryExternalInterviewResp |
ExternalInterview.batchQuery(BatchQueryExternalInterviewReq req,
RequestOptions reqOptions)
查询外部面试列表，可根据外部投递 ID 或外部面试 ID 列表查询外部面试信息。
|
BatchQueryExternalOfferResp |
ExternalOffer.batchQuery(BatchQueryExternalOfferReq req,
RequestOptions reqOptions)
查询外部 Offer 列表，可根据外部投递 ID 或外部 Offer ID 列表查询外部 Offer 信息。
|
BatchUpdateEcoAccountCustomFieldResp |
EcoAccountCustomField.batchUpdate(BatchUpdateEcoAccountCustomFieldReq req,
RequestOptions reqOptions)
更新账号自定义字段，飞书招聘的背调或笔试服务商，可通过此接口更新账号自定义字段（比如客户在服务商处的租户 ID、账号 ID等）的名称和描述。
|
BatchUpdateEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.batchUpdate(BatchUpdateEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
更新背调自定义字段，更新用户在发起背调时展示的表单自定义字段名称和描述。
|
BatchUpdateEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.batchUpdate(BatchUpdateEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
更新背调套餐和附加调查项，更新指定背调帐号下的背调套餐和附加调查项信息。
|
BatchUpdateEcoExamPaperResp |
EcoExamPaper.batchUpdate(BatchUpdateEcoExamPaperReq req,
RequestOptions reqOptions)
更新试卷列表，飞书招聘的笔试服务商，可通过该接口更新客户笔试账号下的试卷列表。
|
BatchUpdateJobManagerResp |
JobManager.batchUpdate(BatchUpdateJobManagerReq req,
RequestOptions reqOptions)
更新职位相关人员，更新职位相关人员，包含招聘负责人、招聘协助人、用人经理。
|
CancelEcoBackgroundCheckResp |
EcoBackgroundCheck.cancel(CancelEcoBackgroundCheckReq req,
RequestOptions reqOptions)
终止背调订单，调用此接口将会将背调订单状态变成已终止，已终止订单将将无法通过[更新背调订单进度](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_progress)和[回传背调订单的最终结果](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_background_check/update_result)修改订单进度和最终结果。
|
CancelOnboardApplicationResp |
Application.cancelOnboard(CancelOnboardApplicationReq req,
RequestOptions reqOptions)
取消候选人入职，取消待入职状态的候选人入职。
|
ChangeTalentBlockTalentBlocklistResp |
TalentBlocklist.changeTalentBlock(ChangeTalentBlockTalentBlocklistReq req,
RequestOptions reqOptions)
加入/移除屏蔽名单，根据人才 ID 将人才加入或移除屏蔽名单。
|
CloseJobResp |
Job.close(CloseJobReq req,
RequestOptions reqOptions)
关闭职位，关闭职位后，职位所有的职位广告将同步从官网、内推、猎头渠道下线。
|
CombinedCreateJobResp |
Job.combinedCreate(CombinedCreateJobReq req,
RequestOptions reqOptions)
新建职位，创建一个新的职位。
|
CombinedCreateTalentResp |
Talent.combinedCreate(CombinedCreateTalentReq req,
RequestOptions reqOptions)
创建人才，用于在企业内创建一个人才。
|
CombinedUpdateJobResp |
Job.combinedUpdate(CombinedUpdateJobReq req,
RequestOptions reqOptions)
更新职位，更新职位信息。
|
CombinedUpdateTalentResp |
Talent.combinedUpdate(CombinedUpdateTalentReq req,
RequestOptions reqOptions)
更新人才，用于在企业内更新一个人才。
|
ConfigJobResp |
Job.config(ConfigJobReq req,
RequestOptions reqOptions)
获取职位设置，获取职位设置，包含 Offer 申请表、Offer
审批流程、建议评估人列表、面试评价表、建议面试官列表、招聘需求、面试登记表、入职登记表、面试轮次类型列表、关联职位列表等设置。
|
CreateApplicationResp |
Application.create(CreateApplicationReq req,
RequestOptions reqOptions)
|
CreateEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.create(CreateEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
创建背调自定义字段，创建用户在发起背调时展示的表单自定义字段。
|
CreateEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.create(CreateEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
创建背调套餐和附加调查项，在指定背调帐号下创建可用的背调套餐列表和附加调查项信息列表。
|
CreateEcoExamPaperResp |
EcoExamPaper.create(CreateEcoExamPaperReq req,
RequestOptions reqOptions)
创建试卷列表，飞书招聘的笔试服务商，在完成[账号绑定](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_account/events/created)后，可通过本接口在客户的笔试帐号下创建试卷列表。
|
CreateExamResp |
Exam.create(CreateExamReq req,
RequestOptions reqOptions)
添加笔试结果，根据投递 ID 添加该投递下的笔试结果。
|
CreateExternalApplicationResp |
ExternalApplication.create(CreateExternalApplicationReq req,
RequestOptions reqOptions)
创建外部投递，创建外部投递，可用于导入来自其他系统的投递信息。
|
CreateExternalBackgroundCheckResp |
ExternalBackgroundCheck.create(CreateExternalBackgroundCheckReq req,
RequestOptions reqOptions)
创建外部背调，创建外部背调，可用于导入来自其他系统的背调信息。
|
CreateExternalInterviewAssessmentResp |
ExternalInterviewAssessment.create(CreateExternalInterviewAssessmentReq req,
RequestOptions reqOptions)
创建外部面评，导入来自其他系统的面评信息，创建为外部面评。
|
CreateExternalInterviewResp |
ExternalInterview.create(CreateExternalInterviewReq req,
RequestOptions reqOptions)
创建外部面试，创建外部面试，可用于导入来自其他系统的面试信息。
|
CreateExternalOfferResp |
ExternalOffer.create(CreateExternalOfferReq req,
RequestOptions reqOptions)
创建外部 Offer，创建外部 Offer，可用于导入来自其他系统的 Offer 信息。
|
CreateExternalReferralRewardResp |
ExternalReferralReward.create(CreateExternalReferralRewardReq req,
RequestOptions reqOptions)
导入外部内推奖励，支持将外部的内推奖励（积分/现金）导入到招聘的「内推账号」中
官网API文档链接:
CreateJobRequirementResp |
JobRequirement.create(CreateJobRequirementReq req,
RequestOptions reqOptions)
创建招聘需求，创建招聘需求，可指定招聘需求部门、招聘人数、需求描述等，具体可参考「飞书招聘」-「设置」-「招聘需求字段管理」，或者参考[获取招聘需求模板](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement_schema/list)。
|
|
CreateNoteResp |
Note.create(CreateNoteReq req,
RequestOptions reqOptions)
创建备注，为人才创建备注信息，支持在备注中@其他用户。
|
CreateOfferResp |
Offer.create(CreateOfferReq req,
RequestOptions reqOptions)
创建 Offer，传入 Offer 基本信息，创建 Offer。
|
CreateReferralAccountResp |
ReferralAccount.create(CreateReferralAccountReq req,
RequestOptions reqOptions)
注册内推账户，通过内推人的手机号或邮箱注册「内推奖励账户」。
|
CreateTalentExternalInfoResp |
TalentExternalInfo.create(CreateTalentExternalInfoReq req,
RequestOptions reqOptions)
创建人才外部信息，创建外部人才，可将已存在人才标记为外部人才，并写入外部系统创建时间。
|
CreateTripartiteAgreementResp |
TripartiteAgreement.create(CreateTripartiteAgreementReq req,
RequestOptions reqOptions)
创建三方协议，在校招投递上创建三方协议。
|
CreateWebsiteChannelResp |
WebsiteChannel.create(CreateWebsiteChannelReq req,
RequestOptions reqOptions)
新建招聘官网推广渠道，新建指定官网的推广渠道。
|
CreateWebsiteSiteUserResp |
WebsiteSiteUser.create(CreateWebsiteSiteUserReq req,
RequestOptions reqOptions)
新建招聘官网用户，注册指定招聘官网的用户，注册完成后，可通过[根据简历附件创建招聘官网投递任务](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_attachment)创建官网投递任务，或通过[新建招聘官网投递](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/website-delivery/create_by_resume)创建官网投递
官网API文档链接:
CreateAttachmentResp |
Attachment.create(RequestOptions reqOptions)
| |
CreateByResumeWebsiteDeliveryResp |
WebsiteDelivery.createByResume(CreateByResumeWebsiteDeliveryReq req,
RequestOptions reqOptions)
新建招聘官网投递，新建招聘官网投递。
|
DeactivateReferralAccountResp |
ReferralAccount.deactivate(DeactivateReferralAccountReq req,
RequestOptions reqOptions)
停用内推账户，停用内推账户，停用后，将不再发送[「内推账户余额变更事件」](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/events/assets_update)，也无法通过[「提取内推账号余额」](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/withdraw)提取。
|
DeleteExternalApplicationResp |
ExternalApplication.delete(DeleteExternalApplicationReq req,
RequestOptions reqOptions)
删除外部投递，根据外部投递 ID 删除外部投递。
|
DeleteExternalBackgroundCheckResp |
ExternalBackgroundCheck.delete(DeleteExternalBackgroundCheckReq req,
RequestOptions reqOptions)
删除外部背调，根据外部背调 ID 删除外部背调。
|
DeleteExternalInterviewResp |
ExternalInterview.delete(DeleteExternalInterviewReq req,
RequestOptions reqOptions)
删除外部面试，根据外部面试 ID 删除外部面试。
|
DeleteExternalOfferResp |
ExternalOffer.delete(DeleteExternalOfferReq req,
RequestOptions reqOptions)
删除外部 Offer，根据外部 Offer ID 删除外部 Offer。
|
DeleteExternalReferralRewardResp |
ExternalReferralReward.delete(DeleteExternalReferralRewardReq req,
RequestOptions reqOptions)
删除外部内推奖励，根据外部内推奖励ID删除外部内推奖励。
|
DeleteJobRequirementResp |
JobRequirement.delete(DeleteJobRequirementReq req,
RequestOptions reqOptions)
删除招聘需求，删除指定的招聘需求，请注意：若该招聘需求已经关联到职位上，则需先接触关联后，才能删除招聘需求。
|
DeleteNoteResp |
Note.delete(DeleteNoteReq req,
RequestOptions reqOptions)
删除备注，根据备注 ID 删除备注。
|
DeleteTripartiteAgreementResp |
TripartiteAgreement.delete(DeleteTripartiteAgreementReq req,
RequestOptions reqOptions)
删除三方协议，删除投递的三方协议。
|
DeleteWebsiteChannelResp |
WebsiteChannel.delete(DeleteWebsiteChannelReq req,
RequestOptions reqOptions)
删除招聘官网推广渠道，根据招聘官网 ID 和推广渠道 ID 删除推广渠道。
|
EnableReferralAccountResp |
ReferralAccount.enable(EnableReferralAccountReq req,
RequestOptions reqOptions)
启用内推账户;，根据账户 ID
启用账户，启用后可通过[「内推账户余额变更事件」](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/events/assets_update)监听余额变更、通过[「全额提取内推账户余额」](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/referral_account/withdraw)提取余额。
|
GetAgencyResp |
Agency.get(GetAgencyReq req,
RequestOptions reqOptions)
获取猎头供应商信息，根据猎头供应商 ID 获取有合作关系的猎头供应商信息，包含猎头供应商ID、名称、联系人等。
|
GetApplicationResp |
Application.get(GetApplicationReq req,
RequestOptions reqOptions)
|
GetEmployeeResp |
Employee.get(GetEmployeeReq req,
RequestOptions reqOptions)
通过员工 ID 获取入职信息，通过员工 ID 获取入职信息。
|
GetInterviewRecordAttachmentResp |
InterviewRecordAttachment.get(GetInterviewRecordAttachmentReq req,
RequestOptions reqOptions)
获取面试记录附件，获取面试记录 PDF 附件，包含相关投递基本信息、面试评价信息。
|
GetInterviewRecordResp |
InterviewRecord.get(GetInterviewRecordReq req,
RequestOptions reqOptions)
获取面试评价详细信息，获取面试评价详细信息，如面试结论、面试得分和面试官等信息。
|
GetJobManagerResp |
JobManager.get(GetJobManagerReq req,
RequestOptions reqOptions)
获取职位上的招聘人员信息，根据职位 ID 获取职位上的招聘人员信息，如招聘负责人、用人经理。
|
GetJobResp |
Job.get(GetJobReq req,
RequestOptions reqOptions)
|
GetOfferApplicationFormResp |
OfferApplicationForm.get(GetOfferApplicationFormReq req,
RequestOptions reqOptions)
获取 Offer 申请表信息，根据 Offer 申请表 ID 获取 Offer 申请表信息，可获取到的信息包括申请表名称、申请表模块、申请表字段等。
|
GetOfferResp |
Offer.get(GetOfferReq req,
RequestOptions reqOptions)
获取 Offer 详情，根据 Offer ID 获取 Offer 详细信息。
|
GetOfferSchemaResp |
OfferSchema.get(GetOfferSchemaReq req,
RequestOptions reqOptions)
|
GetRoleResp |
Role.get(GetRoleReq req,
RequestOptions reqOptions)
|
GetWebsiteJobPostResp |
WebsiteJobPost.get(GetWebsiteJobPostReq req,
RequestOptions reqOptions)
获取招聘官网下职位广告详情，获取招聘官网下的职位广告详情，包含职位广告 ID、名称、关联职位 ID、关联职位编码等信息。
|
GetAccountAssetsReferralAccountResp |
ReferralAccount.getAccountAssets(GetAccountAssetsReferralAccountReq req,
RequestOptions reqOptions)
查询内推账户，根据账户 ID 查询内推账户信息。
|
GetAgencyAccountAgencyResp |
Agency.getAgencyAccount(GetAgencyAccountAgencyReq req,
RequestOptions reqOptions)
查询猎头供应商下猎头列表，根据猎头供应商 ID 查询该猎头供应商下的猎头列表。
|
GetByApplicationEmployeeResp |
Employee.getByApplication(GetByApplicationEmployeeReq req,
RequestOptions reqOptions)
通过投递 ID 获取入职信息，通过投递 ID 获取员工入职信息。
|
GetByApplicationReferralResp |
Referral.getByApplication(GetByApplicationReferralReq req,
RequestOptions reqOptions)
获取内推信息，根据投递 ID 获取内推信息，包含内推人信息、内推创建时间等。
|
GetByTalentInterviewResp |
Interview.getByTalent(GetByTalentInterviewReq req,
RequestOptions reqOptions)
获取人才面试信息，获取人才下所有面试信息。
|
GetDetailApplicationResp |
Application.getDetail(GetDetailApplicationReq req,
RequestOptions reqOptions)
获取投递详情，根据投递 ID 获取投递信息并通过参数按需获取该投递相关的实体信息，如「职位」、「人才」、「评估」、「面试」、「Offer」、「猎头」、「内推」、「官网」等实体的信息。
|
GetDetailJobResp |
Job.getDetail(GetDetailJobReq req,
RequestOptions reqOptions)
获取职位详情，根据职位 ID 获取职位详情，包含职位基本信息、职位负责人、协助人、用人经理、职位地址列表、职位设置、关联招需、门店列表及标签列表等信息。
|
InternOfferStatusOfferResp |
Offer.internOfferStatus(InternOfferStatusOfferReq req,
RequestOptions reqOptions)
更新实习 Offer 入/离职状态，对「实习待入职」状态的实习 Offer 确认入职、放弃入职，或对「实习已入职」状态的实习 Offer 操作离职。
|
ListApplicationInterviewResp |
ApplicationInterview.list(ListApplicationInterviewReq req,
RequestOptions reqOptions)
|
ListEvaluationResp |
Evaluation.list(ListEvaluationReq req,
RequestOptions reqOptions)
获取简历评估信息列表，批量获取简历评估信息，包含评估人、评估结论、评估详情等信息。
|
ListEvaluationTaskResp |
EvaluationTask.list(ListEvaluationTaskReq req,
RequestOptions reqOptions)
获取简历评估任务列表，根据评估人ID查询评估任务列表，可以查询到的信息包括：评估ID、投递ID、任务状态等。
|
ListExamMarkingTaskResp |
ExamMarkingTask.list(ListExamMarkingTaskReq req,
RequestOptions reqOptions)
获取笔试阅卷任务列表，根据阅卷人ID查询员工笔试阅卷任务列表，能查询到的信息包括：笔试阅卷任务ID、投递ID、任务状态等。
|
ListExternalApplicationResp |
ExternalApplication.list(ListExternalApplicationReq req,
RequestOptions reqOptions)
查询外部投递列表，可根据人才 ID 获取人才外部投递列表。
|
ListInterviewerResp |
Interviewer.list(ListInterviewerReq req,
RequestOptions reqOptions)
查询面试官信息列表，分页查询面试官列表，接口只会返回执行过「更新面试官信息」用户的数据，通过接口查询不到的数据则默认为「未认证」面试官。
|
ListInterviewFeedbackFormResp |
InterviewFeedbackForm.list(ListInterviewFeedbackFormReq req,
RequestOptions reqOptions)
获取面试评价表列表，获取面试评价表信息列表，评价表信息包括题目描述、题目选项等。
|
ListInterviewRecordResp |
InterviewRecord.list(ListInterviewRecordReq req,
RequestOptions reqOptions)
批量获取面试评价详细信息，批量获取面试评价详细信息，如面试结论、面试得分和面试官等信息。
|
ListInterviewRegistrationSchemaResp |
InterviewRegistrationSchema.list(ListInterviewRegistrationSchemaReq req,
RequestOptions reqOptions)
|
ListInterviewRoundTypeResp |
InterviewRoundType.list(ListInterviewRoundTypeReq req,
RequestOptions reqOptions)
获取面试轮次类型列表，根据职位流程查询面试轮次类型列表，可以查询到的信息包括：面试轮次类型名称、启用状态、关联的面试评价表信息。
|
ListInterviewTaskResp |
InterviewTask.list(ListInterviewTaskReq req,
RequestOptions reqOptions)
|
ListJobRequirementResp |
JobRequirement.list(ListJobRequirementReq req,
RequestOptions reqOptions)
获取招聘需求列表，获取招聘需求列表。
|
ListJobRequirementSchemaResp |
JobRequirementSchema.list(ListJobRequirementSchemaReq req,
RequestOptions reqOptions)
获取招聘需求模板列表，获取招聘需求模板列表，包含需求模板ID，以及模板里的字段定义等。
|
ListJobSchemaResp |
JobSchema.list(ListJobSchemaReq req,
RequestOptions reqOptions)
获取职位模板，获取社招、校招职位模板中的职位字段，返回结果包括系统默认字段和自定义字段。
|
ListJobTypeResp |
JobType.list(ListJobTypeReq req,
RequestOptions reqOptions)
获取职位类别列表，获取招聘系统预置的职位类别列表，可用于操作职位（如[新建职位](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/combined_create)），操作招聘需求（如[创建招聘需求](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_requirement/create)）时回填职位类别字段。
|
ListLocationResp |
Location.list(ListLocationReq req,
RequestOptions reqOptions)
获取地址列表，获取地址列表，可查询到的信息包括地址与地点信息，可应用在职位地点、面试地点、人才意向工作城市等场景。
|
ListNoteResp |
Note.list(ListNoteReq req,
RequestOptions reqOptions)
获取备注列表，根据人才ID获取备注列表。
|
ListOfferApplicationFormResp |
OfferApplicationForm.list(ListOfferApplicationFormReq req,
RequestOptions reqOptions)
获取 Offer 申请表列表，获取 Offer 申请表列表，可获取的信息包括申请表名称、创建时间等。
|
ListOfferApprovalTemplateResp |
OfferApprovalTemplate.list(ListOfferApprovalTemplateReq req,
RequestOptions reqOptions)
获取 Offer 审批流列表，获取飞书招聘系统中默认和自定义 Offer 审批流列表。
|
ListOfferResp |
Offer.list(ListOfferReq req,
RequestOptions reqOptions)
获取 Offer 列表，根据人才 ID 获取 Offer 列表。
|
ListPortalApplySchemaResp |
PortalApplySchema.list(ListPortalApplySchemaReq req,
RequestOptions reqOptions)
获取申请表模板列表，获取招聘官网申请表模板列表，在官网申请职位时，申请表需按照官网申请表模板的格式进行填写。
|
ListQuestionnaireResp |
Questionnaire.list(ListQuestionnaireReq req,
RequestOptions reqOptions)
获取面试满意度问卷列表，批量获取面试满意度问卷信息，包含问卷完成情况、问卷题目及问卷题目作答内容等信息。
|
ListReferralWebsiteJobPostResp |
ReferralWebsiteJobPost.list(ListReferralWebsiteJobPostReq req,
RequestOptions reqOptions)
获取内推官网下职位广告列表，获取内推官网下的职位列表，包含职位广告ID、职位广告名称、职位信息等。
|
ListRegistrationSchemaResp |
RegistrationSchema.list(ListRegistrationSchemaReq req,
RequestOptions reqOptions)
|
ListRoleResp |
Role.list(ListRoleReq req,
RequestOptions reqOptions)
获取角色列表，根据 page_token 与 page_size 对权限角色进行游标分页查询，可查询到的信息包括：权限角色ID、角色名、角色描述。
|
ListSubjectResp |
Subject.list(ListSubjectReq req,
RequestOptions reqOptions)
获取项目列表，获取项目列表（概念上一批集体启动和管理的职位可以定义为一个项目，例如 「2012 秋招项目」）。
|
ListTalentFolderResp |
TalentFolder.list(ListTalentFolderReq req,
RequestOptions reqOptions)
获取人才文件夹列表，获取招聘系统中人才文件夹信息列表，包括文件夹 ID、文件夹名称、文件夹所有者 ID。
|
ListTalentResp |
Talent.list(ListTalentReq req,
RequestOptions reqOptions)
获取人才列表，批量获取人才摘要信息，包括人才
ID、人才基信息、教育经历、工作经历等。
|
ListTalentTagResp |
TalentTag.list(ListTalentTagReq req,
RequestOptions reqOptions)
获取人才标签信息列表，可通过关键词、ID 列表、标签类型、停用状态等获取人才标签信息列表，结果按照创建时间倒序排序。
|
ListTerminationReasonResp |
TerminationReason.list(ListTerminationReasonReq req,
RequestOptions reqOptions)
获取终止投递原因，获取系统中默认的投递终止原因以及用户配置的自定义投递终止原因。
|
ListTodoResp |
Todo.list(ListTodoReq req,
RequestOptions reqOptions)
批量获取待办事项，批量获取当前用户的待办事项信息，包含评估待办事项、面试待办事项、笔试待办事项和 Offer 待办事项。
|
ListTripartiteAgreementResp |
TripartiteAgreement.list(ListTripartiteAgreementReq req,
RequestOptions reqOptions)
获取三方协议，根据三方协议 ID 或投递 ID 获取三方协议信息，如三方协议状态、创建时间等信息。
|
ListUserRoleResp |
UserRole.list(ListUserRoleReq req,
RequestOptions reqOptions)
|
ListWebsiteJobPostResp |
WebsiteJobPost.list(ListWebsiteJobPostReq req,
RequestOptions reqOptions)
获取招聘官网下的职位广告列表，获取招聘官网下的职位信息列表。
|
ListWebsiteResp |
Website.list(ListWebsiteReq req,
RequestOptions reqOptions)
获取招聘官网列表，获取招聘官网列表，返回信息包括官网名称、官网ID、招聘渠道ID等。
|
ListByIdJobRequirementResp |
JobRequirement.listById(ListByIdJobRequirementReq req,
RequestOptions reqOptions)
获取招聘需求信息，根据「招聘需求ID」获取招聘需求信息，支持批量查询。
|
LoginInfoEcoExamResp |
EcoExam.loginInfo(LoginInfoEcoExamReq req,
RequestOptions reqOptions)
回传笔试安排结果，飞书招聘的笔试服务商，在收到[创建笔试](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/eco_exam/events/created)事件并安排笔试后，应通过本接口;回传笔试安排结果。
|
MoveTalentTalentPoolResp |
TalentPool.moveTalent(MoveTalentTalentPoolReq req,
RequestOptions reqOptions)
将人才加入人才库，将人才加入人才库。
|
OfferApplicationResp |
Application.offer(OfferApplicationReq req,
RequestOptions reqOptions)
|
OnboardStatusTalentResp |
Talent.onboardStatus(OnboardStatusTalentReq req,
RequestOptions reqOptions)
更新人才在职状态，更新人才的在职状态，可进行的操作包括入职与离职。
|
OpenJobResp |
Job.open(OpenJobReq req,
RequestOptions reqOptions)
重启职位，对于已关闭的职位，可通过本接口重启职位。
|
OperateAgencyAccountAgencyResp |
Agency.operateAgencyAccount(OperateAgencyAccountAgencyReq req,
RequestOptions reqOptions)
禁用/取消禁用猎头，可根据猎头 ID 对猎头执行禁用/取消禁用操作。
|
PatchEhrImportTaskResp |
EhrImportTask.patch(PatchEhrImportTaskReq req,
RequestOptions reqOptions)
更新 e-HR 导入任务结果，在处理完[导入
e-HR](;https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/event/import-ehr)事件后，可调用该接口，更新
e-HR 导入任务结果。
|
PatchEmployeeResp |
Employee.patch(PatchEmployeeReq req,
RequestOptions reqOptions)
更新员工状态，根据员工 ID 更新员工招聘系统内的转正、离职状态。
|
PatchExternalInterviewAssessmentResp |
ExternalInterviewAssessment.patch(PatchExternalInterviewAssessmentReq req,
RequestOptions reqOptions)
|
PreviewAttachmentResp |
Attachment.preview(PreviewAttachmentReq req,
RequestOptions reqOptions)
获取人才简历附件 PDF 格式下载链接，根据人才简历附件 ID 获取该简历附件对应的 PDF 文件的下载地址。
|
ProtectAgencyResp |
Agency.protect(ProtectAgencyReq req,
RequestOptions reqOptions)
设置猎头保护期，设置指定人才的猎头保护期，当「飞书招聘」内置的保护期功能不满足需求时，客户可通过此接口自定义人才的保护期。
|
ProtectSearchAgencyResp |
Agency.protectSearch(ProtectSearchAgencyReq req,
RequestOptions reqOptions)
查询人才猎头保护期信息，查询指定人才的猎头保护期信息列表，包含保护期起止时间、猎头供应商、猎头顾问信息等。
|
PublishAdvertisementResp |
Advertisement.publish(PublishAdvertisementReq req,
RequestOptions reqOptions)
发布职位广告，支持把职位广告发布上线至招聘官网、内推平台。
|
QueryAgencyResp |
Agency.query(QueryAgencyReq req,
RequestOptions reqOptions)
查询猎头供应商信息，根据猎头供应商名称查询有合作关系的猎头供应商信息，包含猎头供应商ID、名称、联系人等。
|
QueryLocationResp |
Location.query(QueryLocationReq req,
RequestOptions reqOptions)
查询地点列表，根据地点类型和地点码查询地点列表，获取地点名称信息。
|
QueryTalentObjectResp |
TalentObject.query(RequestOptions reqOptions)
获取人才字段，获取全部人才字段详细信息，包含字段名称、字段描述、字段类型、启用状态等信息。
|
ReconciliationReferralAccountResp |
ReferralAccount.reconciliation(ReconciliationReferralAccountReq req,
RequestOptions reqOptions)
内推账户提现数据对账，对一段时间内的内推账户积分提现数据进行对账，调用方需传入调用方系统的内推账户积分变动信息。
|
RecoverApplicationResp |
Application.recover(RecoverApplicationReq req,
RequestOptions reqOptions)
恢复投递，根据投递 ID 将「已终止」投递进行恢复。
|
RecruiterJobResp |
Job.recruiter(RecruiterJobReq req,
RequestOptions reqOptions)
获取职位上的招聘人员信息，根据职位 ID 获取职位上的招聘人员信息，如招聘负责人、用人经理等。
|
RemoveToFolderTalentResp |
Talent.removeToFolder(RemoveToFolderTalentReq req,
RequestOptions reqOptions)
将人才从指定文件夹移除，根据人才 ID 列表将人才从指定文件夹移除。
|
SearchDiversityInclusionResp |
DiversityInclusion.search(SearchDiversityInclusionReq req,
RequestOptions reqOptions)
获取申请表附加信息，获取候选人的申请表附加信息。
|
SearchJobPublishRecordResp |
JobPublishRecord.search(SearchJobPublishRecordReq req,
RequestOptions reqOptions)
获取职位广告发布记录，根据招聘渠道 ID 获取当前渠道下曾发布过的职位广告信息。
|
SearchReferralResp |
Referral.search(SearchReferralReq req,
RequestOptions reqOptions)
查询内推信息，根据人才查询内推信息列表，包含内推人信息、内推时间、投递 ID等，按内推投递的`创建时间`从小到大排序返回。
|
SearchTalentOperationLogResp |
TalentOperationLog.search(SearchTalentOperationLogReq req,
RequestOptions reqOptions)
查询人才操作记录，根据操作人和操作类型查询人才的操作记录。
|
SearchTalentPoolResp |
TalentPool.search(SearchTalentPoolReq req,
RequestOptions reqOptions)
获取人才库列表，获取人才库列表，可获取的信息包括人才库 ID、人才库名称等。
|
SearchTestResp |
Test.search(SearchTestReq req,
RequestOptions reqOptions)
获取笔试列表，批量获取人才在投递流程中的笔试信息。
|
SearchWebsiteJobPostResp |
WebsiteJobPost.search(SearchWebsiteJobPostReq req,
RequestOptions reqOptions)
搜索招聘官网下的职位广告列表，搜索招聘官网下的职位列表。
|
TagTalentResp |
Talent.tag(TagTalentReq req,
RequestOptions reqOptions)
操作人才标签，可为人才新增、删除标签。
|
TerminateApplicationResp |
Application.terminate(TerminateApplicationReq req,
RequestOptions reqOptions)
|
UpdateExternalApplicationResp |
ExternalApplication.update(UpdateExternalApplicationReq req,
RequestOptions reqOptions)
更新外部投递，更新外部投递信息。
|
UpdateExternalBackgroundCheckResp |
ExternalBackgroundCheck.update(UpdateExternalBackgroundCheckReq req,
RequestOptions reqOptions)
更新外部背调，更新外部背调信息。
|
UpdateExternalInterviewResp |
ExternalInterview.update(UpdateExternalInterviewReq req,
RequestOptions reqOptions)
更新外部面试，更新外部面试信息。
|
UpdateExternalOfferResp |
ExternalOffer.update(UpdateExternalOfferReq req,
RequestOptions reqOptions)
更新外部 Offer，更新外部 Offer 信息。
|
UpdateJobRequirementResp |
JobRequirement.update(UpdateJobRequirementReq req,
RequestOptions reqOptions)
更新招聘需求，更新指定招聘需求的信息，包含招聘需求的名称、状态、需求人数等。
|
UpdateOfferCustomFieldResp |
OfferCustomField.update(UpdateOfferCustomFieldReq req,
RequestOptions reqOptions)
更新 Offer 申请表自定义字段，本接口支持修改 Offer 申请表的自定义字段，Offer 申请表的定义可参考「飞书招聘」-「设置」-「Offer 设置」-「Offer
申请表设置」中的内容。
|
UpdateOfferResp |
Offer.update(UpdateOfferReq req,
RequestOptions reqOptions)
更新 Offer 信息，更新 Offer 信息，包含基本信息、薪资信息、自定义信息。
|
UpdateTalentExternalInfoResp |
TalentExternalInfo.update(UpdateTalentExternalInfoReq req,
RequestOptions reqOptions)
更新人才外部信息，更新人才外部信息，包含外部系统创建时间。
|
UpdateTripartiteAgreementResp |
TripartiteAgreement.update(UpdateTripartiteAgreementReq req,
RequestOptions reqOptions)
更新三方协议，更新三方协议的状态及修改时间信息。
|
UpdateWebsiteChannelResp |
WebsiteChannel.update(UpdateWebsiteChannelReq req,
RequestOptions reqOptions)
更新招聘官网推广渠道，根据招聘官网 ID 和推广渠道 ID 更改推广渠道，仅支持修改推广渠道名称。
|
UpdateConfigJobResp |
Job.updateConfig(UpdateConfigJobReq req,
RequestOptions reqOptions)
更新职位设置，更新职位设置，包括面试评价表、Offer 申请表等。
|
UpdateProgressEcoBackgroundCheckResp |
EcoBackgroundCheck.updateProgress(UpdateProgressEcoBackgroundCheckReq req,
RequestOptions reqOptions)
更新背调订单进度，更新指定背调订单的进度信息和阶段性报告，进度信息将会被展示在「飞书招聘」-「投递详情页」-「背调卡片」上，告知用户目前背调订单的流转状态。
|
UpdateResultEcoBackgroundCheckResp |
EcoBackgroundCheck.updateResult(UpdateResultEcoBackgroundCheckReq req,
RequestOptions reqOptions)
回传背调订单的最终结果，回传背调的最终结果和终版报告。
|
UpdateResultEcoExamResp |
EcoExam.updateResult(UpdateResultEcoExamReq req,
RequestOptions reqOptions)
回传笔试结果，飞书招聘的笔试服务商，可通过该接口回传候选人的笔试结果。
|
WithdrawReferralAccountResp |
ReferralAccount.withdraw(WithdrawReferralAccountReq req,
RequestOptions reqOptions)
全额提取内推账户余额，通过账户 ID 全额提取内推账户下的积分/现金。
|
参数类型为RequestOptions的com.lark.oapi.service.im.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AddManagersChatManagersResp |
ChatManagers.addManagers(AddManagersChatManagersReq req,
RequestOptions reqOptions)
指定群管理员，指定群组，将群内指定的用户或者机器人设置为群管理员。
|
BatchQueryMessageReactionResp |
MessageReaction.batchQuery(BatchQueryMessageReactionReq req,
RequestOptions reqOptions)
批量获取消息表情回复，支持批量分页的获取消息上的表情详情、支持批量获取消息上表情的统计
## 前提条件;;-
应用身份调用接口需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。
|
CreateChatMembersResp |
ChatMembers.create(CreateChatMembersReq req,
RequestOptions reqOptions)
将用户或机器人拉入群聊，把指定的用户或机器人拉入指定群聊内。
|
CreateChatMenuTreeResp |
ChatMenuTree.create(CreateChatMenuTreeReq req,
RequestOptions reqOptions)
添加群菜单，在指定群组中添加一个或多个群菜单。
|
CreateChatResp |
Chat.create(CreateChatReq req,
RequestOptions reqOptions)
创建群，创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。
|
CreateChatTabResp |
ChatTab.create(CreateChatTabReq req,
RequestOptions reqOptions)
添加会话标签页，在指定会话内添加自定义会话标签页，仅支持添加文档类型（doc）或 URL （url）类型的标签页。
|
CreateFileResp |
File.create(CreateFileReq req,
RequestOptions reqOptions)
上传文件，调用该接口将本地文件上传至开放平台，支持上传音频、视频、文档等文件类型。
|
CreateImageResp |
Image.create(CreateImageReq req,
RequestOptions reqOptions)
上传图片，调用本接口将图片上传至飞书开放平台，支持上传 JPG、JPEG、PNG、WEBP、GIF、BMP、ICO、TIFF、HEIC 格式的图片，但需要注意 TIFF、HEIC
上传后会被转为 JPG 格式。
|
CreateMessageReactionResp |
MessageReaction.create(CreateMessageReactionReq req,
RequestOptions reqOptions)
添加消息表情回复，给指定消息添加指定类型的表情回复。
|
CreateMessageResp |
Message.create(CreateMessageReq req,
RequestOptions reqOptions)
发送消息，调用该接口向指定用户或者群聊发送消息。
|
CreatePinResp |
Pin.create(CreatePinReq req,
RequestOptions reqOptions)
Pin 消息，Pin 一条指定的消息。
|
DeleteBatchMessageResp |
BatchMessage.delete(DeleteBatchMessageReq req,
RequestOptions reqOptions)
批量撤回消息，该接口用于撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息。
|
DeleteChatMembersResp |
ChatMembers.delete(DeleteChatMembersReq req,
RequestOptions reqOptions)
将用户或机器人移出群聊，将指定的用户或机器人从群聊中移出。
|
DeleteChatMenuTreeResp |
ChatMenuTree.delete(DeleteChatMenuTreeReq req,
RequestOptions reqOptions)
删除群菜单，删除指定群内的一级菜单。
|
DeleteChatResp |
Chat.delete(DeleteChatReq req,
RequestOptions reqOptions)
解散群，通过 chat_id 解散指定群组。
|
DeleteMessageReactionResp |
MessageReaction.delete(DeleteMessageReactionReq req,
RequestOptions reqOptions)
删除消息表情回复，删除指定消息的某一表情回复。
|
DeleteMessageResp |
Message.delete(DeleteMessageReq req,
RequestOptions reqOptions)
撤回消息，调用该接口撤回指定消息。
|
DeletePinResp |
Pin.delete(DeletePinReq req,
RequestOptions reqOptions)
移除 Pin 消息，移除一条指定消息的 Pin。
|
DeleteManagersChatManagersResp |
ChatManagers.deleteManagers(DeleteManagersChatManagersReq req,
RequestOptions reqOptions)
删除群管理员，指定群组，删除群组内指定的管理员，包括用户类型的管理员和机器人类型的管理员。
|
DeleteTabsChatTabResp |
ChatTab.deleteTabs(DeleteTabsChatTabReq req,
RequestOptions reqOptions)
删除会话标签页，删除指定会话内的一个或多个会话标签页。
|
DeleteTopNoticeChatTopNoticeResp |
ChatTopNotice.deleteTopNotice(DeleteTopNoticeChatTopNoticeReq req,
RequestOptions reqOptions)
撤销群置顶，撤销指定群组中的置顶消息或群公告。
|
ForwardMessageResp |
Message.forward(ForwardMessageReq req,
RequestOptions reqOptions)
转发消息，调用该接口将一条指定的消息转发给用户、群聊或话题。
|
ForwardThreadResp |
Thread.forward(ForwardThreadReq req,
RequestOptions reqOptions)
转发话题，调用该接口将话题转发至指定的用户、群聊或话题。
|
GetChatAnnouncementResp |
ChatAnnouncement.get(GetChatAnnouncementReq req,
RequestOptions reqOptions)
获取群公告信息，获取指定群组中的群公告信息，公告信息格式与[旧版云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
GetChatMembersResp |
ChatMembers.get(GetChatMembersReq req,
RequestOptions reqOptions)
获取群成员列表，获取指定群组的成员信息，包括成员名字与 ID。
|
GetChatMenuTreeResp |
ChatMenuTree.get(GetChatMenuTreeReq req,
RequestOptions reqOptions)
获取群菜单，获取指定群组内的群菜单信息，包括所有一级或二级菜单的名称、跳转链接、图标等信息。
|
GetChatModerationResp |
ChatModeration.get(GetChatModerationReq req,
RequestOptions reqOptions)
获取群成员发言权限，获取指定群组的发言模式、可发言用户名单等信息。
|
GetChatResp |
Chat.get(GetChatReq req,
RequestOptions reqOptions)
获取群信息，获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。
|
GetFileResp |
File.get(GetFileReq req,
RequestOptions reqOptions)
下载文件，通过已上传文件的 Key 下载文件。
|
GetImageResp |
Image.get(GetImageReq req,
RequestOptions reqOptions)
下载图片，通过已上传图片的 Key 值下载图片。
|
GetMessageResp |
Message.get(GetMessageReq req,
RequestOptions reqOptions)
获取指定消息的内容，调用该接口通过消息的 `message_id` 查询消息内容。
|
GetMessageResourceResp |
MessageResource.get(GetMessageResourceReq req,
RequestOptions reqOptions)
获取消息中的资源文件，获取指定消息内包含的资源文件，包括音频、视频、图片和文件。
|
GetProgressBatchMessageResp |
BatchMessage.getProgress(GetProgressBatchMessageReq req,
RequestOptions reqOptions)
查询批量消息整体进度，[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)或者[批量撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete)后，可通过该接口查询消息的发送进度和撤回进度。
|
IsInChatChatMembersResp |
ChatMembers.isInChat(IsInChatChatMembersReq req,
RequestOptions reqOptions)
判断用户或机器人是否在群里，根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。
|
LinkChatResp |
Chat.link(LinkChatReq req,
RequestOptions reqOptions)
获取群分享链接，获取指定群的分享链接，他人点击分享链接后可加入群组。
|
ListChatResp |
Chat.list(ListChatReq req,
RequestOptions reqOptions)
获取用户或机器人所在的群列表，获取
[access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
所代表的用户或者机器人所在的群列表。
|
ListMessageReactionResp |
MessageReaction.list(ListMessageReactionReq req,
RequestOptions reqOptions)
获取消息表情回复，获取指定消息内的表情回复列表
## 前提条件;;-
应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。
|
ListMessageResp |
Message.list(ListMessageReq req,
RequestOptions reqOptions)
获取会话历史消息，获取指定会话（包括单聊、群组）内的历史消息（即聊天记录）。
|
ListPinResp |
Pin.list(ListPinReq req,
RequestOptions reqOptions)
获取群内 Pin 消息，获取指定群、指定时间范围内的所有 Pin 消息。
|
ListTabsChatTabResp |
ChatTab.listTabs(ListTabsChatTabReq req,
RequestOptions reqOptions)
拉取会话标签页，获取指定会话内的会话标签页信息，包括 ID、名称、类型以及内容等。
|
MeJoinChatMembersResp |
ChatMembers.meJoin(MeJoinChatMembersReq req,
RequestOptions reqOptions)
用户或机器人主动加入群聊，将当前调用接口的操作者（用户或机器人）加入指定群聊。
|
MergeForwardMessageResp |
Message.mergeForward(MergeForwardMessageReq req,
RequestOptions reqOptions)
合并转发消息，将来自同一个会话内的多条消息，合并转发给指定的用户、群聊或话题。
|
PatchChatAnnouncementResp |
ChatAnnouncement.patch(PatchChatAnnouncementReq req,
RequestOptions reqOptions)
更新群公告信息，更新指定群组中的群公告信息。
|
PatchChatMenuItemResp |
ChatMenuItem.patch(PatchChatMenuItemReq req,
RequestOptions reqOptions)
修改群菜单元信息，修改指定群组内的某个一级菜单或者二级菜单的元信息，包括图标、名称、国际化名称和跳转链接。
|
PatchMessageResp |
Message.patch(PatchMessageReq req,
RequestOptions reqOptions)
更新已发送的消息卡片，通过消息 ID（message_id）更新已发送的消息卡片的内容。
|
PushFollowUpMessageResp |
Message.pushFollowUp(PushFollowUpMessageReq req,
RequestOptions reqOptions)
添加跟随气泡，调用该接口在最新一条消息下方添加气泡样式的内容，当消息接收者点击气泡或者新消息到达后，气泡消失。
|
PutTopNoticeChatTopNoticeResp |
ChatTopNotice.putTopNotice(PutTopNoticeChatTopNoticeReq req,
RequestOptions reqOptions)
更新群置顶，更新群组中的群置顶信息，可以将群中的某一条消息，或群公告置顶展示。
|
ReadUserBatchMessageResp |
BatchMessage.readUser(ReadUserBatchMessageReq req,
RequestOptions reqOptions)
查询批量消息推送和阅读人数，[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)后，可通过该接口查询消息推送的总人数以及消息已读人数。
|
ReadUsersMessageResp |
Message.readUsers(ReadUsersMessageReq req,
RequestOptions reqOptions)
消息发送者查询消息已读状态，作为消息发送者，查询指定消息是否已读。
|
ReplyMessageResp |
Message.reply(ReplyMessageReq req,
RequestOptions reqOptions)
回复消息，调用该接口回复指定消息。
|
SearchChatResp |
Chat.search(SearchChatReq req,
RequestOptions reqOptions)
搜索对用户或机器人可见的群列表，获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。
|
SearchMessageResp |
Message.search(SearchMessageReq req,
RequestOptions reqOptions)
搜索消息，用户可以通过关键字搜索可见消息，可见性和套件内搜索一致。
|
SortChatMenuTreeResp |
ChatMenuTree.sort(SortChatMenuTreeReq req,
RequestOptions reqOptions)
排序群菜单，调整指定群组内的群菜单排列顺序，成功调用后接口会返回群组内所有群菜单信息。
|
SortTabsChatTabResp |
ChatTab.sortTabs(SortTabsChatTabReq req,
RequestOptions reqOptions)
会话标签页排序，调整指定会话内的多个会话标签页排列顺序。
|
UpdateChatModerationResp |
ChatModeration.update(UpdateChatModerationReq req,
RequestOptions reqOptions)
更新群发言权限，更新指定群组的发言权限，可设置为所有群成员可发言、仅群主或管理员可发言、指定群成员可发言。
|
UpdateChatResp |
Chat.update(UpdateChatReq req,
RequestOptions reqOptions)
更新群信息，更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。
|
UpdateMessageResp |
Message.update(UpdateMessageReq req,
RequestOptions reqOptions)
编辑消息，调用该接口编辑已发送的消息内容，支持编辑文本、富文本消息。
|
UpdateTabsChatTabResp |
ChatTab.updateTabs(UpdateTabsChatTabReq req,
RequestOptions reqOptions)
更新会话标签页，更新指定的会话标签页信息，包括名称、类型以及内容等。
|
UrgentAppMessageResp |
Message.urgentApp(UrgentAppMessageReq req,
RequestOptions reqOptions)
发送应用内加急，调用该接口把指定消息加急给目标用户，加急仅在飞书客户端内通知。
|
UrgentPhoneMessageResp |
Message.urgentPhone(UrgentPhoneMessageReq req,
RequestOptions reqOptions)
发送电话加急，调用该接口把指定消息加急给目标用户，加急将通过飞书客户端和电话进行通知。
|
UrgentSmsMessageResp |
Message.urgentSms(UrgentSmsMessageReq req,
RequestOptions reqOptions)
发送短信加急，调用该接口把指定消息加急给目标用户，加急将通过飞书客户端和短信进行通知。
|
参数类型为RequestOptions的com.lark.oapi.service.im.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchUpdateUrlPreviewResp |
UrlPreview.batchUpdate(BatchUpdateUrlPreviewReq req,
RequestOptions reqOptions)
更新 URL 预览，该接口用于主动更新 [URL
预览](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/development-link-preview/link-preview-development-guide)，调用后会重新触发一次客户端拉取，需要回调服务返回更新后的数据。
|
BotTimeSentiveFeedCardResp |
FeedCard.botTimeSentive(BotTimeSentiveFeedCardReq req,
RequestOptions reqOptions)
机器人单聊会话即时提醒，可将机器人对话在消息列表中置顶展示，打开飞书首页即可处理重要任务。
|
CreateAppFeedCardResp |
AppFeedCard.create(CreateAppFeedCardReq req,
RequestOptions reqOptions)
创建应用消息流卡片，应用消息流卡片是飞书为应用提供的消息触达能力，让应用可以直接在消息流发送消息，重要消息能更快触达用户。
|
CreateBizEntityTagRelationResp |
BizEntityTagRelation.create(CreateBizEntityTagRelationReq req,
RequestOptions reqOptions)
绑定标签到群，绑定标签到业务实体。
|
CreateTagResp |
Tag.create(CreateTagReq req,
RequestOptions reqOptions)
创建标签，创建标签并返回标签 ID。
|
DeleteAppFeedCardBatchResp |
AppFeedCardBatch.delete(DeleteAppFeedCardBatchReq req,
RequestOptions reqOptions)
|
PatchTagResp |
Tag.patch(PatchTagReq req,
RequestOptions reqOptions)
修改标签，修改标签在各个语言下的名称。
|
SearchChatResp |
Chat.search(SearchChatReq req,
RequestOptions reqOptions)
搜索群组，用户可以通过关键字搜索可见群组，可见性和套件内搜索一致。
|
UpdateAppFeedCardBatchResp |
AppFeedCardBatch.update(UpdateAppFeedCardBatchReq req,
RequestOptions reqOptions)
更新应用消息流卡片，该接口用于更新消息流卡片的头像、标题、预览、标签状态、按钮等信息
**字段更新策略**：具体更新的字段以 `update_fields` 为准，根据 `update_fields` 代表的字段从 `app_feed_card` 中取出来进行更新，不在
`update_fields` 中的字段不会更新。
|
UpdateBizEntityTagRelationResp |
BizEntityTagRelation.update(UpdateBizEntityTagRelationReq req,
RequestOptions reqOptions)
解绑标签与群，从业务实体上解绑标签。
|
UpdateChatButtonResp |
ChatButton.update(UpdateChatButtonReq req,
RequestOptions reqOptions)
更新消息流卡片按钮，为群组消息、机器人消息的消息流卡片添加、更新、删除快捷操作按钮。
|
参数类型为RequestOptions的com.lark.oapi.service.lingo.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateDraftResp |
Draft.create(CreateDraftReq req,
RequestOptions reqOptions)
创建草稿，草稿并非词条，而是指通过 API 发起创建新词条或更新现有词条的申请。
|
CreateEntityResp |
Entity.create(CreateEntityReq req,
RequestOptions reqOptions)
创建免审词条，通过此接口创建的词条，无需经过词典管理员审核，直接写入词库。
|
DeleteEntityResp |
Entity.delete(DeleteEntityReq req,
RequestOptions reqOptions)
删除免审词条，通过 entity_id 删除已有的词条，无需经过词典管理员审核。
|
DownloadFileResp |
File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载图片，通过 file_token 下载原图片。
|
GetEntityResp |
Entity.get(GetEntityReq req,
RequestOptions reqOptions)
获取词条详情，通过词条 id 拉取对应的词条详情信息。
|
HighlightEntityResp |
Entity.highlight(HighlightEntityReq req,
RequestOptions reqOptions)
词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现词条智能高亮。
|
ListClassificationResp |
Classification.list(ListClassificationReq req,
RequestOptions reqOptions)
获取词典分类，获取飞书词典当前分类。
|
ListEntityResp |
Entity.list(ListEntityReq req,
RequestOptions reqOptions)
获取词条列表，分页拉取词条列表数据，支持拉取租户内(或指定词库内)的全部词条。
|
ListRepoResp |
Repo.list(RequestOptions reqOptions)
获取词库列表，获取有权限访问的飞书词典词库列表。
|
MatchEntityResp |
Entity.match(MatchEntityReq req,
RequestOptions reqOptions)
精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。
|
SearchEntityResp |
Entity.search(SearchEntityReq req,
RequestOptions reqOptions)
模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。
|
UpdateDraftResp |
Draft.update(UpdateDraftReq req,
RequestOptions reqOptions)
更新草稿，根据 draft_id 更新草稿内容，已审批的草稿无法编辑。
|
UpdateEntityResp |
Entity.update(UpdateEntityReq req,
RequestOptions reqOptions)
更新免审词条，通过此接口更新已有的词条，无需经过词典管理员审核，直接写入词库。
|
UploadFileResp |
File.upload(UploadFileReq req,
RequestOptions reqOptions)
上传图片，词条图片资源上传。
|
参数类型为RequestOptions的com.lark.oapi.service.mail.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AccessibleMailboxesUserMailboxResp |
UserMailbox.accessibleMailboxes(AccessibleMailboxesUserMailboxReq req,
RequestOptions reqOptions)
|
BatchCreateMailgroupMemberResp |
MailgroupMember.batchCreate(BatchCreateMailgroupMemberReq req,
RequestOptions reqOptions)
批量创建邮件组成员，一次请求可以给一个邮件组添加多个成员。
|
BatchCreateMailgroupPermissionMemberResp |
MailgroupPermissionMember.batchCreate(BatchCreateMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
批量创建邮件组权限成员，一次请求可以给一个邮件组添加多个权限成员。
|
BatchCreatePublicMailboxMemberResp |
PublicMailboxMember.batchCreate(BatchCreatePublicMailboxMemberReq req,
RequestOptions reqOptions)
批量添加公共邮箱成员，一次请求可以给一个公共邮箱添加多个成员。
|
BatchDeleteMailgroupManagerResp |
MailgroupManager.batchDelete(BatchDeleteMailgroupManagerReq req,
RequestOptions reqOptions)
批量删除邮件组管理员，批量删除邮件组管理员。
|
BatchDeleteMailgroupMemberResp |
MailgroupMember.batchDelete(BatchDeleteMailgroupMemberReq req,
RequestOptions reqOptions)
批量删除邮件组成员，一次请求可以删除一个邮件组中的多个成员。
|
BatchDeleteMailgroupPermissionMemberResp |
MailgroupPermissionMember.batchDelete(BatchDeleteMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
批量删除邮件组权限成员，一次请求可以删除一个邮件组中的多个权限成员。
|
BatchDeletePublicMailboxMemberResp |
PublicMailboxMember.batchDelete(BatchDeletePublicMailboxMemberReq req,
RequestOptions reqOptions)
批量删除公共邮箱成员，一次请求可以删除一个公共邮箱中的多个成员。
|
BatchGetUserMailboxMessageResp |
UserMailboxMessage.batchGet(BatchGetUserMailboxMessageReq req,
RequestOptions reqOptions)
批量获取邮件详情，通过指定邮件ID，获取对应邮件的标签、文件夹、摘要、正文、html、附件等信息。
|
BatchModifyUserMailboxMessageResp |
UserMailboxMessage.batchModify(BatchModifyUserMailboxMessageReq req,
RequestOptions reqOptions)
批量修改邮件，批量修改邮件标签、所属文件夹、已读未读状态，可进行加旗标、归档、移至垃圾邮件等操作。
|
BatchModifyUserMailboxThreadResp |
UserMailboxThread.batchModify(BatchModifyUserMailboxThreadReq req,
RequestOptions reqOptions)
批量修改邮件会话，批量修改邮件会话的标签、所属文件夹和已读未读状态，支持为邮件会话添加旗标、归档、移入垃圾邮件文件夹。
|
BatchTrashUserMailboxMessageResp |
UserMailboxMessage.batchTrash(BatchTrashUserMailboxMessageReq req,
RequestOptions reqOptions)
|
CreateMailgroupAliasResp |
MailgroupAlias.create(CreateMailgroupAliasReq req,
RequestOptions reqOptions)
创建邮件组别名，创建邮件组别名。
|
CreateMailgroupMemberResp |
MailgroupMember.create(CreateMailgroupMemberReq req,
RequestOptions reqOptions)
创建邮件组成员，向邮件组添加单个成员。
|
CreateMailgroupPermissionMemberResp |
MailgroupPermissionMember.create(CreateMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
创建邮件组权限成员，向邮件组添加单个自定义权限成员，添加后该成员可发送邮件到该邮件组。
|
CreateMailgroupResp |
Mailgroup.create(CreateMailgroupReq req,
RequestOptions reqOptions)
|
CreatePublicMailboxMemberResp |
PublicMailboxMember.create(CreatePublicMailboxMemberReq req,
RequestOptions reqOptions)
添加公共邮箱成员，向公共邮箱添加单个成员。
|
CreatePublicMailboxResp |
PublicMailbox.create(CreatePublicMailboxReq req,
RequestOptions reqOptions)
创建公共邮箱，创建一个公共邮箱。
|
CreateUserMailboxAliasResp |
UserMailboxAlias.create(CreateUserMailboxAliasReq req,
RequestOptions reqOptions)
创建用户邮箱别名，创建用户邮箱别名。
|
CreateUserMailboxDraftResp |
UserMailboxDraft.create(CreateUserMailboxDraftReq req,
RequestOptions reqOptions)
|
CreateUserMailboxLabelResp |
UserMailboxLabel.create(CreateUserMailboxLabelReq req,
RequestOptions reqOptions)
|
CreateUserMailboxRuleResp |
UserMailboxRule.create(CreateUserMailboxRuleReq req,
RequestOptions reqOptions)
|
DeleteMailgroupAliasResp |
MailgroupAlias.delete(DeleteMailgroupAliasReq req,
RequestOptions reqOptions)
删除邮件组别名，删除邮件组别名。
|
DeleteMailgroupMemberResp |
MailgroupMember.delete(DeleteMailgroupMemberReq req,
RequestOptions reqOptions)
删除邮件组成员，删除邮件组单个成员。
|
DeleteMailgroupPermissionMemberResp |
MailgroupPermissionMember.delete(DeleteMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
删除邮件组权限成员，从自定义成员中删除单个成员，删除后该成员无法发送邮件到该邮件组。
|
DeleteMailgroupResp |
Mailgroup.delete(DeleteMailgroupReq req,
RequestOptions reqOptions)
|
DeletePublicMailboxMemberResp |
PublicMailboxMember.delete(DeletePublicMailboxMemberReq req,
RequestOptions reqOptions)
删除公共邮箱单个成员，删除公共邮箱单个成员。
|
DeletePublicMailboxResp |
PublicMailbox.delete(DeletePublicMailboxReq req,
RequestOptions reqOptions)
永久删除公共邮箱，该接口会永久删除公共邮箱地址。
|
DeleteUserMailboxAliasResp |
UserMailboxAlias.delete(DeleteUserMailboxAliasReq req,
RequestOptions reqOptions)
删除用户邮箱别名，删除用户邮箱别名。
|
DeleteUserMailboxDraftResp |
UserMailboxDraft.delete(DeleteUserMailboxDraftReq req,
RequestOptions reqOptions)
删除草稿，删除指定邮箱账户下的单份邮件草稿。
|
DeleteUserMailboxFolderResp |
UserMailboxFolder.delete(DeleteUserMailboxFolderReq req,
RequestOptions reqOptions)
删除邮箱文件夹，删除邮箱文件夹
删除后文件夹数据无法恢复，请谨慎使用；删除文件夹会将该文件夹下的邮件移至已删除文件夹中。
|
DeleteUserMailboxLabelResp |
UserMailboxLabel.delete(DeleteUserMailboxLabelReq req,
RequestOptions reqOptions)
|
DeleteUserMailboxResp |
UserMailbox.delete(DeleteUserMailboxReq req,
RequestOptions reqOptions)
从回收站删除用户邮箱地址，该接口会永久删除用户邮箱地址。
|
DeleteUserMailboxRuleResp |
UserMailboxRule.delete(DeleteUserMailboxRuleReq req,
RequestOptions reqOptions)
删除收信规则，删除收信规则
使用 tenant_access_token 时，需要申请收信规则资源的数据权限。
|
DeleteUserMailboxTemplateResp |
UserMailboxTemplate.delete(DeleteUserMailboxTemplateReq req,
RequestOptions reqOptions)
，永久删除指定用户邮箱下的某个个人邮件模板。
|
DownloadUrlUserMailboxMessageAttachmentResp |
UserMailboxMessageAttachment.downloadUrl(DownloadUrlUserMailboxMessageAttachmentReq req,
RequestOptions reqOptions)
获取附件下载链接，获取附件下载链接
使用 tenant_access_token 时，需要申请邮件数据资源的数据权限。
|
DownloadUrlUserMailboxTemplateAttachmentResp |
UserMailboxTemplateAttachment.downloadUrl(DownloadUrlUserMailboxTemplateAttachmentReq req,
RequestOptions reqOptions)
，获取指定邮件模板下的附件下载链接。
|
GetMailgroupMemberResp |
MailgroupMember.get(GetMailgroupMemberReq req,
RequestOptions reqOptions)
查询指定邮件组成员，获取邮件组单个成员信息。
|
GetMailgroupPermissionMemberResp |
MailgroupPermissionMember.get(GetMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
获取邮件组权限成员，获取邮件组单个权限成员信息。
|
GetMailgroupResp |
Mailgroup.get(GetMailgroupReq req,
RequestOptions reqOptions)
查询指定邮件组，获取特定邮件组信息。
|
GetPublicMailboxMemberResp |
PublicMailboxMember.get(GetPublicMailboxMemberReq req,
RequestOptions reqOptions)
查询指定公共邮箱成员信息，获取公共邮箱单个成员信息。
|
GetPublicMailboxResp |
PublicMailbox.get(GetPublicMailboxReq req,
RequestOptions reqOptions)
查询指定公共邮箱，获取公共邮箱信息。
|
GetUserMailboxDraftResp |
UserMailboxDraft.get(GetUserMailboxDraftReq req,
RequestOptions reqOptions)
获取草稿内容，根据草稿 ID 获取指定草稿的详细内容，包括草稿所属邮件、主题、正文、收件人、抄送人、密送人、附件和安全信息等。
|
GetUserMailboxFolderResp |
UserMailboxFolder.get(GetUserMailboxFolderReq req,
RequestOptions reqOptions)
获取邮箱文件夹信息，通过指定文件夹ID，获取文件夹信息，包括名称、类型等
使用应用身份访问时，需要申请邮箱文件夹资源的数据权限。
|
GetUserMailboxLabelResp |
UserMailboxLabel.get(GetUserMailboxLabelReq req,
RequestOptions reqOptions)
|
GetUserMailboxTemplateResp |
UserMailboxTemplate.get(GetUserMailboxTemplateReq req,
RequestOptions reqOptions)
，获取指定邮件模板的完整详情，包括模板名称、主题、正文（HTML 或纯文本）、收件人/抄送/密送地址、附件信息等所有字段。
|
GetUserMailboxThreadResp |
UserMailboxThread.get(GetUserMailboxThreadReq req,
RequestOptions reqOptions)
获取邮件会话邮件列表，获取指定邮件会话下的邮件列表，包含邮件元数据及主题、正文等内容。
|
GetByCardUserMailboxMessageResp |
UserMailboxMessage.getByCard(GetByCardUserMailboxMessageReq req,
RequestOptions reqOptions)
|
GetSignaturesUserMailboxSettingResp |
UserMailboxSetting.getSignatures(GetSignaturesUserMailboxSettingReq req,
RequestOptions reqOptions)
|
ListMailgroupManagerResp |
MailgroupManager.list(ListMailgroupManagerReq req,
RequestOptions reqOptions)
批量获取邮件组管理员，批量获取邮件组管理员。
|
ListMailgroupMemberResp |
MailgroupMember.list(ListMailgroupMemberReq req,
RequestOptions reqOptions)
获取所有邮件组成员，分页批量获取邮件组成员列表。
|
ListMailgroupPermissionMemberResp |
MailgroupPermissionMember.list(ListMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
批量获取邮件组权限成员，分页批量获取邮件组权限成员列表。
|
ListMailgroupResp |
Mailgroup.list(ListMailgroupReq req,
RequestOptions reqOptions)
|
ListPublicMailboxMemberResp |
PublicMailboxMember.list(ListPublicMailboxMemberReq req,
RequestOptions reqOptions)
查询所有公共邮箱成员信息，分页批量获取公共邮箱成员列表。
|
ListPublicMailboxResp |
PublicMailbox.list(ListPublicMailboxReq req,
RequestOptions reqOptions)
查询所有公共邮箱，分页批量获取公共邮箱列表。
|
ListUserMailboxAliasResp |
UserMailboxAlias.list(ListUserMailboxAliasReq req,
RequestOptions reqOptions)
获取用户邮箱所有别名，获取用户邮箱所有别名。
|
ListUserMailboxDraftResp |
UserMailboxDraft.list(ListUserMailboxDraftReq req,
RequestOptions reqOptions)
|
ListUserMailboxLabelResp |
UserMailboxLabel.list(ListUserMailboxLabelReq req,
RequestOptions reqOptions)
|
ListUserMailboxMessageResp |
UserMailboxMessage.list(ListUserMailboxMessageReq req,
RequestOptions reqOptions)
列出邮件，列出邮件
使用应用权限访问时，需要申请邮件数据资源的数据权限。
|
ListUserMailboxRuleResp |
UserMailboxRule.list(ListUserMailboxRuleReq req,
RequestOptions reqOptions)
列出收信规则，列出收信规则
使用 tenant_access_token 时，需要申请收信规则资源的数据权限。
|
ListUserMailboxTemplateResp |
UserMailboxTemplate.list(ListUserMailboxTemplateReq req,
RequestOptions reqOptions)
，列出指定用户邮箱下的全部个人邮件模板基本信息（一次性返回，不分页），常用于在编辑或发送邮件场景下展示可选模板列表。
|
ListUserMailboxThreadResp |
UserMailboxThread.list(ListUserMailboxThreadReq req,
RequestOptions reqOptions)
|
ModifyUserMailboxMessageResp |
UserMailboxMessage.modify(ModifyUserMailboxMessageReq req,
RequestOptions reqOptions)
修改邮件，修改邮件标签、所属文件夹、已读未读状态，可为邮件添加旗标、归档、移入垃圾邮件等操作。
|
ModifyUserMailboxThreadResp |
UserMailboxThread.modify(ModifyUserMailboxThreadReq req,
RequestOptions reqOptions)
修改邮件会话，修改邮件会话的标签、所属文件夹和已读未读状态，支持为邮件会话添加旗标、归档、移入垃圾邮件文件夹。
|
PatchMailgroupResp |
Mailgroup.patch(PatchMailgroupReq req,
RequestOptions reqOptions)
修改邮件组部分信息，更新邮件组部分字段，没有填写的字段不会被更新。
|
PatchPublicMailboxResp |
PublicMailbox.patch(PatchPublicMailboxReq req,
RequestOptions reqOptions)
修改公共邮箱部分信息，更新公共邮箱部分字段，没有填写的字段不会被更新。
|
PatchUserMailboxFolderResp |
UserMailboxFolder.patch(PatchUserMailboxFolderReq req,
RequestOptions reqOptions)
修改邮箱文件夹，修改邮箱文件夹
使用应用身份访问时，需要申请邮箱文件夹资源的数据权限。
|
PatchUserMailboxLabelResp |
UserMailboxLabel.patch(PatchUserMailboxLabelReq req,
RequestOptions reqOptions)
|
ProfileUserMailboxResp |
UserMailbox.profile(ProfileUserMailboxReq req,
RequestOptions reqOptions)
|
RecallUserMailboxSentMessageResp |
UserMailboxSentMessage.recall(RecallUserMailboxSentMessageReq req,
RequestOptions reqOptions)
撤回已发送的邮件，撤回指定邮件。
|
RemoveToRecycleBinPublicMailboxResp |
PublicMailbox.removeToRecycleBin(RemoveToRecycleBinPublicMailboxReq req,
RequestOptions reqOptions)
|
SearchMultiEntityResp |
MultiEntity.search(SearchMultiEntityReq req,
RequestOptions reqOptions)
|
SendUserMailboxMessageResp |
UserMailboxMessage.send(SendUserMailboxMessageReq req,
RequestOptions reqOptions)
发送邮件，发送邮件
该接口基于单个用户加锁，只能串行调用;;发送邮件使用 base64url 编码。
|
SendAsUserMailboxSettingResp |
UserMailboxSetting.sendAs(SendAsUserMailboxSettingReq req,
RequestOptions reqOptions)
|
UpdatePublicMailboxResp |
PublicMailbox.update(UpdatePublicMailboxReq req,
RequestOptions reqOptions)
修改公共邮箱全部信息，更新公共邮箱所有信息。
|
UpdateUserMailboxDraftResp |
UserMailboxDraft.update(UpdateUserMailboxDraftReq req,
RequestOptions reqOptions)
更新草稿，更新指定草稿的邮件内容，包括主题、正文、收件人、抄送人、密送人和附件等信息。
|
UpdateUserMailboxRuleResp |
UserMailboxRule.update(UpdateUserMailboxRuleReq req,
RequestOptions reqOptions)
更新收信规则，更新收信规则
使用 tenant_access_token 时，需要申请收信规则资源的数据权限。
|
UpdateUserMailboxTemplateResp |
UserMailboxTemplate.update(UpdateUserMailboxTemplateReq req,
RequestOptions reqOptions)
，以全量替换的方式更新指定邮件模板的所有字段（包括名称、主题、正文、附件、收件信息等）。
|
参数类型为RequestOptions的com.lark.oapi.service.moments.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
GetPostResp |
Post.get(GetPostReq req,
RequestOptions reqOptions)
查询帖子信息，通过 ID 查询帖子实体数据信息
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.okr.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchGetOkrResp |
Okr.batchGet(BatchGetOkrReq req,
RequestOptions reqOptions)
批量获取 OKR，根据 OKR id 批量获取 OKR。
|
CreatePeriodResp |
Period.create(CreatePeriodReq req,
RequestOptions reqOptions)
创建 OKR 周期，根据周期规则创建一个 OKR 周期。
|
CreateProgressRecordResp |
ProgressRecord.create(CreateProgressRecordReq req,
RequestOptions reqOptions)
创建 OKR 进展记录，创建 OKR 进展记录。
|
DeleteProgressRecordResp |
ProgressRecord.delete(DeleteProgressRecordReq req,
RequestOptions reqOptions)
删除 OKR 进展记录，根据 ID 删除 OKR 进展记录。
|
GetProgressRecordResp |
ProgressRecord.get(GetProgressRecordReq req,
RequestOptions reqOptions)
获取 OKR 进展记录，根据 ID 获取 OKR 进展记录详情，接口返回进展记录的内容、更新时间以及进展百分比和状态。
|
ListPeriodResp |
Period.list(ListPeriodReq req,
RequestOptions reqOptions)
获取 OKR 周期列表，获取 OKR 周期列表。
|
ListUserOkrResp |
UserOkr.list(ListUserOkrReq req,
RequestOptions reqOptions)
获取用户的 OKR 列表，根据用户的 id 获取 OKR 列表。
|
ListPeriodRuleResp |
PeriodRule.list(RequestOptions reqOptions)
获取 OKR 周期规则，获取租户的周期规则列表。
|
PatchPeriodResp |
Period.patch(PatchPeriodReq req,
RequestOptions reqOptions)
|
UpdateProgressRecordResp |
ProgressRecord.update(UpdateProgressRecordReq req,
RequestOptions reqOptions)
更新 OKR 进展记录，根据 OKR 进展记录 ID 更新进展详情。
|
UploadImageResp |
Image.upload(UploadImageReq req,
RequestOptions reqOptions)
上传进展记录图片，上传图片，以获取在进展记录富文本中使用的 token。
|
参数类型为RequestOptions的com.lark.oapi.service.okr.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateOkrCycleObjectiveResp |
OkrCycleObjective.create(CreateOkrCycleObjectiveReq req,
RequestOptions reqOptions)
创建 OKR 目标，在指定的 OKR 周期下创建一个新的目标。
|
CreateOkrObjectiveAlignmentResp |
OkrObjectiveAlignment.create(CreateOkrObjectiveAlignmentReq req,
RequestOptions reqOptions)
创建目标对齐关系，为指定目标与另一个目标创建对齐关系，在 OKR 结构中建立层级对齐。
|
CreateOkrObjectiveKeyResultResp |
OkrObjectiveKeyResult.create(CreateOkrObjectiveKeyResultReq req,
RequestOptions reqOptions)
在目标下创建关键结果，在指定目标下创建一个新的关键结果。
|
DeleteOkrAlignmentResp |
OkrAlignment.delete(DeleteOkrAlignmentReq req,
RequestOptions reqOptions)
删除 OKR 对齐关系，删除两个目标之间现有的 OKR 对齐关系。
|
DeleteOkrKeyResultResp |
OkrKeyResult.delete(DeleteOkrKeyResultReq req,
RequestOptions reqOptions)
删除关键结果，删除目标下指定的关键结果。
|
DeleteOkrObjectiveResp |
OkrObjective.delete(DeleteOkrObjectiveReq req,
RequestOptions reqOptions)
删除 OKR 目标，从 OKR 周期中删除已存在的目标，将目标及其关联的关键结果从 OKR 结构中移除。
|
GetOkrAlignmentResp |
OkrAlignment.get(GetOkrAlignmentReq req,
RequestOptions reqOptions)
获取 OKR 对齐信息，获取特定 OKR 对齐的详细信息，包括对齐关系中涉及的两个实体、它们的所有者以及创建/更新时间戳。
|
GetOkrKeyResultResp |
OkrKeyResult.get(GetOkrKeyResultReq req,
RequestOptions reqOptions)
获取关键结果，获取指定关键结果的详细信息，包括其内容、负责人、分数、权重、截止时间和相关指标。
|
GetOkrObjectiveResp |
OkrObjective.get(GetOkrObjectiveReq req,
RequestOptions reqOptions)
获取目标详细信息，获取指定目标的详细信息，包括其内容、负责人、分数、权重、截止时间及分类。
|
KeyResultsPositionOkrObjectiveResp |
OkrObjective.keyResultsPosition(KeyResultsPositionOkrObjectiveReq req,
RequestOptions reqOptions)
修改关键结果位置，通过提供按顺序排列的关键结果 ID 列表，对指定目标下的关键结果进行重新排序，并相应更新其序号。
|
KeyResultsWeightOkrObjectiveResp |
OkrObjective.keyResultsWeight(KeyResultsWeightOkrObjectiveReq req,
RequestOptions reqOptions)
修改关键结果权重，调整指定目标下各关键结果的权重分配。
|
ListOkrCategoryResp |
OkrCategory.list(ListOkrCategoryReq req,
RequestOptions reqOptions)
获取所有 OKR 分类，获取系统中所有可用的 OKR 分类的分页列表。
|
ListOkrCycleObjectiveResp |
OkrCycleObjective.list(ListOkrCycleObjectiveReq req,
RequestOptions reqOptions)
获取用户 OKR 周期内的目标，获取指定用户 OKR 周期内的所有目标列表，包含目标内容、负责人、分数和进度状态等信息。
|
ListOkrCycleResp |
OkrCycle.list(ListOkrCycleReq req,
RequestOptions reqOptions)
获取用户 OKR 周期列表，获取指定用户的 OKR 周期列表，包含周期状态、时间范围和分数等信息。
|
ListOkrKeyResultIndicatorResp |
OkrKeyResultIndicator.list(ListOkrKeyResultIndicatorReq req,
RequestOptions reqOptions)
获取关键结果的量化指标，获取指定关键结果的量化指标数据，包括其当前值、目标值、状态、计算方式和单位信息。
|
ListOkrKeyResultProgressResp |
OkrKeyResultProgress.list(ListOkrKeyResultProgressReq req,
RequestOptions reqOptions)
获取关键结果下的进展记录，获取指定关键结果的分页进展更新记录。
|
ListOkrObjectiveAlignmentResp |
OkrObjectiveAlignment.list(ListOkrObjectiveAlignmentReq req,
RequestOptions reqOptions)
获取目标的对齐信息，分页获取指定目标的对齐关系列表，包含被其他目标对齐（被对齐）和对齐到其他目标（对齐）两种类型的对齐信息，以及发起方和被对齐方的负责人与实体详情。
|
ListOkrObjectiveIndicatorResp |
OkrObjectiveIndicator.list(ListOkrObjectiveIndicatorReq req,
RequestOptions reqOptions)
获取目标的量化指标，获取指定目标的量化指标数据，包括其起始值、当前值、目标值、状态、计算方式和单位信息。
|
ListOkrObjectiveKeyResultResp |
OkrObjectiveKeyResult.list(ListOkrObjectiveKeyResultReq req,
RequestOptions reqOptions)
获取目标下的所有关键结果，分页获取指定目标下的所有关键结果列表，包括关键结果的内容、进度、分数和负责人信息。
|
ListOkrObjectiveProgressResp |
OkrObjectiveProgress.list(ListOkrObjectiveProgressReq req,
RequestOptions reqOptions)
获取目标下的进展记录，分页获取指定目标下的进展记录列表，包含进展内容、创建/更新时间戳、负责人信息以及进展百分比和状态。
|
ObjectivesPositionOkrCycleResp |
OkrCycle.objectivesPosition(ObjectivesPositionOkrCycleReq req,
RequestOptions reqOptions)
修改 OKR 目标位置，通过提供按顺序排列的目标 ID 列表，在指定的 OKR 周期内重新排序目标。
|
ObjectivesWeightOkrCycleResp |
OkrCycle.objectivesWeight(ObjectivesWeightOkrCycleReq req,
RequestOptions reqOptions)
修改 OKR 目标权重，批量修改指定 OKR 周期下多个目标的权重。
|
PatchOkrIndicatorResp |
OkrIndicator.patch(PatchOkrIndicatorReq req,
RequestOptions reqOptions)
更新量化指标，更新现有量化指标的配置和数值，包括计算方式、状态、当前值、目标值和单位设置。
|
PatchOkrKeyResultResp |
OkrKeyResult.patch(PatchOkrKeyResultReq req,
RequestOptions reqOptions)
编辑关键结果，修改指定目标下现有关键结果的内容、分数和截止时间，更新其内容。
|
PatchOkrObjectiveResp |
OkrObjective.patch(PatchOkrObjectiveReq req,
RequestOptions reqOptions)
编辑 OKR 目标，更新 OKR 周期中已存在目标的内容、分数、备注、截止时间和分类，支持对指定字段进行部分更新。
|
参数类型为RequestOptions的com.lark.oapi.service.performance.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
DeleteAdditionalInformationsBatchResp |
AdditionalInformationsBatch.delete(DeleteAdditionalInformationsBatchReq req,
RequestOptions reqOptions)
批量删除补充信息，批量删除被评估人的补充信息。
|
ImportAdditionalInformationResp |
AdditionalInformation.import_(ImportAdditionalInformationReq req,
RequestOptions reqOptions)
批量导入补充信息，批量导入被评估人的补充信息作为绩效评估的参考，如补充信息的事项、时间以及具体描述等。
|
ImportMetricDetailResp |
MetricDetail.import_(ImportMetricDetailReq req,
RequestOptions reqOptions)
录入被评估人关键指标数据，批量录入指定周期中被评估人的关键指标数据。
|
ListMetricTagResp |
MetricTag.list(ListMetricTagReq req,
RequestOptions reqOptions)
获取指标标签列表，批量获取指标的标签信息，如标签名称、创建时间等信息。
|
QueryActivityResp |
Activity.query(QueryActivityReq req,
RequestOptions reqOptions)
获取项目列表，批量获取项目的配置信息，如项目名称、项目模式等信息。
|
QueryAdditionalInformationResp |
AdditionalInformation.query(QueryAdditionalInformationReq req,
RequestOptions reqOptions)
批量查询补充信息，批量查询被评估人的补充信息，如补充信息的事项、时间以及具体描述等。
|
QueryIndicatorResp |
Indicator.query(QueryIndicatorReq req,
RequestOptions reqOptions)
获取评估项列表，批量获取评估项信息，如评估项名称、评估项类型、评估项等级配置等信息。
|
QueryMetricDetailResp |
MetricDetail.query(QueryMetricDetailReq req,
RequestOptions reqOptions)
获取被评估人关键指标结果，批量获取指定周期中被评估人的关键指标结果。
|
QueryMetricFieldResp |
MetricField.query(QueryMetricFieldReq req,
RequestOptions reqOptions)
获取指标字段列表，批量获取指标的字段基础信息，如指标字段名称、指标字段类型等信息。
|
QueryMetricLibResp |
MetricLib.query(QueryMetricLibReq req,
RequestOptions reqOptions)
获取指标列表，获取指标库中的指标信息，如指标名称、指标类型、指标标签和指标字段等信息。
|
QueryMetricTemplateResp |
MetricTemplate.query(QueryMetricTemplateReq req,
RequestOptions reqOptions)
获取指标模板列表，批量获取指标模板的信息。
|
QueryQuestionResp |
Question.query(QueryQuestionReq req,
RequestOptions reqOptions)
|
QueryReviewTemplateResp |
ReviewTemplate.query(QueryReviewTemplateReq req,
RequestOptions reqOptions)
|
WriteUserGroupUserRelResp |
UserGroupUserRel.write(WriteUserGroupUserRelReq req,
RequestOptions reqOptions)
更新人员组成员，更新指定人员组成员。
|
参数类型为RequestOptions的com.lark.oapi.service.report.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
QueryRuleResp |
Rule.query(QueryRuleReq req,
RequestOptions reqOptions)
查询规则，查询规则。
|
QueryTaskResp |
Task.query(QueryTaskReq req,
RequestOptions reqOptions)
查询任务，查询任务。
|
RemoveRuleViewResp |
RuleView.remove(RemoveRuleViewReq req,
RequestOptions reqOptions)
移除规则看板，移除规则看板
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.search.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateAppResp |
App.create(CreateAppReq req,
RequestOptions reqOptions)
搜索应用，用户可以通过关键字搜索到可见应用，应用可见性与套件内搜索一致。
|
CreateDataSourceItemResp |
DataSourceItem.create(CreateDataSourceItemReq req,
RequestOptions reqOptions)
为指定数据项创建索引，索引一条数据记录。
|
CreateDataSourceResp |
DataSource.create(CreateDataSourceReq req,
RequestOptions reqOptions)
创建数据源，创建一个数据源。
|
CreateMessageResp |
Message.create(CreateMessageReq req,
RequestOptions reqOptions)
搜索消息，用户可以通过关键字搜索可见消息，可见性和套件内搜索一致。
|
CreateSchemaResp |
Schema.create(CreateSchemaReq req,
RequestOptions reqOptions)
创建数据范式，创建一个数据范式。
|
DeleteDataSourceItemResp |
DataSourceItem.delete(DeleteDataSourceItemReq req,
RequestOptions reqOptions)
删除数据项，删除数据项。
|
DeleteDataSourceResp |
DataSource.delete(DeleteDataSourceReq req,
RequestOptions reqOptions)
删除数据源，删除一个已存在的数据源。
|
DeleteSchemaResp |
Schema.delete(DeleteSchemaReq req,
RequestOptions reqOptions)
删除数据范式，删除已存在的数据范式。
|
GetDataSourceItemResp |
DataSourceItem.get(GetDataSourceItemReq req,
RequestOptions reqOptions)
查询指定数据项，获取单个数据记录。
|
GetDataSourceResp |
DataSource.get(GetDataSourceReq req,
RequestOptions reqOptions)
获取数据源，获取已经创建的数据源。
|
GetSchemaResp |
Schema.get(GetSchemaReq req,
RequestOptions reqOptions)
获取数据范式，获取单个数据范式。
|
ListDataSourceResp |
DataSource.list(ListDataSourceReq req,
RequestOptions reqOptions)
批量获取数据源，批量获取创建的数据源信息。
|
PatchDataSourceResp |
DataSource.patch(PatchDataSourceReq req,
RequestOptions reqOptions)
修改数据源，更新一个已经存在的数据源。
|
PatchSchemaResp |
Schema.patch(PatchSchemaReq req,
RequestOptions reqOptions)
修改数据范式，修改数据范式。
|
SearchDocWikiResp |
DocWiki.search(SearchDocWikiReq req,
RequestOptions reqOptions)
文档搜索，该接口用于根据搜索关键词（query）对当前用户可见的云文档进行搜索
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.security_and_compliance.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CancelUserMigrationResp |
UserMigration.cancel(CancelUserMigrationReq req,
RequestOptions reqOptions)
取消用户迁移任务，取消用户迁移任务，仅能对未启动迁移的用户做此操作。
|
CreateUserMigrationResp |
UserMigration.create(CreateUserMigrationReq req,
RequestOptions reqOptions)
迁移用户数据驻留位置，将用户的数据驻留位置迁移到目标地理位置。
|
GetUserMigrationResp |
UserMigration.get(GetUserMigrationReq req,
RequestOptions reqOptions)
获取单个用户迁移状态，通过user_id获取指定用户当前的迁移状态
官网API文档链接:
GetMultiGeoEntityTenantResp |
MultiGeoEntityTenant.get(RequestOptions reqOptions)
获取数据驻留地理位置列表，获取租户可用的数据驻留地理位置列表
官网API文档链接:
ListDataOpenapiLogResp |
OpenapiLog.listData(ListDataOpenapiLogReq req,
RequestOptions reqOptions)
获取OpenAPI审计日志数据，该接口用于获取OpenAPI审计日志数据
官网API文档链接:
SearchUserMigrationResp |
UserMigration.search(SearchUserMigrationReq req,
RequestOptions reqOptions)
批量获取用户迁移状态，传入用户 ID 列表，批量获取用户迁移状态
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.security_and_compliance.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateDeviceRecordResp |
DeviceRecord.create(CreateDeviceRecordReq req,
RequestOptions reqOptions)
新增设备，使用该接口在设备管理中新增一台设备。
|
DeleteDeviceRecordResp |
DeviceRecord.delete(DeleteDeviceRecordReq req,
RequestOptions reqOptions)
删除设备，使用该接口在设备管理中删除一台设备
官网API文档链接:
GetDeviceRecordResp |
DeviceRecord.get(GetDeviceRecordReq req,
RequestOptions reqOptions)
获取设备信息，使用该接口在设备管理中获取设备的设备参数、设备归属、设备状态等信息
官网API文档链接:
ListDeviceRecordResp |
DeviceRecord.list(ListDeviceRecordReq req,
RequestOptions reqOptions)
查询设备信息，使用该接口可分页查询设备列表信息
官网API文档链接:
MineDeviceRecordResp |
DeviceRecord.mine(RequestOptions reqOptions)
获取设备认证信息，通过客户端授权信息获取对应设备认证信息，包含设备归属、可信状态等
官网API文档链接:
UpdateDeviceApplyRecordResp |
DeviceApplyRecord.update(UpdateDeviceApplyRecordReq req,
RequestOptions reqOptions)
审批设备申报，使用该接口在设备管理中通过或驳回一条成员自主申报申请
官网API文档链接:
UpdateDeviceRecordResp |
DeviceRecord.update(UpdateDeviceRecordReq req,
RequestOptions reqOptions)
更新设备，使用该接口在设备管理中修改一台设备的设备归属、设备状态等信息
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.sheets.v3.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateSpreadsheetResp |
Spreadsheet.create(CreateSpreadsheetReq req,
RequestOptions reqOptions)
创建电子表格，在云空间指定目录下创建电子表格。
|
CreateSpreadsheetSheetFilterResp |
SpreadsheetSheetFilter.create(CreateSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
创建筛选，在电子表格工作表的指定范围内，设置筛选条件，创建筛选。
|
CreateSpreadsheetSheetFilterViewConditionResp |
SpreadsheetSheetFilterViewCondition.create(CreateSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
创建筛选条件，在筛选视图的指定列创建筛选条件，包括筛选的类型、比较类型、筛选参数等。
|
CreateSpreadsheetSheetFilterViewResp |
SpreadsheetSheetFilterView.create(CreateSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
创建筛选视图，指定电子表格工作表的筛选范围，创建一个筛选视图。
|
CreateSpreadsheetSheetFloatImageResp |
SpreadsheetSheetFloatImage.create(CreateSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
创建浮动图片，在电子表格工作表的指定位置创建一张浮动图片。
|
DeleteSpreadsheetSheetFilterResp |
SpreadsheetSheetFilter.delete(DeleteSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
删除筛选，删除电子表格中指定工作表的所有筛选。
|
DeleteSpreadsheetSheetFilterViewConditionResp |
SpreadsheetSheetFilterViewCondition.delete(DeleteSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
删除筛选条件，删除筛选视图指定列的所有筛选条件。
|
DeleteSpreadsheetSheetFilterViewResp |
SpreadsheetSheetFilterView.delete(DeleteSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
删除筛选视图，删除指定筛选视图。
|
DeleteSpreadsheetSheetFloatImageResp |
SpreadsheetSheetFloatImage.delete(DeleteSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
删除浮动图片，删除电子表格工作表内指定的浮动图片。
|
FindSpreadsheetSheetResp |
SpreadsheetSheet.find(FindSpreadsheetSheetReq req,
RequestOptions reqOptions)
查找单元格，在指定范围内查找符合查找条件的单元格。
|
GetSpreadsheetResp |
Spreadsheet.get(GetSpreadsheetReq req,
RequestOptions reqOptions)
获取电子表格信息，根据电子表格 token 获取电子表格的基础信息，包括电子表格的所有者、URL 链接等。
|
GetSpreadsheetSheetFilterResp |
SpreadsheetSheetFilter.get(GetSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
获取筛选，获取电子表格中工作表的详细筛选信息，包括筛选的应用范围、筛选条件、被筛选条件过滤掉的行。
|
GetSpreadsheetSheetFilterViewConditionResp |
SpreadsheetSheetFilterViewCondition.get(GetSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
获取筛选条件，获取筛选视图某列的筛选条件，包括筛选的类型、比较类型、筛选参数等。
|
GetSpreadsheetSheetFilterViewResp |
SpreadsheetSheetFilterView.get(GetSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
获取筛选视图，获取指定筛选视图的信息，包括 ID、名称和筛选范围。
|
GetSpreadsheetSheetFloatImageResp |
SpreadsheetSheetFloatImage.get(GetSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
获取浮动图片，获取电子表格工作表内指定浮动图片的参数信息。
|
GetSpreadsheetSheetResp |
SpreadsheetSheet.get(GetSpreadsheetSheetReq req,
RequestOptions reqOptions)
查询工作表，根据工作表 ID 查询工作表属性信息，包括工作表的标题、索引位置、是否被隐藏等。
|
MoveDimensionSpreadsheetSheetResp |
SpreadsheetSheet.moveDimension(MoveDimensionSpreadsheetSheetReq req,
RequestOptions reqOptions)
移动行列，该接口用于移动行或列。
|
PatchSpreadsheetResp |
Spreadsheet.patch(PatchSpreadsheetReq req,
RequestOptions reqOptions)
修改电子表格属性，该接口用于修改电子表格的属性。
|
PatchSpreadsheetSheetFilterViewResp |
SpreadsheetSheetFilterView.patch(PatchSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
更新筛选视图，更新筛选视图的名称或筛选范围。
|
PatchSpreadsheetSheetFloatImageResp |
SpreadsheetSheetFloatImage.patch(PatchSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
更新浮动图片，更新已有的浮动图片位置和宽高。
|
QuerySpreadsheetSheetFilterViewConditionResp |
SpreadsheetSheetFilterViewCondition.query(QuerySpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
查询筛选条件，查询指定筛选视图的所有筛选条件，包括筛选的类型、比较类型、筛选参数等。
|
QuerySpreadsheetSheetFilterViewResp |
SpreadsheetSheetFilterView.query(QuerySpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
查询筛选视图，查询电子表格指定工作表的所有筛选视图及其基本信息，包括视图 ID、视图名称和筛选范围。
|
QuerySpreadsheetSheetFloatImageResp |
SpreadsheetSheetFloatImage.query(QuerySpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
查询浮动图片，获取电子表格工作表内所有的浮动图片的参数信息。
|
QuerySpreadsheetSheetResp |
SpreadsheetSheet.query(QuerySpreadsheetSheetReq req,
RequestOptions reqOptions)
获取工作表，根据电子表格 token 获取表格中所有工作表及其属性信息，包括工作表 ID、标题、索引位置、是否被隐藏等。
|
ReplaceSpreadsheetSheetResp |
SpreadsheetSheet.replace(ReplaceSpreadsheetSheetReq req,
RequestOptions reqOptions)
替换单元格，在指定范围内，查找并替换符合查找条件的单元格。
|
UpdateSpreadsheetSheetFilterResp |
SpreadsheetSheetFilter.update(UpdateSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
更新筛选，在电子表格工作表筛选范围中，更新指定列的筛选条件。
|
UpdateSpreadsheetSheetFilterViewConditionResp |
SpreadsheetSheetFilterViewCondition.update(UpdateSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
更新筛选条件，更新筛选视图指定列的筛选条件，包括筛选的类型、比较类型、筛选参数等。
|
参数类型为RequestOptions的com.lark.oapi.service.spark.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchUpdateTableRecordsAppTableResp |
AppTable.batchUpdateTableRecords(BatchUpdateTableRecordsAppTableReq req,
RequestOptions reqOptions)
批量更新数据表中的记录，批量更新应用下的数据表中的记录，每条记录需包含主键如_id，单次最多500条。
|
CreateAppResp |
App.create(CreateAppReq req,
RequestOptions reqOptions)
|
DownloadAppStorageResp |
AppStorage.download(DownloadAppStorageReq req,
RequestOptions reqOptions)
|
GetEnumListAppEnumResp |
AppEnum.getEnumList(GetEnumListAppEnumReq req,
RequestOptions reqOptions)
获取自定义枚举列表，获取应用下的自定义枚举列表，包括枚举名称、描述、枚举值列表等字段信息。
|
GetTableDetailAppTableResp |
AppTable.getTableDetail(GetTableDetailAppTableReq req,
RequestOptions reqOptions)
获取数据表详细信息，获取应用下的数据表详情，包含数据表名称、描述，以及数据表列信息等字段。
|
GetTableListAppTableResp |
AppTable.getTableList(GetTableListAppTableReq req,
RequestOptions reqOptions)
获取数据表列表，获取应用下的数据表列表，包含数据表名称、描述，以及数据表列信息等字段。
|
GetTableRecordListAppTableResp |
AppTable.getTableRecordList(GetTableRecordListAppTableReq req,
RequestOptions reqOptions)
查询数据表数据记录，查询应用下的数据表数据记录，包括指定列、字段值及分页信息，适用于需要获取应用下某数据表数据的记录、展示等场景。
|
GetViewRecordListAppViewResp |
AppView.getViewRecordList(GetViewRecordListAppViewReq req,
RequestOptions reqOptions)
查询视图数据记录，查询应用下的视图数据记录，包括指定列、字段值及分页信息，适用于需要获取应用下某视图数据的记录、展示等场景。
|
IconAppResp |
App.icon(IconAppReq req,
RequestOptions reqOptions)
|
PostTableRecordsAppTableResp |
AppTable.postTableRecords(PostTableRecordsAppTableReq req,
RequestOptions reqOptions)
向数据表中添加或更新记录，向应用下的数据表中添加或更新记录。
|
SqlCommandsAppResp |
App.sqlCommands(SqlCommandsAppReq req,
RequestOptions reqOptions)
执行 SQL，在应用下执行 SQL。
|
UpdateAppVisibilityAppResp |
App.updateAppVisibility(UpdateAppVisibilityAppReq req,
RequestOptions reqOptions)
|
UploadHtmlCodeAndReleaseAppResp |
App.uploadHtmlCodeAndRelease(UploadHtmlCodeAndReleaseAppReq req,
RequestOptions reqOptions)
|
UploadPartAppStorageResp |
AppStorage.uploadPart(UploadPartAppStorageReq req,
RequestOptions reqOptions)
分片上传文件 - 上传分片，根据`创建上传请求`接口返回的上传请求 ID 和分片策略上传对应的文件分片。
|
参数类型为RequestOptions的com.lark.oapi.service.task.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchDeleteCollaboratorTaskResp |
Task.batchDeleteCollaborator(BatchDeleteCollaboratorTaskReq req,
RequestOptions reqOptions)
批量删除执行者，该接口用于批量删除执行者。
|
BatchDeleteFollowerTaskResp |
Task.batchDeleteFollower(BatchDeleteFollowerTaskReq req,
RequestOptions reqOptions)
批量删除关注人，该接口用于批量删除关注人。
|
CompleteTaskResp |
Task.complete(CompleteTaskReq req,
RequestOptions reqOptions)
完成任务，该接口用于将任务状态修改为“已完成”。
|
CreateTaskCollaboratorResp |
TaskCollaborator.create(CreateTaskCollaboratorReq req,
RequestOptions reqOptions)
新增执行者，该接口用于新增任务执行者，一次性可以添加多个执行者。
|
CreateTaskCommentResp |
TaskComment.create(CreateTaskCommentReq req,
RequestOptions reqOptions)
创建评论，该接口用于创建和回复任务的评论。
|
CreateTaskFollowerResp |
TaskFollower.create(CreateTaskFollowerReq req,
RequestOptions reqOptions)
新增关注人，该接口用于新增任务关注人。
|
CreateTaskReminderResp |
TaskReminder.create(CreateTaskReminderReq req,
RequestOptions reqOptions)
新增提醒时间，该接口用于创建任务的提醒时间。
|
CreateTaskResp |
Task.create(CreateTaskReq req,
RequestOptions reqOptions)
创建任务，该接口可以创建一个任务，支持填写任务的基本信息，包括任务的标题，描述及协作者等。
|
DeleteTaskCollaboratorResp |
TaskCollaborator.delete(DeleteTaskCollaboratorReq req,
RequestOptions reqOptions)
删除指定执行者，该接口用于删除任务执行者。
|
DeleteTaskCommentResp |
TaskComment.delete(DeleteTaskCommentReq req,
RequestOptions reqOptions)
删除评论，该接口用于通过评论ID删除评论。
|
DeleteTaskFollowerResp |
TaskFollower.delete(DeleteTaskFollowerReq req,
RequestOptions reqOptions)
删除指定关注人，该接口用于删除任务关注人。
|
DeleteTaskReminderResp |
TaskReminder.delete(DeleteTaskReminderReq req,
RequestOptions reqOptions)
删除提醒时间，删除提醒时间，返回结果状态。
|
DeleteTaskResp |
Task.delete(DeleteTaskReq req,
RequestOptions reqOptions)
删除任务，该接口用于删除任务。
|
GetTaskCommentResp |
TaskComment.get(GetTaskCommentReq req,
RequestOptions reqOptions)
获取评论详情，该接口用于通过评论ID获取评论详情。
|
GetTaskResp |
Task.get(GetTaskReq req,
RequestOptions reqOptions)
查询指定任务，该接口用于获取任务详情，包括任务标题、描述、时间、来源等信息。
|
ListTaskCollaboratorResp |
TaskCollaborator.list(ListTaskCollaboratorReq req,
RequestOptions reqOptions)
获取执行者列表，该接口用于查询任务执行者列表，支持分页，最大值为50。
|
ListTaskCommentResp |
TaskComment.list(ListTaskCommentReq req,
RequestOptions reqOptions)
获取评论列表，该接口用于查询任务评论列表，支持分页，最大值为100。
|
ListTaskFollowerResp |
TaskFollower.list(ListTaskFollowerReq req,
RequestOptions reqOptions)
获取关注人列表，该接口用于查询任务关注人列表，支持分页，最大值为50。
|
ListTaskReminderResp |
TaskReminder.list(ListTaskReminderReq req,
RequestOptions reqOptions)
查询提醒时间列表，返回提醒时间列表，支持分页，最大值为50。
|
ListTaskResp |
Task.list(ListTaskReq req,
RequestOptions reqOptions)
查询所有任务，以分页的方式获取任务列表。
|
PatchTaskResp |
Task.patch(PatchTaskReq req,
RequestOptions reqOptions)
更新任务，该接口用于修改任务的标题、描述、时间、来源等相关信息。
|
UncompleteTaskResp |
Task.uncomplete(UncompleteTaskReq req,
RequestOptions reqOptions)
取消完成任务，该接口用于取消任务的已完成状态。
|
UpdateTaskCommentResp |
TaskComment.update(UpdateTaskCommentReq req,
RequestOptions reqOptions)
更新评论，该接口用于更新评论内容。
|
参数类型为RequestOptions的com.lark.oapi.service.task.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
AddCustomFieldResp |
CustomField.add(AddCustomFieldReq req,
RequestOptions reqOptions)
将自定义字段加入资源，将自定义字段加入一个资源。
|
AddDependenciesTaskResp |
Task.addDependencies(AddDependenciesTaskReq req,
RequestOptions reqOptions)
添加依赖，为一个任务添加一个或多个依赖。
|
AddMembersTasklistResp |
Tasklist.addMembers(AddMembersTasklistReq req,
RequestOptions reqOptions)
添加清单成员，向一个清单添加1个或多个协作成员。
|
AddMembersTaskResp |
Task.addMembers(AddMembersTaskReq req,
RequestOptions reqOptions)
添加任务成员，添加任务的负责人或者关注人。
|
AddRemindersTaskResp |
Task.addReminders(AddRemindersTaskReq req,
RequestOptions reqOptions)
添加任务提醒，为一个任务添加提醒。
|
AddTasklistTaskResp |
Task.addTasklist(AddTasklistTaskReq req,
RequestOptions reqOptions)
任务加入清单，将一个任务加入清单。
|
CreateCommentResp |
Comment.create(CreateCommentReq req,
RequestOptions reqOptions)
创建评论，为一个任务创建评论，或者回复该任务的某个评论。
|
CreateCustomFieldOptionResp |
CustomFieldOption.create(CreateCustomFieldOptionReq req,
RequestOptions reqOptions)
创建自定义字段选项，为单选或多选字段添加一个自定义选项。
|
CreateCustomFieldResp |
CustomField.create(CreateCustomFieldReq req,
RequestOptions reqOptions)
创建自定义字段，创建一个自定义字段，并将其加入一个资源上（目前资源只支持清单）。
|
CreateSectionResp |
Section.create(CreateSectionReq req,
RequestOptions reqOptions)
创建自定义分组，为清单或我负责的任务列表创建一个自定义分组。
|
CreateTasklistActivitySubscriptionResp |
TasklistActivitySubscription.create(CreateTasklistActivitySubscriptionReq req,
RequestOptions reqOptions)
创建动态订阅，为一个清单创建一个订阅。
|
CreateTasklistResp |
Tasklist.create(CreateTasklistReq req,
RequestOptions reqOptions)
创建清单，创建一个清单。
|
CreateTaskResp |
Task.create(CreateTaskReq req,
RequestOptions reqOptions)
创建任务，该接口可以创建一个任务，在创建任务时，支持填写任务的基本信息（如标题、描述、负责人等），此外，还可以设置任务的开始时间、截止时间提醒等条件，此外，还可以通过传入 tasklists
字段将新任务加到多个清单中。
|
CreateTaskSubtaskResp |
TaskSubtask.create(CreateTaskSubtaskReq req,
RequestOptions reqOptions)
创建子任务，给一个任务创建一个子任务。
|
DeleteAttachmentResp |
Attachment.delete(DeleteAttachmentReq req,
RequestOptions reqOptions)
删除附件，提供一个附件GUID，删除该附件。
|
DeleteCommentResp |
Comment.delete(DeleteCommentReq req,
RequestOptions reqOptions)
删除评论，删除一条评论。
|
DeleteSectionResp |
Section.delete(DeleteSectionReq req,
RequestOptions reqOptions)
删除自定义分组，删除一个自定义分组。
|
DeleteTasklistActivitySubscriptionResp |
TasklistActivitySubscription.delete(DeleteTasklistActivitySubscriptionReq req,
RequestOptions reqOptions)
删除动态订阅，给定一个清单的GUID和一个订阅的GUID，将其删除。
|
DeleteTasklistResp |
Tasklist.delete(DeleteTasklistReq req,
RequestOptions reqOptions)
删除清单，删除一个清单。
|
DeleteTaskResp |
Task.delete(DeleteTaskReq req,
RequestOptions reqOptions)
删除任务，删除一个任务。
|
GetAttachmentResp |
Attachment.get(GetAttachmentReq req,
RequestOptions reqOptions)
获取附件，提供一个附件GUID，返回附件的详细信息，包括GUID，名称，大小，上传时间，临时可下载链接等。
|
GetCommentResp |
Comment.get(GetCommentReq req,
RequestOptions reqOptions)
获取评论详情，给定一个评论的ID，返回评论的详情，包括内容，创建人，创建时间和更新时间等信息。
|
GetCustomFieldResp |
CustomField.get(GetCustomFieldReq req,
RequestOptions reqOptions)
获取自定义字段，根据一个自定义字段的GUID，获取其详细的设置信息。
|
GetSectionResp |
Section.get(GetSectionReq req,
RequestOptions reqOptions)
获取自定义分组详情，获取一个自定义分组详情，包括名称，创建人等信息。
|
GetTasklistActivitySubscriptionResp |
TasklistActivitySubscription.get(GetTasklistActivitySubscriptionReq req,
RequestOptions reqOptions)
获取动态订阅，提供一个清单的GUID和一个订阅的GUID，获取该订阅的详细信息，包括名称，订阅者，可通知的event keys列表等。
|
GetTasklistResp |
Tasklist.get(GetTasklistReq req,
RequestOptions reqOptions)
获取清单详情，获取一个清单的详细信息，包括清单名，所有者，清单成员等。
|
GetTaskResp |
Task.get(GetTaskReq req,
RequestOptions reqOptions)
获取任务详情，该接口用于获取任务详情，包括任务标题、描述、时间、成员等信息。
|
ListAttachmentResp |
Attachment.list(ListAttachmentReq req,
RequestOptions reqOptions)
列取附件，列取一个资源的所有附件。
|
ListCommentResp |
Comment.list(ListCommentReq req,
RequestOptions reqOptions)
获取评论列表，给定一个资源，返回该资源的评论列表。
|
ListCustomFieldResp |
CustomField.list(ListCustomFieldReq req,
RequestOptions reqOptions)
列取自定义字段，列取用户可访问的自定义字段列表。
|
ListSectionResp |
Section.list(ListSectionReq req,
RequestOptions reqOptions)
获取自定义分组列表，获取一个资源下所有的自定义分组列表。
|
ListTasklistActivitySubscriptionResp |
TasklistActivitySubscription.list(ListTasklistActivitySubscriptionReq req,
RequestOptions reqOptions)
列取动态订阅，给定一个清单的GUID，获取其所有的订阅信息。
|
ListTasklistResp |
Tasklist.list(ListTasklistReq req,
RequestOptions reqOptions)
获取清单列表，获取调用身份所有可读取的清单列表。
|
ListTaskResp |
Task.list(ListTaskReq req,
RequestOptions reqOptions)
列取任务列表，基于调用身份，列出特定类型的所有任务。
|
ListTaskSubtaskResp |
TaskSubtask.list(ListTaskSubtaskReq req,
RequestOptions reqOptions)
获取任务的子任务列表，获取一个任务的子任务列表。
|
ListRelatedTaskTaskV2Resp |
TaskV2.listRelatedTask(ListRelatedTaskTaskV2Req req,
RequestOptions reqOptions)
|
PatchCustomFieldOptionResp |
CustomFieldOption.patch(PatchCustomFieldOptionReq req,
RequestOptions reqOptions)
更新自定义字段选项，根据一个自定义字段的GUID和其选项的GUID，更新该选项的数据。
|
PatchCustomFieldResp |
CustomField.patch(PatchCustomFieldReq req,
RequestOptions reqOptions)
更新自定义字段，更新一个自定义字段的名称和设定。
|
PatchSectionResp |
Section.patch(PatchSectionReq req,
RequestOptions reqOptions)
更新自定义分组，更新自定义分组，可以更新自定义分组的名称和位置。
|
PatchTasklistActivitySubscriptionResp |
TasklistActivitySubscription.patch(PatchTasklistActivitySubscriptionReq req,
RequestOptions reqOptions)
更新动态订阅，提供一个清单的GUID和一个动态订阅的GUID，对其进行更新。
|
PatchTasklistResp |
Tasklist.patch(PatchTasklistReq req,
RequestOptions reqOptions)
更新清单，更新清单，可以更新清单的名字和所有者。
|
PatchTaskResp |
Task.patch(PatchTaskReq req,
RequestOptions reqOptions)
更新任务，该接口用于修改任务的标题、描述、截止时间等信息。
|
RemoveCustomFieldResp |
CustomField.remove(RemoveCustomFieldReq req,
RequestOptions reqOptions)
将自定义字段移出资源，将自定义字段从资源中移出。
|
RemoveDependenciesTaskResp |
Task.removeDependencies(RemoveDependenciesTaskReq req,
RequestOptions reqOptions)
移除依赖，从一个任务移除一个或者多个依赖。
|
RemoveMembersTasklistResp |
Tasklist.removeMembers(RemoveMembersTasklistReq req,
RequestOptions reqOptions)
移除清单成员，移除清单的一个或多个协作成员。
|
RemoveMembersTaskResp |
Task.removeMembers(RemoveMembersTaskReq req,
RequestOptions reqOptions)
移除任务成员，移除任务成员。
|
RemoveRemindersTaskResp |
Task.removeReminders(RemoveRemindersTaskReq req,
RequestOptions reqOptions)
移除任务提醒，将一个提醒从任务中移除。
|
RemoveTasklistTaskResp |
Task.removeTasklist(RemoveTasklistTaskReq req,
RequestOptions reqOptions)
任务移出清单，将任务从一个清单中移出。
|
SearchTasklistResp |
Tasklist.search(SearchTasklistReq req,
RequestOptions reqOptions)
|
TasklistsTaskResp |
Task.tasklists(TasklistsTaskReq req,
RequestOptions reqOptions)
列取任务所在清单，列取一个任务所在的所有清单的信息，包括清单的GUID和所在自定义分组的GUID。
|
TasksSectionResp |
Section.tasks(TasksSectionReq req,
RequestOptions reqOptions)
列取自定义分组中的任务，列取一个自定义分组里的所有任务。
|
TasksTasklistResp |
Tasklist.tasks(TasksTasklistReq req,
RequestOptions reqOptions)
获取清单任务列表，获取一个清单的任务列表，返回任务的摘要信息。
|
TaskSubscriptionTaskV2Resp |
TaskV2.taskSubscription(TaskSubscriptionTaskV2Req req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.vc.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
ApplyReserveResp |
Reserve.apply(ApplyReserveReq req,
RequestOptions reqOptions)
预约会议，创建一个会议预约。
|
CreateRoomLevelResp |
RoomLevel.create(CreateRoomLevelReq req,
RequestOptions reqOptions)
创建会议室层级，该接口用于创建会议室层级。
|
CreateRoomResp |
Room.create(CreateRoomReq req,
RequestOptions reqOptions)
创建会议室，该接口用于创建会议室。
|
CreateScopeConfigResp |
ScopeConfig.create(CreateScopeConfigReq req,
RequestOptions reqOptions)
设置会议室配置，该接口可以用来设置某个会议层级范围下或者某个会议室的配置。
|
DelRoomLevelResp |
RoomLevel.del(DelRoomLevelReq req,
RequestOptions reqOptions)
删除会议室层级，该接口可以用来删除某个会议室层级。
|
DeleteReserveResp |
Reserve.delete(DeleteReserveReq req,
RequestOptions reqOptions)
删除预约，删除一个预约。
|
DeleteRoomResp |
Room.delete(DeleteRoomReq req,
RequestOptions reqOptions)
删除会议室，该接口可以用来删除某个会议室。
|
DownloadExportResp |
Export.download(DownloadExportReq req,
RequestOptions reqOptions)
下载导出文件，下载导出文件。
|
EndMeetingResp |
Meeting.end(EndMeetingReq req,
RequestOptions reqOptions)
结束会议，结束一个进行中的会议。
|
EventsBotResp |
Bot.events(EventsBotReq req,
RequestOptions reqOptions)
|
GetMeetingListResp |
MeetingList.get(GetMeetingListReq req,
RequestOptions reqOptions)
查询会议明细，查询会议明细，具体权限要求请参考[资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-room-data/resource-introduction)
**说明**;;本接口适用于查询 **进行中** 或者 **已结束** 的会议明细。
|
GetMeetingRecordingResp |
MeetingRecording.get(GetMeetingRecordingReq req,
RequestOptions reqOptions)
获取录制文件，获取一个会议的录制文件。
|
GetMeetingResp |
Meeting.get(GetMeetingReq req,
RequestOptions reqOptions)
获取会议详情，根据会议 ID 获取指定会议的详细信息，包括会议主题、链接、主持人、参会人员、状态、时间信息及关联纪要 ID。
|
GetNoteResp |
Note.get(GetNoteReq req,
RequestOptions reqOptions)
获取纪要详情，获取一篇纪要的详细数据。
|
GetParticipantListResp |
ParticipantList.get(GetParticipantListReq req,
RequestOptions reqOptions)
|
GetReserveConfigAdminResp |
ReserveConfigAdmin.get(GetReserveConfigAdminReq req,
RequestOptions reqOptions)
查询会议室预定管理员，查询会议室预定管理员。
|
GetReserveConfigDisableInformResp |
ReserveConfigDisableInform.get(GetReserveConfigDisableInformReq req,
RequestOptions reqOptions)
|
GetReserveResp |
Reserve.get(GetReserveReq req,
RequestOptions reqOptions)
获取预约，获取一个预约的详情。
|
GetResourceReservationListResp |
ResourceReservationList.get(GetResourceReservationListReq req,
RequestOptions reqOptions)
查询会议室预定数据，查询会议室预定数据，具体权限要求请参考「资源介绍」。
|
GetRoomLevelResp |
RoomLevel.get(GetRoomLevelReq req,
RequestOptions reqOptions)
查询会议室层级详情，该接口可以使用会议室层级 ID 查询会议室层级详情。
|
GetRoomResp |
Room.get(GetRoomReq req,
RequestOptions reqOptions)
查询会议室详情，该接口可以使用会议室 ID 查询会议室详情。
|
GetScopeConfigResp |
ScopeConfig.get(GetScopeConfigReq req,
RequestOptions reqOptions)
查询会议室配置，该接口可以用来查询某个会议层级范围下或者某个会议室的配置。
|
GetActiveMeetingReserveResp |
Reserve.getActiveMeeting(GetActiveMeetingReserveReq req,
RequestOptions reqOptions)
获取活跃会议，获取一个预约的当前活跃会议。
|
GetDailyReportResp |
Report.getDaily(GetDailyReportReq req,
RequestOptions reqOptions)
获取会议报告，获取一段时间内组织的每日会议使用报告。
|
GetTopUserReportResp |
Report.getTopUser(GetTopUserReportReq req,
RequestOptions reqOptions)
获取 Top 用户列表，获取一段时间内组织内会议使用的 Top 用户列表。
|
InviteMeetingResp |
Meeting.invite(InviteMeetingReq req,
RequestOptions reqOptions)
邀请参会人，邀请参会人进入会议。
|
KickoutMeetingResp |
Meeting.kickout(KickoutMeetingReq req,
RequestOptions reqOptions)
移除参会人，将参会人从会议中移除。
|
ListAlertResp |
Alert.list(ListAlertReq req,
RequestOptions reqOptions)
获取告警记录，获取特定条件下租户的设备告警记录。
|
ListRoomLevelResp |
RoomLevel.list(ListRoomLevelReq req,
RequestOptions reqOptions)
查询会议室层级列表，该接口用来查询某个会议室层级下的子层级列表。
|
ListRoomResp |
Room.list(ListRoomReq req,
RequestOptions reqOptions)
查询会议室列表，该接口可以用来查询某个会议室层级下会议室列表。
|
ListByNoMeetingResp |
Meeting.listByNo(ListByNoMeetingReq req,
RequestOptions reqOptions)
获取与会议号关联的会议列表，获取指定时间范围内与会议号关联的会议简要信息列表。
|
MeetingListExportResp |
Export.meetingList(MeetingListExportReq req,
RequestOptions reqOptions)
导出会议明细，导出会议明细，具体权限要求请参考资源介绍。
|
MgetRoomLevelResp |
RoomLevel.mget(MgetRoomLevelReq req,
RequestOptions reqOptions)
批量查询会议室层级详情，该接口可以使用会议室层级 ID 批量查询会议室层级详情。
|
MgetRoomResp |
Room.mget(MgetRoomReq req,
RequestOptions reqOptions)
批量查询会议室详情，该接口可以使用会议室 ID 批量查询会议室详情。
|
ParticipantListExportResp |
Export.participantList(ParticipantListExportReq req,
RequestOptions reqOptions)
导出参会人明细，导出某个会议的参会人详情列表，具体权限要求请参考「资源介绍」。
|
ParticipantQualityListExportResp |
Export.participantQualityList(ParticipantQualityListExportReq req,
RequestOptions reqOptions)
导出参会人会议质量数据，导出某场会议某个参会人的音视频&共享质量数据;（仅支持已结束会议），具体权限要求请参考「资源介绍」。
|
PatchReserveConfigAdminResp |
ReserveConfigAdmin.patch(PatchReserveConfigAdminReq req,
RequestOptions reqOptions)
更新会议室预定管理员，更新会议室预定管理员。
|
PatchReserveConfigDisableInformResp |
ReserveConfigDisableInform.patch(PatchReserveConfigDisableInformReq req,
RequestOptions reqOptions)
|
PatchReserveConfigResp |
ReserveConfig.patch(PatchReserveConfigReq req,
RequestOptions reqOptions)
更新会议室预定限制，更新会议室预定限制。
|
PatchRoomLevelResp |
RoomLevel.patch(PatchRoomLevelReq req,
RequestOptions reqOptions)
更新会议室层级，该接口可以用来更新某个会议室层级的信息。
|
PatchRoomResp |
Room.patch(PatchRoomReq req,
RequestOptions reqOptions)
更新会议室，该接口可以用来更新某个会议室的信息。
|
QueryRoomConfigResp |
RoomConfig.query(QueryRoomConfigReq req,
RequestOptions reqOptions)
查询会议室配置，查询一个范围内的会议室配置。
|
ReserveScopeReserveConfigResp |
ReserveConfig.reserveScope(ReserveScopeReserveConfigReq req,
RequestOptions reqOptions)
查询会议室预定限制，查询会议室预定限制。
|
ResourceReservationListExportResp |
Export.resourceReservationList(ResourceReservationListExportReq req,
RequestOptions reqOptions)
导出会议室预定数据，导出会议室预定数据，具体权限要求请参考「资源介绍」。
|
SearchMeetingResp |
Meeting.search(SearchMeetingReq req,
RequestOptions reqOptions)
搜索会议记录（测试），根据关键词、时间范围等条件搜索会议记录，返回符合条件的会议列表，包含会议 ID、主题、开始时间及参与者等信息。
|
SearchRoomLevelResp |
RoomLevel.search(SearchRoomLevelReq req,
RequestOptions reqOptions)
搜索会议室层级，该接口可以用来搜索会议室层级，支持使用自定义会议室层级 ID 进行查询。
|
SearchRoomResp |
Room.search(SearchRoomReq req,
RequestOptions reqOptions)
搜索会议室，该接口可以用来搜索会议室，支持使用关键词进行搜索，也支持使用自定义会议室 ID 进行查询。
|
SetRoomConfigResp |
RoomConfig.set(SetRoomConfigReq req,
RequestOptions reqOptions)
设置会议室配置，设置一个范围内的会议室配置。
|
SetCheckboardAccessCodeRoomConfigResp |
RoomConfig.setCheckboardAccessCode(SetCheckboardAccessCodeRoomConfigReq req,
RequestOptions reqOptions)
|
SetPermissionMeetingRecordingResp |
MeetingRecording.setPermission(SetPermissionMeetingRecordingReq req,
RequestOptions reqOptions)
授权录制文件，将一个会议的录制文件授权给组织、用户或公开到公网。
|
SetRoomAccessCodeRoomConfigResp |
RoomConfig.setRoomAccessCode(SetRoomAccessCodeRoomConfigReq req,
RequestOptions reqOptions)
|
StopMeetingRecordingResp |
MeetingRecording.stop(StopMeetingRecordingReq req,
RequestOptions reqOptions)
停止录制，在会议中停止录制。
|
SubscriptionMeetingResp |
Meeting.subscription(SubscriptionMeetingReq req,
RequestOptions reqOptions)
订阅会议变更事件，订阅当前用户身份相关的会议资源变更事件。
|
SubscriptionNoteResp |
Note.subscription(SubscriptionNoteReq req,
RequestOptions reqOptions)
订阅纪要变更事件，订阅当前用户身份相关的纪要资源变更事件。
|
UnsubscriptionMeetingResp |
Meeting.unsubscription(UnsubscriptionMeetingReq req,
RequestOptions reqOptions)
取消订阅会议变更事件，取消订阅当前用户身份相关的会议资源变更事件。
|
UnsubscriptionNoteResp |
Note.unsubscription(UnsubscriptionNoteReq req,
RequestOptions reqOptions)
取消订阅纪要变更事件，取消订阅当前用户身份相关的纪要资源变更事件。
|
UpdateReserveResp |
Reserve.update(UpdateReserveReq req,
RequestOptions reqOptions)
更新预约，更新一个预约。
|
UserActiveMeetingBotResp |
Bot.userActiveMeeting(UserActiveMeetingBotReq req,
RequestOptions reqOptions)
获取用户活跃会议列表，查询指定用户当前正在参与的所有会议，返回该用户处于活跃状态的会议列表，包含会议号、会议 ID 及会议标题等核心信息。
|
参数类型为RequestOptions的com.lark.oapi.service.wiki.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
SearchNodeResp |
Node.search(SearchNodeReq req,
RequestOptions reqOptions)
，
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.wiki.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
CopySpaceNodeResp |
SpaceNode.copy(CopySpaceNodeReq req,
RequestOptions reqOptions)
创建知识空间节点副本，此接口用于在知识空间创建节点副本到指定位置。
|
CreateSpaceMemberResp |
SpaceMember.create(CreateSpaceMemberReq req,
RequestOptions reqOptions)
添加知识空间成员，添加知识空间成员或管理员。
|
CreateSpaceNodeResp |
SpaceNode.create(CreateSpaceNodeReq req,
RequestOptions reqOptions)
创建知识空间节点，此接口用于在知识节点里创建[节点](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-overview)到指定位置。
|
CreateSpaceResp |
Space.create(CreateSpaceReq req,
RequestOptions reqOptions)
|
GetSpaceResp |
Space.get(GetSpaceReq req,
RequestOptions reqOptions)
获取知识空间信息，此接口用于根据知识空间 ID 查询知识空间的信息，包括空间的类型、可见性、分享状态等。
|
GetTaskResp |
Task.get(GetTaskReq req,
RequestOptions reqOptions)
|
ListSpaceNodeResp |
SpaceNode.list(ListSpaceNodeReq req,
RequestOptions reqOptions)
获取知识空间子节点列表，此接口用于分页获取Wiki节点的子节点列表。
|
ListSpaceResp |
Space.list(ListSpaceReq req,
RequestOptions reqOptions)
获取知识空间列表，此接口用于获取有权限访问的知识空间列表。
|
MoveSpaceNodeResp |
SpaceNode.move(MoveSpaceNodeReq req,
RequestOptions reqOptions)
移动知识空间节点，此方法用于在Wiki内移动节点，支持跨知识空间移动。
|
MoveDocsToWikiSpaceNodeResp |
SpaceNode.moveDocsToWiki(MoveDocsToWikiSpaceNodeReq req,
RequestOptions reqOptions)
移动云空间文档至知识空间，该接口允许移动云空间文档至知识空间，并挂载在指定位置
### 移动操作 ###;移动后，文档将从“我的空间”或“共享空间”转移至“知识库”后，无法从下列入口查看到文档：;- 云空间主页：快速访问;- 我的空间;- 共享空间;;###
权限变更
###;移动后，文档会向所有可查看“页面树”的用户显示，默认继承父页面的权限设置。
|
UpdateSpaceSettingResp |
SpaceSetting.update(UpdateSpaceSettingReq req,
RequestOptions reqOptions)
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |