UpdateApplicationManagementResp |
ApplicationManagement.update(UpdateApplicationManagementReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.approval.v4.resource中的方法
| 限定符和类型 |
方法和说明 |
AddSignInstanceResp |
Instance.addSign(AddSignInstanceReq req,
RequestOptions reqOptions)
|
ApproveTaskResp |
Task.approve(ApproveTaskReq req,
RequestOptions reqOptions)
审批任务同意,对于单个审批任务进行同意操作。
|
CancelInstanceResp |
Instance.cancel(CancelInstanceReq req,
RequestOptions reqOptions)
|
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)
三方审批定义创建,审批定义是审批的描述,包括审批名称、图标、描述等基础信息。
|
CreateExternalInstanceResp |
ExternalInstance.create(CreateExternalInstanceReq req,
RequestOptions reqOptions)
三方审批实例同步,审批中心不负责审批的流转,审批的流转在三方系统,三方系统在审批流转后生成的审批实例、审批任务、审批抄送数据同步到审批中心。
|
CreateInstanceCommentResp |
InstanceComment.create(CreateInstanceCommentReq req,
RequestOptions reqOptions)
创建评论,在某审批实例下创建、修改评论或评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。
|
CreateInstanceResp |
Instance.create(CreateInstanceReq req,
RequestOptions reqOptions)
|
DeleteInstanceCommentResp |
InstanceComment.delete(DeleteInstanceCommentReq req,
RequestOptions reqOptions)
删除评论,逻辑删除某审批实例下的一条评论或评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。
|
GetApprovalResp |
Approval.get(GetApprovalReq req,
RequestOptions reqOptions)
查看审批定义,根据 Approval Code 获取某个审批定义的详情,用于构造创建审批实例的请求。
|
GetExternalApprovalResp |
ExternalApproval.get(GetExternalApprovalReq req,
RequestOptions reqOptions)
|
ListExternalTaskResp |
ExternalTask.list(ListExternalTaskReq req,
RequestOptions reqOptions)
获取三方审批任务状态,该接口用于获取三方审批的状态。
|
ListInstanceCommentResp |
InstanceComment.list(ListInstanceCommentReq req,
RequestOptions reqOptions)
获取评论,根据 Instance Code 获取某个审批实例下的全部评论与评论回复(不包含审批同意、拒绝、转交等附加的理由或意见)。
|
ListInstanceResp |
Instance.list(ListInstanceReq req,
RequestOptions reqOptions)
批量获取审批实例ID,根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。
|
PreviewInstanceResp |
Instance.preview(PreviewInstanceReq req,
RequestOptions reqOptions)
|
QueryInstanceResp |
Instance.query(QueryInstanceReq req,
RequestOptions reqOptions)
查询实例列表,该接口通过不同条件查询审批系统中符合条件的审批实例列表。
|
QueryTaskResp |
Task.query(QueryTaskReq req,
RequestOptions reqOptions)
|
RejectTaskResp |
Task.reject(RejectTaskReq req,
RequestOptions reqOptions)
审批任务拒绝,对于单个审批任务进行拒绝操作。
|
RemoveInstanceCommentResp |
InstanceComment.remove(RemoveInstanceCommentReq req,
RequestOptions reqOptions)
清空评论,删除某审批实例下的全部评论与评论回复。
|
ResubmitTaskResp |
Task.resubmit(ResubmitTaskReq req,
RequestOptions reqOptions)
审批任务重新提交,对于单个退回到发起人的审批任务进行重新发起操作。
|
SearchTaskResp |
Task.search(SearchTaskReq req,
RequestOptions reqOptions)
|
SearchCcInstanceResp |
Instance.searchCc(SearchCcInstanceReq req,
RequestOptions reqOptions)
查询抄送列表,该接口通过不同条件查询审批系统中符合条件的审批抄送列表。
|
SpecifiedRollbackInstanceResp |
Instance.specifiedRollback(SpecifiedRollbackInstanceReq req,
RequestOptions reqOptions)
审批任务退回,从当前审批任务,退回到已审批的一个或多个任务节点。
|
SubscribeApprovalResp |
Approval.subscribe(SubscribeApprovalReq req,
RequestOptions reqOptions)
订阅审批事件,应用订阅 approval_code 后,该应用就可以收到该审批定义对应实例的事件通知。
|
TransferTaskResp |
Task.transfer(TransferTaskReq req,
RequestOptions reqOptions)
审批任务转交,对于单个审批任务进行转交操作。
|
UnsubscribeApprovalResp |
Approval.unsubscribe(UnsubscribeApprovalReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.attendance.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchCreateUserDailyShiftResp |
UserDailyShift.batchCreate(BatchCreateUserDailyShiftReq req,
RequestOptions reqOptions)
创建或修改班表,班表是用来描述考勤组内人员每天按哪个班次进行上班。
|
BatchCreateUserFlowResp |
UserFlow.batchCreate(BatchCreateUserFlowReq 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 删除班次。
|
DownloadFileResp |
File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件,通过文件 ID 下载指定的文件。
|
GetGroupResp |
Group.get(GetGroupReq req,
RequestOptions reqOptions)
获取考勤组详情,通过考勤组 ID 获取考勤组详情。
|
GetLeaveEmployExpireRecordResp |
LeaveEmployExpireRecord.get(GetLeaveEmployExpireRecordReq req,
RequestOptions reqOptions)
|
GetUserFlowResp |
UserFlow.get(GetUserFlowReq req,
RequestOptions reqOptions)
获取打卡流水记录,通过打卡记录 ID 获取用户的打卡流水记录。
|
ListGroupResp |
Group.list(ListGroupReq req,
RequestOptions reqOptions)
获取考勤组列表,翻页获取所有考勤组列表。
|
ListShiftResp |
Shift.list(ListShiftReq req,
RequestOptions reqOptions)
获取班次列表,翻页获取所有班次列表。
|
ModifyUserSettingResp |
UserSetting.modify(ModifyUserSettingReq req,
RequestOptions reqOptions)
修改用户设置,修改授权内员工的用户设置信息,包括人脸照片文件 ID。
|
PatchLeaveAccrualRecordResp |
LeaveAccrualRecord.patch(PatchLeaveAccrualRecordReq req,
RequestOptions reqOptions)
|
QueryShiftResp |
Shift.query(QueryShiftReq req,
RequestOptions reqOptions)
按名称查询班次,通过班次的名称查询班次信息。
|
QueryUserApprovalResp |
UserApproval.query(QueryUserApprovalReq req,
RequestOptions reqOptions)
获取审批通过数据,获取员工在某段时间内的请假、加班、外出和出差四种审批的通过数据。
|
QueryUserDailyShiftResp |
UserDailyShift.query(QueryUserDailyShiftReq req,
RequestOptions reqOptions)
查询班表信息,支持查询多个用户的排班情况,查询的时间跨度不能超过 30 天。
|
QueryUserFlowResp |
UserFlow.query(QueryUserFlowReq req,
RequestOptions reqOptions)
批量查询打卡流水记录,批量查询授权内员工的实际打卡流水记录。
|
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)
获取打卡结果,获取企业内员工的实际打卡结果,包括上班打卡结果和下班打卡结果。
|
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)
上传文件,上传文件并获取文件 ID,可用于“修改用户设置”接口中的 face_key 参数。
|
参数类型为RequestOptions的com.lark.oapi.service.auth.v3.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateAppAccessTokenResp |
AppAccessToken.create(CreateAppAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
CreateTenantAccessTokenResp |
TenantAccessToken.create(CreateTenantAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
InternalAppAccessTokenResp |
AppAccessToken.internal(InternalAppAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
InternalTenantAccessTokenResp |
TenantAccessToken.internal(InternalTenantAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ResendAppTicketResp |
AppTicket.resend(ResendAppTicketReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.authen.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateAccessTokenResp |
AccessToken.create(CreateAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
CreateOidcAccessTokenResp |
OidcAccessToken.create(CreateOidcAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
CreateOidcRefreshAccessTokenResp |
OidcRefreshAccessToken.create(CreateOidcRefreshAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
CreateRefreshAccessTokenResp |
RefreshAccessToken.create(CreateRefreshAccessTokenReq req,
RequestOptions reqOptions)
,
官网API文档链接:
GetUserInfoResp |
UserInfo.get(RequestOptions reqOptions)
,
官网API文档链接:
参数类型为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)
|
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)
|
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)
新增多条记录,该接口用于在数据表中新增多条记录,单次调用最多新增 500 条记录。
|
BatchCreateAppTableResp |
AppTable.batchCreate(BatchCreateAppTableReq req,
RequestOptions reqOptions)
|
BatchDeleteAppRoleMemberResp |
AppRoleMember.batchDelete(BatchDeleteAppRoleMemberReq req,
RequestOptions reqOptions)
|
BatchDeleteAppTableRecordResp |
AppTableRecord.batchDelete(BatchDeleteAppTableRecordReq req,
RequestOptions reqOptions)
删除多条记录,该接口用于删除数据表中现有的多条记录,单次调用中最多删除 500 条记录。
|
BatchDeleteAppTableResp |
AppTable.batchDelete(BatchDeleteAppTableReq req,
RequestOptions reqOptions)
|
BatchUpdateAppTableRecordResp |
AppTableRecord.batchUpdate(BatchUpdateAppTableRecordReq req,
RequestOptions reqOptions)
更新多条记录,该接口用于更新数据表中的多条记录,单次调用最多更新 500 条记录。
|
CopyAppDashboardResp |
AppDashboard.copy(CopyAppDashboardReq req,
RequestOptions reqOptions)
|
CopyAppResp |
App.copy(CopyAppReq req,
RequestOptions reqOptions)
|
CreateAppRoleResp |
AppRole.create(CreateAppRoleReq 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)
|
DeleteAppTableViewResp |
AppTableView.delete(DeleteAppTableViewReq req,
RequestOptions reqOptions)
|
GetAppResp |
App.get(GetAppReq req,
RequestOptions reqOptions)
获取多维表格元数据,获取指定多维表格的元数据信息,包括多维表格名称,多维表格版本号,多维表格是否开启高级权限等。
|
GetAppTableFormResp |
AppTableForm.get(GetAppTableFormReq req,
RequestOptions reqOptions)
|
GetAppTableRecordResp |
AppTableRecord.get(GetAppTableRecordReq req,
RequestOptions reqOptions)
|
GetAppTableViewResp |
AppTableView.get(GetAppTableViewReq req,
RequestOptions reqOptions)
|
ListAppDashboardResp |
AppDashboard.list(ListAppDashboardReq 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)
|
ListAppTableViewResp |
AppTableView.list(ListAppTableViewReq 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)
|
UpdateAppRoleResp |
AppRole.update(UpdateAppRoleReq req,
RequestOptions reqOptions)
|
UpdateAppTableFieldResp |
AppTableField.update(UpdateAppTableFieldReq req,
RequestOptions reqOptions)
|
UpdateAppTableRecordResp |
AppTableRecord.update(UpdateAppTableRecordReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.board.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
ListWhiteboardNodeResp |
WhiteboardNode.list(ListWhiteboardNodeReq req,
RequestOptions reqOptions)
,列出画板内的节点数据
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.calendar.v4.resource中的方法
| 限定符和类型 |
方法和说明 |
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)
|
CreateCalendarResp |
Calendar.create(CreateCalendarReq req,
RequestOptions reqOptions)
创建共享日历,该接口用于为当前身份(应用 / 用户)创建一个共享日历。
|
CreateExchangeBindingResp |
ExchangeBinding.create(CreateExchangeBindingReq req,
RequestOptions reqOptions)
|
CreateTimeoffEventResp |
TimeoffEvent.create(CreateTimeoffEventReq req,
RequestOptions reqOptions)
创建请假日程,为指定用户创建一个请假日程,可以是一个普通请假日程,也可以是一个全天日程。
|
DeleteCalendarAclResp |
CalendarAcl.delete(DeleteCalendarAclReq req,
RequestOptions reqOptions)
删除访问控制,该接口用于以当前身份(应用 / 用户)删除日历的控制权限,即日历成员。
|
DeleteCalendarEventMeetingChatResp |
CalendarEventMeetingChat.delete(DeleteCalendarEventMeetingChatReq req,
RequestOptions reqOptions)
|
DeleteCalendarResp |
Calendar.delete(DeleteCalendarReq req,
RequestOptions reqOptions)
删除共享日历,该接口用于以当前身份(应用 / 用户)删除一个共享日历。
|
DeleteExchangeBindingResp |
ExchangeBinding.delete(DeleteExchangeBindingReq req,
RequestOptions reqOptions)
|
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)
查询日历信息,该接口用于以当前身份(应用 / 用户)根据日历 ID 获取日历信息。
|
GetExchangeBindingResp |
ExchangeBinding.get(GetExchangeBindingReq req,
RequestOptions reqOptions)
获取绑定状态,本接口获取Exchange账户的绑定状态,包括exchange日历是否同步完成。
|
InstancesCalendarEventResp |
CalendarEvent.instances(InstancesCalendarEventReq req,
RequestOptions reqOptions)
|
ListCalendarEventAttendeeChatMemberResp |
CalendarEventAttendeeChatMember.list(ListCalendarEventAttendeeChatMemberReq req,
RequestOptions reqOptions)
获取日程参与群成员列表,获取日程的群参与人的群成员列表。
|
ListCalendarEventAttendeeResp |
CalendarEventAttendee.list(ListCalendarEventAttendeeReq req,
RequestOptions reqOptions)
获取日程参与人列表,获取日程的参与人列表,若参与者列表中有群组,请使用 [获取参与人群成员列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list) 。
|
ListCalendarEventResp |
CalendarEvent.list(ListCalendarEventReq req,
RequestOptions reqOptions)
获取日程列表,该接口用于以当前身份(应用 / 用户)获取日历下的日程列表。
|
ListCalendarResp |
Calendar.list(ListCalendarReq req,
RequestOptions reqOptions)
查询日历列表,该接口用于分页获得当前身份(应用 / 用户)的日历列表。
|
ListFreebusyResp |
Freebusy.list(ListFreebusyReq req,
RequestOptions reqOptions)
查询主日历忙闲信息,查询用户主日历或会议室的忙闲信息。
|
PatchCalendarEventResp |
CalendarEvent.patch(PatchCalendarEventReq req,
RequestOptions reqOptions)
更新日程,该接口用于以当前身份(应用 / 用户)更新日历上的一个日程。
|
PatchCalendarResp |
Calendar.patch(PatchCalendarReq req,
RequestOptions reqOptions)
更新日历信息,该接口用于以当前身份(应用 / 用户)修改日历信息。
|
PrimaryCalendarResp |
Calendar.primary(PrimaryCalendarReq req,
RequestOptions reqOptions)
查询主日历信息,获取当前身份的主日历信息。
|
ReplyCalendarEventResp |
CalendarEvent.reply(ReplyCalendarEventReq req,
RequestOptions reqOptions)
|
SearchCalendarResp |
Calendar.search(SearchCalendarReq req,
RequestOptions reqOptions)
搜索日历,该接口用于通过关键字查询公共日历或用户主日历。
|
SubscribeCalendarResp |
Calendar.subscribe(SubscribeCalendarReq req,
RequestOptions reqOptions)
订阅日历,该接口用于以当前身份(应用 / 用户)订阅某个日历。
|
SubscriptionCalendarResp |
Calendar.subscription(RequestOptions reqOptions)
订阅日历变更事件,该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。
|
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)
取消订阅日历变更事件,该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。
|
UnsubscriptionCalendarAclResp |
CalendarAcl.unsubscription(UnsubscriptionCalendarAclReq req,
RequestOptions reqOptions)
取消订阅日历访问控制变更事件,该接口用于以用户身份取消订阅指定日历下的日历成员变更事件。
|
UnsubscriptionCalendarEventResp |
CalendarEvent.unsubscription(UnsubscriptionCalendarEventReq req,
RequestOptions reqOptions)
取消订阅日程变更事件,该接口用于以用户身份取消订阅指定日历下的日程变更事件。
|
参数类型为RequestOptions的com.lark.oapi.service.compensation.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
ListChangeReasonResp |
ChangeReason.list(ListChangeReasonReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListIndicatorResp |
Indicator.list(ListIndicatorReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListItemCategoryResp |
ItemCategory.list(ListItemCategoryReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListItemResp |
Item.list(ListItemReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListPlanResp |
Plan.list(ListPlanReq req,
RequestOptions reqOptions)
,
官网API文档链接:
QueryArchiveResp |
Archive.query(QueryArchiveReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.contact.v3.resource中的方法
| 限定符和类型 |
方法和说明 |
AddGroupMemberResp |
GroupMember.add(AddGroupMemberReq req,
RequestOptions reqOptions)
添加用户组成员,向用户组中添加成员(目前成员仅支持用户,未来会支持部门),如果应用的通讯录权限范围是“全部员工”,则可将任何成员添加到任何用户组。
|
BatchDepartmentResp |
Department.batch(BatchDepartmentReq req,
RequestOptions reqOptions)
|
BatchCreateFunctionalRoleMemberResp |
FunctionalRoleMember.batchCreate(BatchCreateFunctionalRoleMemberReq req,
RequestOptions reqOptions)
|
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)
,
官网API文档链接:
CreateGroupResp |
Group.create(CreateGroupReq req,
RequestOptions reqOptions)
创建用户组,使用该接口创建用户组,请注意创建用户组时应用的通讯录权限范围需为“全部员工”,否则会创建失败,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
CreateJobFamilyResp |
JobFamily.create(CreateJobFamilyReq 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)
,
官网API文档链接:
DeleteGroupResp |
Group.delete(DeleteGroupReq req,
RequestOptions reqOptions)
删除用户组,通过该接口可删除企业中的用户组,请注意删除用户组时应用的通讯录权限范围需为“全部员工”,否则会删除失败,[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
|
DeleteJobFamilyResp |
JobFamily.delete(DeleteJobFamilyReq req,
RequestOptions reqOptions)
|
DeleteUserResp |
User.delete(DeleteUserReq req,
RequestOptions reqOptions)
删除用户,该接口用于从通讯录删除一个用户信息,可以理解为员工离职。
|
FindByDepartmentUserResp |
User.findByDepartment(FindByDepartmentUserReq req,
RequestOptions reqOptions)
获取部门直属用户列表,基于部门ID获取部门直属用户列表。
|
GetDepartmentResp |
Department.get(GetDepartmentReq req,
RequestOptions reqOptions)
获取单个部门信息,该接口用于向通讯录获取单个部门信息。
|
GetFunctionalRoleMemberResp |
FunctionalRoleMember.get(GetFunctionalRoleMemberReq req,
RequestOptions reqOptions)
|
GetJobFamilyResp |
JobFamily.get(GetJobFamilyReq req,
RequestOptions reqOptions)
|
GetUserResp |
User.get(GetUserReq req,
RequestOptions reqOptions)
获取单个用户信息,该接口用于获取通讯录中单个用户的信息。
|
GetWorkCityResp |
WorkCity.get(GetWorkCityReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListCustomAttrResp |
CustomAttr.list(ListCustomAttrReq req,
RequestOptions reqOptions)
获取企业自定义用户字段,获取企业自定义的用户字段配置信息
调用该接口前,需要先确认[企业管理员](https://www.feishu.cn/hc/zh-CN/articles/360049067822)在[企业管理后台 - 组织架构 - 成员字段管理](http://www.feishu.cn/admin/contacts/employee-field-new/custom) 自定义字段管理栏开启了“允许开放平台API调用“。
|
|
ListDepartmentResp |
Department.list(ListDepartmentReq req,
RequestOptions reqOptions)
|
ListFunctionalRoleMemberResp |
FunctionalRoleMember.list(ListFunctionalRoleMemberReq req,
RequestOptions reqOptions)
|
ListUnitResp |
Unit.list(ListUnitReq req,
RequestOptions reqOptions)
|
ListUserResp |
User.list(ListUserReq req,
RequestOptions reqOptions)
|
MemberBelongGroupResp |
Group.memberBelong(MemberBelongGroupReq req,
RequestOptions reqOptions)
查询用户所属用户组,通过该接口可查询该用户所属的用户组列表,可分别查询普通用户组和动态用户组。
|
ParentDepartmentResp |
Department.parent(ParentDepartmentReq req,
RequestOptions reqOptions)
获取父部门信息,该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。
|
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)
|
SimplelistGroupMemberResp |
GroupMember.simplelist(SimplelistGroupMemberReq req,
RequestOptions reqOptions)
查询用户组成员列表,通过该接口可查询某个用户组的成员列表(支持查询成员中的用户和部门), 本接口支持普通用户组和动态用户组。
|
SimplelistGroupResp |
Group.simplelist(SimplelistGroupReq req,
RequestOptions reqOptions)
查询用户组列表,通过该接口可查询企业的用户组列表,可分别查询普通用户组或动态用户组。
|
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)
|
UpdateDepartmentIdDepartmentResp |
Department.updateDepartmentId(UpdateDepartmentIdDepartmentReq req,
RequestOptions reqOptions)
,
官网API文档链接:
UpdateUserIdUserResp |
User.updateUserId(UpdateUserIdUserReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.corehr.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AddEnumOptionCommonDataMetaDataResp |
CommonDataMetaData.addEnumOption(AddEnumOptionCommonDataMetaDataReq req,
RequestOptions reqOptions)
|
CreateContractResp |
Contract.create(CreateContractReq req,
RequestOptions reqOptions)
|
CreateDepartmentResp |
Department.create(CreateDepartmentReq req,
RequestOptions reqOptions)
|
CreateEmployeeTypeResp |
EmployeeType.create(CreateEmployeeTypeReq req,
RequestOptions reqOptions)
|
CreateEmploymentResp |
Employment.create(CreateEmploymentReq req,
RequestOptions reqOptions)
|
CreateJobChangeResp |
JobChange.create(CreateJobChangeReq req,
RequestOptions reqOptions)
|
CreateJobDataResp |
JobData.create(CreateJobDataReq req,
RequestOptions reqOptions)
|
CreateJobFamilyResp |
JobFamily.create(CreateJobFamilyReq req,
RequestOptions reqOptions)
|
CreateJobLevelResp |
JobLevel.create(CreateJobLevelReq req,
RequestOptions reqOptions)
|
CreateJobResp |
Job.create(CreateJobReq req,
RequestOptions reqOptions)
|
CreateLeaveGrantingRecordResp |
LeaveGrantingRecord.create(CreateLeaveGrantingRecordReq req,
RequestOptions reqOptions)
|
CreateLocationResp |
Location.create(CreateLocationReq req,
RequestOptions reqOptions)
|
CreateNationalIdTypeResp |
NationalIdType.create(CreateNationalIdTypeReq 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)
|
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)
|
DeleteJobLevelResp |
JobLevel.delete(DeleteJobLevelReq req,
RequestOptions reqOptions)
|
DeleteJobResp |
Job.delete(DeleteJobReq req,
RequestOptions reqOptions)
|
DeleteLeaveGrantingRecordResp |
LeaveGrantingRecord.delete(DeleteLeaveGrantingRecordReq req,
RequestOptions reqOptions)
|
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)
|
DeleteWorkingHoursTypeResp |
WorkingHoursType.delete(DeleteWorkingHoursTypeReq req,
RequestOptions reqOptions)
|
EditEnumOptionCommonDataMetaDataResp |
CommonDataMetaData.editEnumOption(EditEnumOptionCommonDataMetaDataReq req,
RequestOptions reqOptions)
|
GetContractResp |
Contract.get(GetContractReq req,
RequestOptions reqOptions)
|
GetCountryRegionResp |
CountryRegion.get(GetCountryRegionReq req,
RequestOptions reqOptions)
|
GetCurrencyResp |
Currency.get(GetCurrencyReq req,
RequestOptions reqOptions)
|
GetDepartmentResp |
Department.get(GetDepartmentReq req,
RequestOptions reqOptions)
|
GetEmployeeTypeResp |
EmployeeType.get(GetEmployeeTypeReq req,
RequestOptions reqOptions)
|
GetFileResp |
File.get(GetFileReq req,
RequestOptions reqOptions)
|
GetJobFamilyResp |
JobFamily.get(GetJobFamilyReq req,
RequestOptions reqOptions)
|
GetJobLevelResp |
JobLevel.get(GetJobLevelReq req,
RequestOptions reqOptions)
|
GetJobResp |
Job.get(GetJobReq req,
RequestOptions reqOptions)
|
GetLocationResp |
Location.get(GetLocationReq req,
RequestOptions reqOptions)
|
GetNationalIdTypeResp |
NationalIdType.get(GetNationalIdTypeReq req,
RequestOptions reqOptions)
|
GetPersonResp |
Person.get(GetPersonReq req,
RequestOptions reqOptions)
|
GetPreHireResp |
PreHire.get(GetPreHireReq req,
RequestOptions reqOptions)
|
GetProcessFormVariableDataResp |
ProcessFormVariableData.get(GetProcessFormVariableDataReq req,
RequestOptions reqOptions)
|
GetSubdivisionResp |
Subdivision.get(GetSubdivisionReq req,
RequestOptions reqOptions)
|
GetSubregionResp |
Subregion.get(GetSubregionReq req,
RequestOptions reqOptions)
|
GetWorkingHoursTypeResp |
WorkingHoursType.get(GetWorkingHoursTypeReq req,
RequestOptions reqOptions)
|
GetByParamAuthorizationResp |
Authorization.getByParam(GetByParamAuthorizationReq 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)
|
ListCountryRegionResp |
CountryRegion.list(ListCountryRegionReq req,
RequestOptions reqOptions)
|
ListCurrencyResp |
Currency.list(ListCurrencyReq req,
RequestOptions reqOptions)
|
ListDepartmentResp |
Department.list(ListDepartmentReq req,
RequestOptions reqOptions)
|
ListEmployeeTypeResp |
EmployeeType.list(ListEmployeeTypeReq req,
RequestOptions reqOptions)
|
ListJobDataResp |
JobData.list(ListJobDataReq req,
RequestOptions reqOptions)
|
ListJobFamilyResp |
JobFamily.list(ListJobFamilyReq req,
RequestOptions reqOptions)
|
ListJobLevelResp |
JobLevel.list(ListJobLevelReq req,
RequestOptions reqOptions)
|
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)
|
ListSecurityGroupResp |
SecurityGroup.list(ListSecurityGroupReq req,
RequestOptions reqOptions)
|
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)
|
PatchDepartmentResp |
Department.patch(PatchDepartmentReq req,
RequestOptions reqOptions)
|
PatchEmployeeTypeResp |
EmployeeType.patch(PatchEmployeeTypeReq req,
RequestOptions reqOptions)
|
PatchEmploymentResp |
Employment.patch(PatchEmploymentReq req,
RequestOptions reqOptions)
|
PatchJobDataResp |
JobData.patch(PatchJobDataReq req,
RequestOptions reqOptions)
|
PatchJobFamilyResp |
JobFamily.patch(PatchJobFamilyReq req,
RequestOptions reqOptions)
|
PatchJobLevelResp |
JobLevel.patch(PatchJobLevelReq req,
RequestOptions reqOptions)
|
PatchJobResp |
Job.patch(PatchJobReq req,
RequestOptions reqOptions)
|
PatchNationalIdTypeResp |
NationalIdType.patch(PatchNationalIdTypeReq req,
RequestOptions reqOptions)
|
PatchPersonResp |
Person.patch(PatchPersonReq req,
RequestOptions reqOptions)
|
PatchPreHireResp |
PreHire.patch(PatchPreHireReq req,
RequestOptions reqOptions)
|
PatchWorkingHoursTypeResp |
WorkingHoursType.patch(PatchWorkingHoursTypeReq req,
RequestOptions reqOptions)
|
QueryAuthorizationResp |
Authorization.query(QueryAuthorizationReq req,
RequestOptions reqOptions)
|
QueryOffboardingResp |
Offboarding.query(QueryOffboardingReq req,
RequestOptions reqOptions)
|
QuerySecurityGroupResp |
SecurityGroup.query(QuerySecurityGroupReq req,
RequestOptions reqOptions)
|
QueryTransferReasonResp |
TransferReason.query(QueryTransferReasonReq req,
RequestOptions reqOptions)
|
QueryTransferTypeResp |
TransferType.query(QueryTransferTypeReq req,
RequestOptions reqOptions)
|
RemoveRoleAssignAuthorizationResp |
Authorization.removeRoleAssign(RemoveRoleAssignAuthorizationReq req,
RequestOptions reqOptions)
|
SearchOffboardingResp |
Offboarding.search(SearchOffboardingReq req,
RequestOptions reqOptions)
|
UpdateRoleAssignAuthorizationResp |
Authorization.updateRoleAssign(UpdateRoleAssignAuthorizationReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.corehr.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchGetCompanyResp |
Company.batchGet(BatchGetCompanyReq req,
RequestOptions reqOptions)
|
CreateProbationAssessmentResp |
ProbationAssessment.create(CreateProbationAssessmentReq req,
RequestOptions reqOptions)
|
GetProcessFormVariableDataResp |
ProcessFormVariableData.get(GetProcessFormVariableDataReq req,
RequestOptions reqOptions)
,
官网API文档链接:
GetProcessResp |
Process.get(GetProcessReq req,
RequestOptions reqOptions)
,
官网API文档链接:
GetByDepartmentBpResp |
Bp.getByDepartment(GetByDepartmentBpReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListBpResp |
Bp.list(ListBpReq req,
RequestOptions reqOptions)
,待补充
官网API文档链接:
ListJobResp |
Job.list(ListJobReq req,
RequestOptions reqOptions)
,分页查询职务数据
官网API文档链接:
ListProcessResp |
Process.list(ListProcessReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ParentsDepartmentResp |
Department.parents(ParentsDepartmentReq req,
RequestOptions reqOptions)
,
官网API文档链接:
PatchCostCenterResp |
CostCenter.patch(PatchCostCenterReq req,
RequestOptions reqOptions)
,创建成本中心版本
官网API文档链接:
PatchCostCenterVersionResp |
CostCenterVersion.patch(PatchCostCenterVersionReq req,
RequestOptions reqOptions)
,创建成本中心版本
官网API文档链接:
PatchPersonResp |
Person.patch(PatchPersonReq req,
RequestOptions reqOptions)
,
官网API文档链接:
PatchPreHireResp |
PreHire.patch(PatchPreHireReq req,
RequestOptions reqOptions)
,更新待入职
官网API文档链接:
PatchProbationAssessmentResp |
ProbationAssessment.patch(PatchProbationAssessmentReq req,
RequestOptions reqOptions)
,
官网API文档链接:
QueryEmployeesJobDataResp |
EmployeesJobData.query(QueryEmployeesJobDataReq req,
RequestOptions reqOptions)
,
官网API文档链接:
QueryJobGradeResp |
JobGrade.query(QueryJobGradeReq req,
RequestOptions reqOptions)
,查询职等信息
官网API文档链接:
QueryPreHireResp |
PreHire.query(QueryPreHireReq req,
RequestOptions reqOptions)
,批量查询待入职数据
官网API文档链接:
QueryMultiTimelineDepartmentResp |
Department.queryMultiTimeline(QueryMultiTimelineDepartmentReq req,
RequestOptions reqOptions)
,查询任意日期部门信息
官网API文档链接:
QueryTimelineDepartmentResp |
Department.queryTimeline(QueryTimelineDepartmentReq req,
RequestOptions reqOptions)
,查询任意日期部门信息
官网API文档链接:
SearchBasicInfoBankBranchResp |
BasicInfoBankBranch.search(SearchBasicInfoBankBranchReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoBankResp |
BasicInfoBank.search(SearchBasicInfoBankReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoCityResp |
BasicInfoCity.search(SearchBasicInfoCityReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoCountryRegionResp |
BasicInfoCountryRegion.search(SearchBasicInfoCountryRegionReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoCountryRegionSubdivisionResp |
BasicInfoCountryRegionSubdivision.search(SearchBasicInfoCountryRegionSubdivisionReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoCurrencyResp |
BasicInfoCurrency.search(SearchBasicInfoCurrencyReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoDistrictResp |
BasicInfoDistrict.search(SearchBasicInfoDistrictReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchBasicInfoNationalityResp |
BasicInfoNationality.search(SearchBasicInfoNationalityReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SearchContractResp |
Contract.search(SearchContractReq req,
RequestOptions reqOptions)
,根据合同 ID 、雇佣 ID 查询合同信息
官网API文档链接:
SearchCostCenterResp |
CostCenter.search(SearchCostCenterReq req,
RequestOptions reqOptions)
,查询成本中心信息
官网API文档链接:
SearchDepartmentResp |
Department.search(SearchDepartmentReq req,
RequestOptions reqOptions)
,根据部门 ID,上级部门查询部门列表
官网API文档链接:
SearchEmployeeResp |
Employee.search(SearchEmployeeReq req,
RequestOptions reqOptions)
,根据 email、工号、个人电话等条件查询员工雇佣信息以及个人基础信息
官网API文档链接:
SearchJobChangeResp |
JobChange.search(SearchJobChangeReq req,
RequestOptions reqOptions)
,获取员工异动列表
官网API文档链接:
SearchPreHireResp |
PreHire.search(SearchPreHireReq req,
RequestOptions reqOptions)
,根据部门 ID,上级部门查询部门列表
官网API文档链接:
SearchProbationResp |
Probation.search(SearchProbationReq req,
RequestOptions reqOptions)
,
官网API文档链接:
SubmitProbationResp |
Probation.submit(SubmitProbationReq req,
RequestOptions reqOptions)
,
官网API文档链接:
TransitTaskPreHireResp |
PreHire.transitTask(TransitTaskPreHireReq req,
RequestOptions reqOptions)
,任务流转
官网API文档链接:
WithdrawProbationResp |
Probation.withdraw(WithdrawProbationReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.document_ai.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
FieldExtractionContractResp |
Contract.fieldExtraction(FieldExtractionContractReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ParseResumeResp |
Resume.parse(ParseResumeReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeBankCardResp |
BankCard.recognize(RecognizeBankCardReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeBusinessCardResp |
BusinessCard.recognize(RecognizeBusinessCardReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeBusinessLicenseResp |
BusinessLicense.recognize(RecognizeBusinessLicenseReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeChinesePassportResp |
ChinesePassport.recognize(RecognizeChinesePassportReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeDrivingLicenseResp |
DrivingLicense.recognize(RecognizeDrivingLicenseReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeFoodManageLicenseResp |
FoodManageLicense.recognize(RecognizeFoodManageLicenseReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeFoodProduceLicenseResp |
FoodProduceLicense.recognize(RecognizeFoodProduceLicenseReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeHealthCertificateResp |
HealthCertificate.recognize(RecognizeHealthCertificateReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeHkmMainlandTravelPermitResp |
HkmMainlandTravelPermit.recognize(RecognizeHkmMainlandTravelPermitReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeIdCardResp |
IdCard.recognize(RecognizeIdCardReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeTaxiInvoiceResp |
TaxiInvoice.recognize(RecognizeTaxiInvoiceReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeTrainInvoiceResp |
TrainInvoice.recognize(RecognizeTrainInvoiceReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeTwMainlandTravelPermitResp |
TwMainlandTravelPermit.recognize(RecognizeTwMainlandTravelPermitReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeVatInvoiceResp |
VatInvoice.recognize(RecognizeVatInvoiceReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeVehicleInvoiceResp |
VehicleInvoice.recognize(RecognizeVehicleInvoiceReq req,
RequestOptions reqOptions)
,
官网API文档链接:
RecognizeVehicleLicenseResp |
VehicleLicense.recognize(RecognizeVehicleLicenseReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.docx.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
BatchDeleteDocumentBlockChildrenResp |
DocumentBlockChildren.batchDelete(BatchDeleteDocumentBlockChildrenReq req,
RequestOptions reqOptions)
删除块,指定需要操作的块,删除其指定范围的子块。
|
BatchUpdateDocumentBlockResp |
DocumentBlock.batchUpdate(BatchUpdateDocumentBlockReq req,
RequestOptions reqOptions)
批量更新块,批量更新块的富文本内容。
|
CreateDocumentBlockChildrenResp |
DocumentBlockChildren.create(CreateDocumentBlockChildrenReq req,
RequestOptions reqOptions)
创建块,指定需要操作的块,为其创建一批子块,并插入到指定位置。
|
CreateDocumentResp |
Document.create(CreateDocumentReq req,
RequestOptions reqOptions)
创建文档,创建新版文档,文档标题和目录可选。
|
GetDocumentBlockChildrenResp |
DocumentBlockChildren.get(GetDocumentBlockChildrenReq req,
RequestOptions reqOptions)
获取所有子块,给定一个指定版本的文档,并指定需要操作的块,分页遍历其所有子块富文本内容 。
|
GetDocumentBlockResp |
DocumentBlock.get(GetDocumentBlockReq req,
RequestOptions reqOptions)
获取块,获取指定块的富文本内容。
|
GetDocumentResp |
Document.get(GetDocumentReq req,
RequestOptions reqOptions)
获取文档基本信息,获取文档最新版本号、标题等
在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnWKAE4aSaIU4GcdLInSaVde),了解相关规则及约束。
|
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)
|
BatchQueryFileCommentResp |
FileComment.batchQuery(BatchQueryFileCommentReq req,
RequestOptions reqOptions)
批量获取评论,该接口用于根据评论 ID 列表批量获取评论。
|
BatchQueryMetaResp |
Meta.batchQuery(BatchQueryMetaReq req,
RequestOptions reqOptions)
|
CopyFileResp |
File.copy(CopyFileReq req,
RequestOptions reqOptions)
复制文件,将文件复制到用户云空间的其他文件夹中。
|
CreateExportTaskResp |
ExportTask.create(CreateExportTaskReq req,
RequestOptions reqOptions)
创建导出任务,创建导出任务,将云文件导出为指定格式的本地文件。
|
CreateFileCommentResp |
FileComment.create(CreateFileCommentReq req,
RequestOptions reqOptions)
添加评论,往云文档添加一条全局评论。
|
CreateFileSubscriptionResp |
FileSubscription.create(CreateFileSubscriptionReq req,
RequestOptions reqOptions)
|
CreateFileVersionResp |
FileVersion.create(CreateFileVersionReq req,
RequestOptions reqOptions)
创建文档版本,创建文档版本。
|
CreateImportTaskResp |
ImportTask.create(CreateImportTaskReq req,
RequestOptions reqOptions)
创建导入任务,创建导入任务。
|
CreatePermissionMemberResp |
PermissionMember.create(CreatePermissionMemberReq req,
RequestOptions reqOptions)
增加协作者权限,该接口用于根据 filetoken 给用户增加文档的权限。
|
CreatePermissionPublicPasswordResp |
PermissionPublicPassword.create(CreatePermissionPublicPasswordReq req,
RequestOptions reqOptions)
|
CreateShortcutFileResp |
File.createShortcut(CreateShortcutFileReq req,
RequestOptions reqOptions)
|
DeleteFileResp |
File.delete(DeleteFileReq req,
RequestOptions reqOptions)
删除文件,删除用户在云空间内的文件或者文件夹。
|
DeleteFileVersionResp |
FileVersion.delete(DeleteFileVersionReq req,
RequestOptions reqOptions)
删除文档版本,删除文档版本。
|
DeletePermissionMemberResp |
PermissionMember.delete(DeletePermissionMemberReq req,
RequestOptions reqOptions)
移除协作者权限,该接口用于根据 filetoken 移除文档协作者的权限。
|
DeletePermissionPublicPasswordResp |
PermissionPublicPassword.delete(DeletePermissionPublicPasswordReq req,
RequestOptions reqOptions)
|
DownloadExportTaskResp |
ExportTask.download(DownloadExportTaskReq req,
RequestOptions reqOptions)
|
DownloadFileResp |
File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件,使用该接口可以下载在云空间目录下的文件(不含飞书文档/表格/思维导图等在线文档)。
|
DownloadMediaResp |
Media.download(DownloadMediaReq req,
RequestOptions reqOptions)
下载素材,使用该接口可以下载素材。
|
GetExportTaskResp |
ExportTask.get(GetExportTaskReq req,
RequestOptions reqOptions)
查询导出任务结果,根据[创建导出任务](/ssl::ttdoc//uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create)的ticket查询导出任务的结果,前提条件需要先调用创建导出任务接口。
|
GetFileCommentResp |
FileComment.get(GetFileCommentReq req,
RequestOptions reqOptions)
获取评论,获取云文档中的某条评论。
|
GetFileStatisticsResp |
FileStatistics.get(GetFileStatisticsReq req,
RequestOptions reqOptions)
获取文件统计信息,此接口用于获取文件统计信息,包括文档阅读人数、次数和点赞数。
|
GetFileSubscriptionResp |
FileSubscription.get(GetFileSubscriptionReq req,
RequestOptions reqOptions)
|
GetFileVersionResp |
FileVersion.get(GetFileVersionReq req,
RequestOptions reqOptions)
获取文档版本,获取文档版本。
|
GetImportTaskResp |
ImportTask.get(GetImportTaskReq req,
RequestOptions reqOptions)
查询导入结果,根据创建导入任务返回的 ticket 查询导入结果。
|
GetPermissionPublicResp |
PermissionPublic.get(GetPermissionPublicReq req,
RequestOptions reqOptions)
获取云文档权限设置,该接口用于根据 filetoken 获取云文档的权限设置。
|
GetSubscribeFileResp |
File.getSubscribe(GetSubscribeFileReq req,
RequestOptions reqOptions)
查询云文档事件订阅状态,该接口**仅支持文档拥有者**查询自己文档的订阅状态,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。
|
ListFileCommentReplyResp |
FileCommentReply.list(ListFileCommentReplyReq req,
RequestOptions reqOptions)
获取回复,该接口用于根据评论 ID 以及分页参数,获取回复。
|
ListFileCommentResp |
FileComment.list(ListFileCommentReq req,
RequestOptions reqOptions)
分页获取文档评论,该接口用于根据文档 token 分页获取文档评论。
|
ListFileResp |
File.list(ListFileReq req,
RequestOptions reqOptions)
获取文件夹下的清单,获取用户云空间中指定文件夹下的文件清单。
|
ListFileVersionResp |
FileVersion.list(ListFileVersionReq req,
RequestOptions reqOptions)
获取文档版本列表,获取文档所有版本。
|
ListFileViewRecordResp |
FileViewRecord.list(ListFileViewRecordReq req,
RequestOptions reqOptions)
|
MoveFileResp |
File.move(MoveFileReq req,
RequestOptions reqOptions)
移动文件,将文件或者文件夹移动到用户云空间的其他位置。
|
PatchFileCommentResp |
FileComment.patch(PatchFileCommentReq req,
RequestOptions reqOptions)
解决/恢复 评论,解决或恢复云文档中的评论。
|
PatchFileSubscriptionResp |
FileSubscription.patch(PatchFileSubscriptionReq req,
RequestOptions reqOptions)
|
PatchPermissionPublicResp |
PermissionPublic.patch(PatchPermissionPublicReq req,
RequestOptions reqOptions)
更新云文档权限设置,该接口用于根据 filetoken 更新云文档的权限设置。
|
SubscribeFileResp |
File.subscribe(SubscribeFileReq req,
RequestOptions reqOptions)
订阅云文档事件,该接口仅支持**文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。
|
TaskCheckFileResp |
File.taskCheck(TaskCheckFileReq req,
RequestOptions reqOptions)
查询异步任务状态,查询删除文件夹等异步任务的状态信息。
|
TransferOwnerPermissionMemberResp |
PermissionMember.transferOwner(TransferOwnerPermissionMemberReq req,
RequestOptions reqOptions)
|
UpdatePermissionMemberResp |
PermissionMember.update(UpdatePermissionMemberReq req,
RequestOptions reqOptions)
更新协作者权限,该接口用于根据 filetoken 更新文档协作者的权限。
|
UpdatePermissionPublicPasswordResp |
PermissionPublicPassword.update(UpdatePermissionPublicPasswordReq req,
RequestOptions reqOptions)
|
UploadAllMediaResp |
Media.uploadAll(UploadAllMediaReq req,
RequestOptions reqOptions)
上传素材,将文件、图片、视频等素材文件上传到指定云文档中。
|
UploadFinishFileResp |
File.uploadFinish(UploadFinishFileReq req,
RequestOptions reqOptions)
分片上传文件(完成上传),触发完成上传。
|
UploadFinishMediaResp |
Media.uploadFinish(UploadFinishMediaReq req,
RequestOptions reqOptions)
分片上传素材(完成上传),触发完成上传。
|
UploadPartFileResp |
File.uploadPart(UploadPartFileReq req,
RequestOptions reqOptions)
分片上传文件(上传分片),上传对应的文件块。
|
UploadPartMediaResp |
Media.uploadPart(UploadPartMediaReq req,
RequestOptions reqOptions)
分片上传素材(上传分片),上传对应的文件块。
|
UploadPrepareFileResp |
File.uploadPrepare(UploadPrepareFileReq req,
RequestOptions reqOptions)
分片上传文件(预上传),发送初始化请求获取上传事务ID和分块策略,目前是以4MB大小进行定长分片。
|
UploadPrepareMediaResp |
Media.uploadPrepare(UploadPrepareMediaReq req,
RequestOptions reqOptions)
分片上传素材(预上传),发送初始化请求获取上传事务ID和分块策略,目前是以4MB大小进行定长分片。
|
参数类型为RequestOptions的com.lark.oapi.service.drive.v2.resource中的方法
| 限定符和类型 |
方法和说明 |
GetPermissionPublicResp |
PermissionPublic.get(GetPermissionPublicReq req,
RequestOptions reqOptions)
,
官网API文档链接:
PatchPermissionPublicResp |
PermissionPublic.patch(PatchPermissionPublicReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.gray_test_open_sg.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
CreateMotoResp |
Moto.create(CreateMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
GetMotoResp |
Moto.get(GetMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListMotoResp |
Moto.list(ListMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为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)
|
CreateTicketMessageResp |
TicketMessage.create(CreateTicketMessageReq 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)
获取工单自定义字段,该接口用于获取工单自定义字段详情。
|
GetTicketResp |
Ticket.get(GetTicketReq req,
RequestOptions reqOptions)
获取工单详情,该接口用于获取单个服务台工单详情。
|
ListAgentScheduleResp |
AgentSchedule.list(ListAgentScheduleReq req,
RequestOptions reqOptions)
|
ListCategoryResp |
Category.list(ListCategoryReq req,
RequestOptions reqOptions)
|
ListFaqResp |
Faq.list(ListFaqReq req,
RequestOptions reqOptions)
获取全部知识库详情,该接口用于获取服务台知识库详情。
|
ListTicketCustomizedFieldResp |
TicketCustomizedField.list(ListTicketCustomizedFieldReq req,
RequestOptions reqOptions)
获取全部工单自定义字段,该接口用于获取全部工单自定义字段。
|
ListTicketMessageResp |
TicketMessage.list(ListTicketMessageReq 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)
更新工单自定义字段,该接口用于更新自定义字段。
|
PreviewNotificationResp |
Notification.preview(PreviewNotificationReq req,
RequestOptions reqOptions)
|
SearchFaqResp |
Faq.search(SearchFaqReq req,
RequestOptions reqOptions)
搜索知识库,该接口用于搜索服务台知识库。
|
StartServiceTicketResp |
Ticket.startService(StartServiceTicketReq req,
RequestOptions reqOptions)
创建服务台对话,该接口用于创建服务台对话。
|
SubmitApproveNotificationResp |
Notification.submitApprove(SubmitApproveNotificationReq req,
RequestOptions reqOptions)
|
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)
|
BatchDeleteEcoAccountCustomFieldResp |
EcoAccountCustomField.batchDelete(BatchDeleteEcoAccountCustomFieldReq req,
RequestOptions reqOptions)
删除帐号自定义字段,删除用户在服务商处的身份标示字段(如用户在服务商处的租户 ID)。
|
BatchDeleteEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.batchDelete(BatchDeleteEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
删除背调自定义字段,删除用户在发起背调时的自定义字段,删除不影响已创建的背调,删除后对应的自定义字段的 key 不能再复用。
|
BatchDeleteEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.batchDelete(BatchDeleteEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
删除背调套餐和附加调查项,删除指定帐号的指定背调套餐和附加调查项信息,删除不会影响已创建的背调。
|
BatchDeleteEcoExamPaperResp |
EcoExamPaper.batchDelete(BatchDeleteEcoExamPaperReq req,
RequestOptions reqOptions)
|
BatchUpdateEcoAccountCustomFieldResp |
EcoAccountCustomField.batchUpdate(BatchUpdateEcoAccountCustomFieldReq req,
RequestOptions reqOptions)
更新帐号自定义字段,更新用户在服务商处的身份标示字段(如用户在服务商处的租户 ID),此方法只会更新同一 scope 内 key 一致的自定义字段。
|
BatchUpdateEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.batchUpdate(BatchUpdateEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
更新背调自定义字段,更新用户在发起背调时的自定义字段。
|
BatchUpdateEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.batchUpdate(BatchUpdateEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
|
BatchUpdateEcoExamPaperResp |
EcoExamPaper.batchUpdate(BatchUpdateEcoExamPaperReq req,
RequestOptions reqOptions)
|
CombinedCreateJobResp |
Job.combinedCreate(CombinedCreateJobReq req,
RequestOptions reqOptions)
新建职位,新建职位,字段的是否必填,以系统中的「职位字段管理」中的设置为准。
|
CombinedCreateTalentResp |
Talent.combinedCreate(CombinedCreateTalentReq req,
RequestOptions reqOptions)
创建人才,用于在企业内创建一个人才。
|
CombinedUpdateJobResp |
Job.combinedUpdate(CombinedUpdateJobReq req,
RequestOptions reqOptions)
更新职位,更新职位信息,该接口为全量更新,若字段没有返回值,则原有值将会被清空。
|
ConfigJobResp |
Job.config(ConfigJobReq req,
RequestOptions reqOptions)
|
CreateApplicationResp |
Application.create(CreateApplicationReq req,
RequestOptions reqOptions)
|
CreateEcoAccountCustomFieldResp |
EcoAccountCustomField.create(CreateEcoAccountCustomFieldReq req,
RequestOptions reqOptions)
创建帐号自定义字段,定制用户在服务商处的身份标示字段(如用户在服务商处的租户 ID)。
|
CreateEcoBackgroundCheckCustomFieldResp |
EcoBackgroundCheckCustomField.create(CreateEcoBackgroundCheckCustomFieldReq req,
RequestOptions reqOptions)
|
CreateEcoBackgroundCheckPackageResp |
EcoBackgroundCheckPackage.create(CreateEcoBackgroundCheckPackageReq req,
RequestOptions reqOptions)
|
CreateEcoExamPaperResp |
EcoExamPaper.create(CreateEcoExamPaperReq req,
RequestOptions reqOptions)
|
CreateExternalBackgroundCheckResp |
ExternalBackgroundCheck.create(CreateExternalBackgroundCheckReq req,
RequestOptions reqOptions)
|
CreateExternalInterviewAssessmentResp |
ExternalInterviewAssessment.create(CreateExternalInterviewAssessmentReq req,
RequestOptions reqOptions)
|
CreateExternalInterviewResp |
ExternalInterview.create(CreateExternalInterviewReq req,
RequestOptions reqOptions)
|
CreateJobRequirementResp |
JobRequirement.create(CreateJobRequirementReq req,
RequestOptions reqOptions)
|
CreateNoteResp |
Note.create(CreateNoteReq req,
RequestOptions reqOptions)
|
CreateOfferResp |
Offer.create(CreateOfferReq req,
RequestOptions reqOptions)
|
CreateReferralAccountResp |
ReferralAccount.create(CreateReferralAccountReq req,
RequestOptions reqOptions)
|
CreateWebsiteSiteUserResp |
WebsiteSiteUser.create(CreateWebsiteSiteUserReq req,
RequestOptions reqOptions)
|
CreateAttachmentResp |
Attachment.create(RequestOptions reqOptions)
|
CreateByAttachmentWebsiteDeliveryResp |
WebsiteDelivery.createByAttachment(CreateByAttachmentWebsiteDeliveryReq req,
RequestOptions reqOptions)
|
DeactivateReferralAccountResp |
ReferralAccount.deactivate(DeactivateReferralAccountReq req,
RequestOptions reqOptions)
|
DeleteNoteResp |
Note.delete(DeleteNoteReq req,
RequestOptions reqOptions)
|
GetApplicationResp |
Application.get(GetApplicationReq req,
RequestOptions reqOptions)
|
GetAttachmentResp |
Attachment.get(GetAttachmentReq req,
RequestOptions reqOptions)
|
GetEmployeeResp |
Employee.get(GetEmployeeReq req,
RequestOptions reqOptions)
|
GetJobManagerResp |
JobManager.get(GetJobManagerReq req,
RequestOptions reqOptions)
|
GetJobResp |
Job.get(GetJobReq req,
RequestOptions reqOptions)
|
GetNoteResp |
Note.get(GetNoteReq req,
RequestOptions reqOptions)
|
GetOfferResp |
Offer.get(GetOfferReq req,
RequestOptions reqOptions)
|
GetOfferSchemaResp |
OfferSchema.get(GetOfferSchemaReq req,
RequestOptions reqOptions)
|
GetWebsiteDeliveryTaskResp |
WebsiteDeliveryTask.get(GetWebsiteDeliveryTaskReq req,
RequestOptions reqOptions)
|
GetByApplicationEmployeeResp |
Employee.getByApplication(GetByApplicationEmployeeReq req,
RequestOptions reqOptions)
|
GetByApplicationReferralResp |
Referral.getByApplication(GetByApplicationReferralReq req,
RequestOptions reqOptions)
|
InternOfferStatusOfferResp |
Offer.internOfferStatus(InternOfferStatusOfferReq req,
RequestOptions reqOptions)
|
ListApplicationInterviewResp |
ApplicationInterview.list(ListApplicationInterviewReq req,
RequestOptions reqOptions)
|
ListEvaluationResp |
Evaluation.list(ListEvaluationReq req,
RequestOptions reqOptions)
|
ListInterviewResp |
Interview.list(ListInterviewReq req,
RequestOptions reqOptions)
|
ListJobFunctionResp |
JobFunction.list(ListJobFunctionReq req,
RequestOptions reqOptions)
|
ListJobProcessResp |
JobProcess.list(ListJobProcessReq req,
RequestOptions reqOptions)
|
ListJobResp |
Job.list(ListJobReq req,
RequestOptions reqOptions)
|
ListJobRequirementResp |
JobRequirement.list(ListJobRequirementReq req,
RequestOptions reqOptions)
|
ListJobRequirementSchemaResp |
JobRequirementSchema.list(ListJobRequirementSchemaReq req,
RequestOptions reqOptions)
|
ListJobTypeResp |
JobType.list(ListJobTypeReq req,
RequestOptions reqOptions)
|
ListNoteResp |
Note.list(ListNoteReq req,
RequestOptions reqOptions)
|
ListOfferResp |
Offer.list(ListOfferReq req,
RequestOptions reqOptions)
|
ListQuestionnaireResp |
Questionnaire.list(ListQuestionnaireReq req,
RequestOptions reqOptions)
|
ListReferralWebsiteJobPostResp |
ReferralWebsiteJobPost.list(ListReferralWebsiteJobPostReq req,
RequestOptions reqOptions)
,获取内推官网下的职位列表。
|
ListRegistrationSchemaResp |
RegistrationSchema.list(ListRegistrationSchemaReq req,
RequestOptions reqOptions)
|
ListRoleResp |
Role.list(ListRoleReq req,
RequestOptions reqOptions)
|
ListSubjectResp |
Subject.list(ListSubjectReq req,
RequestOptions reqOptions)
|
ListTalentFolderResp |
TalentFolder.list(ListTalentFolderReq req,
RequestOptions reqOptions)
|
ListTalentResp |
Talent.list(ListTalentReq req,
RequestOptions reqOptions)
|
ListTerminationReasonResp |
TerminationReason.list(ListTerminationReasonReq req,
RequestOptions reqOptions)
|
ListWebsiteChannelResp |
WebsiteChannel.list(ListWebsiteChannelReq req,
RequestOptions reqOptions)
|
ListWebsiteJobPostResp |
WebsiteJobPost.list(ListWebsiteJobPostReq req,
RequestOptions reqOptions)
获取自定义官网下的职位列表,获取自定义官网下的职位列表。
|
ListWebsiteResp |
Website.list(ListWebsiteReq req,
RequestOptions reqOptions)
|
ListByIdJobRequirementResp |
JobRequirement.listById(ListByIdJobRequirementReq req,
RequestOptions reqOptions)
|
OfferStatusOfferResp |
Offer.offerStatus(OfferStatusOfferReq req,
RequestOptions reqOptions)
|
PatchEmployeeResp |
Employee.patch(PatchEmployeeReq req,
RequestOptions reqOptions)
|
PatchNoteResp |
Note.patch(PatchNoteReq req,
RequestOptions reqOptions)
|
PreviewAttachmentResp |
Attachment.preview(PreviewAttachmentReq req,
RequestOptions reqOptions)
|
QueryLocationResp |
Location.query(QueryLocationReq req,
RequestOptions reqOptions)
|
ReconciliationReferralAccountResp |
ReferralAccount.reconciliation(ReconciliationReferralAccountReq req,
RequestOptions reqOptions)
|
TerminateApplicationResp |
Application.terminate(TerminateApplicationReq req,
RequestOptions reqOptions)
|
TransferOnboardApplicationResp |
Application.transferOnboard(TransferOnboardApplicationReq req,
RequestOptions reqOptions)
操作候选人入职,根据投递 ID 操作候选人入职并创建员工。
|
UpdateExternalApplicationResp |
ExternalApplication.update(UpdateExternalApplicationReq req,
RequestOptions reqOptions)
|
UpdateOfferResp |
Offer.update(UpdateOfferReq req,
RequestOptions reqOptions)
更新 Offer 信息,1.
|
UpdateWebsiteChannelResp |
WebsiteChannel.update(UpdateWebsiteChannelReq req,
RequestOptions reqOptions)
|
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)
,
官网API文档链接:
WithdrawReferralAccountResp |
ReferralAccount.withdraw(WithdrawReferralAccountReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.im.v1.resource中的方法
| 限定符和类型 |
方法和说明 |
AddManagersChatManagersResp |
ChatManagers.addManagers(AddManagersChatManagersReq req,
RequestOptions reqOptions)
指定群管理员,将用户或机器人指定为群管理员。
|
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)
添加会话标签页,添加自定义会话标签页。
|
CreateFileResp |
File.create(CreateFileReq req,
RequestOptions reqOptions)
上传文件,上传文件,可以上传视频,音频和常见的文件类型。
|
CreateImageResp |
Image.create(CreateImageReq req,
RequestOptions reqOptions)
上传图片,上传图片接口,支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。
|
CreateMessageReactionResp |
MessageReaction.create(CreateMessageReactionReq req,
RequestOptions reqOptions)
添加消息表情回复,给指定消息添加指定类型的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
|
CreateMessageResp |
Message.create(CreateMessageReq req,
RequestOptions reqOptions)
发送消息,给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
|
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)
解散群,解散群组。
|
DeleteMessageReactionResp |
MessageReaction.delete(DeleteMessageReactionReq req,
RequestOptions reqOptions)
删除消息表情回复,删除指定消息的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
|
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)
|
GetChatMembersResp |
ChatMembers.get(GetChatMembersReq req,
RequestOptions reqOptions)
获取群成员列表,获取用户/机器人所在群的群成员列表。
|
GetChatMenuTreeResp |
ChatMenuTree.get(GetChatMenuTreeReq req,
RequestOptions reqOptions)
获取群内菜单,通过群ID获取群内菜单。
|
GetChatModerationResp |
ChatModeration.get(GetChatModerationReq req,
RequestOptions reqOptions)
|
GetChatResp |
Chat.get(GetChatReq req,
RequestOptions reqOptions)
获取群信息,获取群名称、群描述、群头像、群主 ID 等群基本信息。
|
GetFileResp |
File.get(GetFileReq req,
RequestOptions reqOptions)
下载文件,下载文件接口,只能下载应用自己上传的文件。
|
GetImageResp |
Image.get(GetImageReq req,
RequestOptions reqOptions)
下载图片,下载图片资源,只能下载当前应用所上传且图片类型为message的图片。
|
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/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)查询结果的基础上,增加了批量请求中有效的userid数量以及消息撤回进度数据。
|
IsInChatChatMembersResp |
ChatMembers.isInChat(IsInChatChatMembersReq req,
RequestOptions reqOptions)
判断用户或机器人是否在群里,根据使用的access_token判断对应的用户或者机器人是否在群里。
|
LinkChatResp |
Chat.link(LinkChatReq req,
RequestOptions reqOptions)
获取群分享链接,获取指定群的分享链接。
|
ListChatResp |
Chat.list(ListChatReq req,
RequestOptions reqOptions)
获取用户或机器人所在的群列表,获取用户或者机器人所在群列表。
|
ListMessageReactionResp |
MessageReaction.list(ListMessageReactionReq req,
RequestOptions reqOptions)
获取消息表情回复,获取指定消息的特定类型表情回复列表(reaction即表情回复,本文档统一用“reaction”代称)。
|
ListMessageResp |
Message.list(ListMessageReq req,
RequestOptions reqOptions)
获取会话历史消息,获取会话(包括单聊、群组)的历史消息(聊天记录)。
|
ListPinResp |
Pin.list(ListPinReq req,
RequestOptions reqOptions)
获取群内Pin消息,获取所在群内指定时间范围内的所有Pin消息。
|
ListTabsChatTabResp |
ChatTab.listTabs(ListTabsChatTabReq req,
RequestOptions reqOptions)
拉取会话标签页,拉取会话标签页。
|
MeJoinChatMembersResp |
ChatMembers.meJoin(MeJoinChatMembersReq req,
RequestOptions reqOptions)
用户或机器人主动加入群聊,用户或机器人主动加入群聊。
|
MergeForwardMessageResp |
Message.mergeForward(MergeForwardMessageReq req,
RequestOptions reqOptions)
|
PatchChatMenuItemResp |
ChatMenuItem.patch(PatchChatMenuItemReq req,
RequestOptions reqOptions)
修改群菜单元信息,修改某个一级菜单或者二级菜单的元信息。
|
PatchMessageResp |
Message.patch(PatchMessageReq req,
RequestOptions reqOptions)
更新应用发送的消息,更新应用已发送的消息卡片内容。
|
PushFollowUpMessageResp |
Message.pushFollowUp(PushFollowUpMessageReq req,
RequestOptions reqOptions)
|
ReadUserBatchMessageResp |
BatchMessage.readUser(ReadUserBatchMessageReq req,
RequestOptions reqOptions)
查询批量消息推送和阅读人数,批量发送消息后,可以通过该接口查询批量消息推送的总人数和阅读人数。
|
ReadUsersMessageResp |
Message.readUsers(ReadUsersMessageReq req,
RequestOptions reqOptions)
查询消息已读信息,查询消息的已读信息。
|
ReplyMessageResp |
Message.reply(ReplyMessageReq req,
RequestOptions reqOptions)
回复消息,回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
|
SearchChatResp |
Chat.search(SearchChatReq 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)
发送短信加急,对指定消息进行应用内加急与短信加急。
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |