| 限定符和类型 | 方法和说明 |
|---|---|
RawResponse |
Client.delete(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
RawResponse |
Client.get(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
RawResponse |
Client.options(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
RawResponse |
Client.patch(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
RawResponse |
Client.post(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
RawResponse |
Client.put(String httpPath,
Object body,
AccessTokenType accessTokenType,
RequestOptions requestOptions) |
| 限定符和类型 | 方法和说明 |
|---|---|
static RawResponse |
Transport.send(Config config,
RequestOptions requestOptions,
String methodType,
String path,
Set<AccessTokenType> accessTokenTypeSet,
Object req) |
static void |
Transport.validateTokenType(Set<AccessTokenType> accessTokenTypeSet,
RequestOptions requestOptions) |
| 限定符和类型 | 方法和说明 |
|---|---|
RequestOptions |
RequestOptions.Builder.build() |
| 限定符和类型 | 方法和说明 |
|---|---|
RawRequest |
ReqTranslator.translate(Object req,
AccessTokenType accessTokenType,
Config config,
String httpMethod,
String httpPath,
RequestOptions requestOptions) |
| 限定符和类型 | 方法和说明 |
|---|---|
CreateBadgeGrantResp |
AdminService.BadgeGrant.create(CreateBadgeGrantReq req,
RequestOptions reqOptions)
创建勋章的授予名单，通过该接口可以为特定勋章创建一份授予名单，一枚勋章下最多可创建1000份授予名单。
|
CreateBadgeImageResp |
AdminService.BadgeImage.create(CreateBadgeImageReq req,
RequestOptions reqOptions)
上传勋章图片，通过该接口可以上传勋章详情图、挂饰图的文件，获取对应的文件key
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/adminv1/CreateBadgeImageSample.java
;
|
CreateBadgeResp |
AdminService.Badge.create(CreateBadgeReq req,
RequestOptions reqOptions)
创建勋章，使用该接口可以创建一枚完整的勋章信息，一个租户下最多可创建1000枚勋章。
|
DeleteBadgeGrantResp |
AdminService.BadgeGrant.delete(DeleteBadgeGrantReq req,
RequestOptions reqOptions)
|
GetBadgeGrantResp |
AdminService.BadgeGrant.get(GetBadgeGrantReq req,
RequestOptions reqOptions)
|
GetBadgeResp |
AdminService.Badge.get(GetBadgeReq req,
RequestOptions reqOptions)
|
ListAdminDeptStatResp |
AdminService.AdminDeptStat.list(ListAdminDeptStatReq req,
RequestOptions reqOptions)
获取部门维度的用户活跃和功能使用数据，该接口用于获取部门维度的用户活跃和功能使用数据，即IM（即时通讯）、日历、云文档、音视频会议功能的使用数据。
|
ListAdminUserStatResp |
AdminService.AdminUserStat.list(ListAdminUserStatReq req,
RequestOptions reqOptions)
获取用户维度的用户活跃和功能使用数据，用于获取用户维度的用户活跃和功能使用数据，即IM（即时通讯）、日历、云文档、音视频会议功能的使用数据。
|
ListBadgeGrantResp |
AdminService.BadgeGrant.list(ListBadgeGrantReq req,
RequestOptions reqOptions)
获取勋章的授予名单列表，通过该接口可以获取特定勋章下的授予名单列表，授予名单的排列顺序按照创建时间倒序排列。
|
ListBadgeResp |
AdminService.Badge.list(ListBadgeReq req,
RequestOptions reqOptions)
获取勋章列表，可以通过该接口列出租户下所有的勋章，勋章的排列顺序是按照创建时间倒序排列。
|
ResetPasswordResp |
AdminService.Password.reset(ResetPasswordReq req,
RequestOptions reqOptions)
重置密码，重置用户的企业邮箱密码，仅当用户的邮箱和企业邮箱(别名)一致时生效，可用于处理飞书企业邮箱登录死锁的问题。
|
UpdateBadgeGrantResp |
AdminService.BadgeGrant.update(UpdateBadgeGrantReq req,
RequestOptions reqOptions)
|
UpdateBadgeResp |
AdminService.Badge.update(UpdateBadgeReq req,
RequestOptions reqOptions)
|
| 限定符和类型 | 方法和说明 |
|---|---|
BatchCreateUserDailyShiftResp |
AttendanceService.UserDailyShift.batchCreate(BatchCreateUserDailyShiftReq req,
RequestOptions reqOptions)
创建或修改班表，班表是用来描述考勤组内人员每天按哪个班次进行上班。
|
BatchCreateUserFlowResp |
AttendanceService.UserFlow.batchCreate(BatchCreateUserFlowReq req,
RequestOptions reqOptions)
导入打卡流水记录，导入授权内员工的打卡流水记录。
|
CreateGroupResp |
AttendanceService.Group.create(CreateGroupReq req,
RequestOptions reqOptions)
创建或修改考勤组，考勤组，是对部门或者员工在某个特定场所及特定时间段内的出勤情况（包括上下班、迟到、早退、病假、婚假、丧假、公休、工作时间、加班情况等）的一种规则设定。
|
CreateShiftResp |
AttendanceService.Shift.create(CreateShiftReq req,
RequestOptions reqOptions)
创建班次，班次是描述一次考勤任务时间规则的统称，比如一天打多少次卡，每次卡的上下班时间，晚到多长时间算迟到，晚到多长时间算缺卡等。
|
CreateUserApprovalResp |
AttendanceService.UserApproval.create(CreateUserApprovalReq req,
RequestOptions reqOptions)
写入审批结果，由于部分企业使用的是自己的审批系统，而不是飞书审批系统，因此员工的请假、加班等数据无法流入到飞书考勤系统中，导致员工在请假时间段内依然收到打卡提醒，并且被记为缺卡。
|
CreateUserTaskRemedyResp |
AttendanceService.UserTaskRemedy.create(CreateUserTaskRemedyReq req,
RequestOptions reqOptions)
通知补卡审批发起，对于只使用飞书考勤系统而未使用飞书审批系统的企业，可以通过该接口，将在三方审批系统中发起的补卡审批数据，写入到飞书考勤系统中，状态为审批中。
|
DeleteGroupResp |
AttendanceService.Group.delete(DeleteGroupReq req,
RequestOptions reqOptions)
删除考勤组，通过班次 ID 删除班次。
|
DeleteShiftResp |
AttendanceService.Shift.delete(DeleteShiftReq req,
RequestOptions reqOptions)
删除班次，通过班次 ID 删除班次。
|
DownloadFileResp |
AttendanceService.File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件，通过文件 ID 下载指定的文件。
|
GetGroupResp |
AttendanceService.Group.get(GetGroupReq req,
RequestOptions reqOptions)
获取考勤组详情，通过考勤组 ID 获取考勤组详情。
|
GetShiftResp |
AttendanceService.Shift.get(GetShiftReq req,
RequestOptions reqOptions)
获取班次详情，通过班次 ID 获取班次详情。
|
GetUserFlowResp |
AttendanceService.UserFlow.get(GetUserFlowReq req,
RequestOptions reqOptions)
获取打卡流水记录，通过打卡记录 ID 获取用户的打卡流水记录。
|
ListGroupResp |
AttendanceService.Group.list(ListGroupReq req,
RequestOptions reqOptions)
获取考勤组列表，翻页获取所有考勤组列表。
|
ListShiftResp |
AttendanceService.Shift.list(ListShiftReq req,
RequestOptions reqOptions)
获取班次列表，翻页获取所有班次列表。
|
ModifyUserSettingResp |
AttendanceService.UserSetting.modify(ModifyUserSettingReq req,
RequestOptions reqOptions)
修改用户设置，修改授权内员工的用户设置信息，包括人脸照片文件 ID。
|
ProcessApprovalInfoResp |
AttendanceService.ApprovalInfo.process(ProcessApprovalInfoReq req,
RequestOptions reqOptions)
通知审批状态更新，对于只使用飞书考勤系统而未使用飞书审批系统的企业，可以通过该接口更新写入飞书考勤系统中的三方系统审批状态，例如请假、加班、外出、出差、补卡等审批，状态包括通过、不通过、撤销等。
|
QueryShiftResp |
AttendanceService.Shift.query(QueryShiftReq req,
RequestOptions reqOptions)
按名称查询班次，通过班次的名称查询班次信息。
|
QueryUserApprovalResp |
AttendanceService.UserApproval.query(QueryUserApprovalReq req,
RequestOptions reqOptions)
获取审批通过数据，获取员工在某段时间内的请假、加班、外出和出差四种审批的通过数据。
|
QueryUserDailyShiftResp |
AttendanceService.UserDailyShift.query(QueryUserDailyShiftReq req,
RequestOptions reqOptions)
查询班表信息，支持查询多个用户的排班情况，查询的时间跨度不能超过 30 天。
|
QueryUserFlowResp |
AttendanceService.UserFlow.query(QueryUserFlowReq req,
RequestOptions reqOptions)
批量查询打卡流水记录，批量查询授权内员工的实际打卡流水记录。
|
QueryUserSettingResp |
AttendanceService.UserSetting.query(QueryUserSettingReq req,
RequestOptions reqOptions)
批量查询用户设置，批量查询授权内员工的用户设置信息，包括人脸照片文件 ID、人脸照片更新时间。
|
QueryUserStatsDataResp |
AttendanceService.UserStatsData.query(QueryUserStatsDataReq req,
RequestOptions reqOptions)
查询统计数据，查询日度统计或月度统计的统计数据。
|
QueryUserStatsFieldResp |
AttendanceService.UserStatsField.query(QueryUserStatsFieldReq req,
RequestOptions reqOptions)
查询统计表头，查询考勤统计支持的日度统计或月度统计的统计表头。
|
QueryUserStatsViewResp |
AttendanceService.UserStatsView.query(QueryUserStatsViewReq req,
RequestOptions reqOptions)
查询统计设置，查询开发者定制的日度统计或月度统计的统计报表表头设置信息。
|
QueryUserTaskRemedyResp |
AttendanceService.UserTaskRemedy.query(QueryUserTaskRemedyReq req,
RequestOptions reqOptions)
获取补卡记录，获取授权内员工的补卡记录。
|
QueryUserTaskResp |
AttendanceService.UserTask.query(QueryUserTaskReq req,
RequestOptions reqOptions)
获取打卡结果，获取企业内员工的实际打卡结果，包括上班打卡结果和下班打卡结果。
|
QueryUserAllowedRemedysUserTaskRemedyResp |
AttendanceService.UserTaskRemedy.queryUserAllowedRemedys(QueryUserAllowedRemedysUserTaskRemedyReq req,
RequestOptions reqOptions)
获取用户可补卡时间，获取用户某天可以补的第几次上 / 下班卡的时间。
|
SearchGroupResp |
AttendanceService.Group.search(SearchGroupReq req,
RequestOptions reqOptions)
按名称查询考勤组，按考勤组名称查询考勤组摘要信息。
|
UpdateUserStatsViewResp |
AttendanceService.UserStatsView.update(UpdateUserStatsViewReq req,
RequestOptions reqOptions)
更新统计设置，更新开发者定制的日度统计或月度统计的统计报表表头设置信息。
|
UploadFileResp |
AttendanceService.File.upload(UploadFileReq req,
RequestOptions reqOptions)
上传文件，上传文件并获取文件 ID，可用于“修改用户设置”接口中的 face_key 参数。
|
| 限定符和类型 | 方法和说明 |
|---|---|
CreateDraftResp |
BaikeService.Draft.create(CreateDraftReq req,
RequestOptions reqOptions)
创建草稿，草稿并非百科词条，而是指通过 API 发起创建新词条或更新现有词条的申请。
|
CreateEntityResp |
BaikeService.Entity.create(CreateEntityReq req,
RequestOptions reqOptions)
创建免审词条，通过此接口创建的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。
|
DownloadFileResp |
BaikeService.File.download(DownloadFileReq req,
RequestOptions reqOptions)
|
GetEntityResp |
BaikeService.Entity.get(GetEntityReq req,
RequestOptions reqOptions)
获取词条详情，通过词条 id 拉取对应的词条详情信息。
|
HighlightEntityResp |
BaikeService.Entity.highlight(HighlightEntityReq req,
RequestOptions reqOptions)
词条高亮，传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现百科词条智能高亮。
|
ListClassificationResp |
BaikeService.Classification.list(ListClassificationReq req,
RequestOptions reqOptions)
获取百科分类，获取企业百科当前分类。
|
ListEntityResp |
BaikeService.Entity.list(ListEntityReq req,
RequestOptions reqOptions)
获取词条列表，分页拉取词条列表数据，支持拉取租户内的全部词条。
|
MatchEntityResp |
BaikeService.Entity.match(MatchEntityReq req,
RequestOptions reqOptions)
精准搜索词条，将关键词与词条名、别名精准匹配，并返回对应的 词条 ID。
|
SearchEntityResp |
BaikeService.Entity.search(SearchEntityReq req,
RequestOptions reqOptions)
模糊搜索词条，传入关键词，与词条名、别名、释义等信息进行模糊匹配，返回搜到的词条信息。
|
UpdateDraftResp |
BaikeService.Draft.update(UpdateDraftReq req,
RequestOptions reqOptions)
更新草稿，根据 draft_id 更新草稿内容，已审批的草稿无法编辑
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/baikev1/UpdateDraftSample.java
;
|
UpdateEntityResp |
BaikeService.Entity.update(UpdateEntityReq req,
RequestOptions reqOptions)
更新免审词条，通过此接口更新已有的词条，不需要百科管理员审核可直接写入词库，请慎重使用【租户管理员请慎重审批】。
|
UploadFileResp |
BaikeService.File.upload(UploadFileReq req,
RequestOptions reqOptions)
图片上传，百科词条图片资源上传。
|
| 限定符和类型 | 方法和说明 |
|---|---|
CreateEntityResp |
BlockService.Entity.create(CreateEntityReq req,
RequestOptions reqOptions)
创建 BlockEntity，开发者可以通过该接口将部分或全部数据存放于 BlockEntity。
|
CreateMessageResp |
BlockService.Message.create(CreateMessageReq req,
RequestOptions reqOptions)
Block协同数据推送，根据BlockID向指定用户列表推送协同数据。
|
UpdateEntityResp |
BlockService.Entity.update(UpdateEntityReq req,
RequestOptions reqOptions)
更新BlockEntity，开发者通过该接口可以更新存储在BlockEntity中的数据，并实时推送到端侧。
|
| 限定符和类型 | 方法和说明 |
|---|---|
BatchDeleteCalendarEventAttendeeResp |
CalendarService.CalendarEventAttendee.batchDelete(BatchDeleteCalendarEventAttendeeReq req,
RequestOptions reqOptions)
删除日程参与人，批量删除日程的参与人。
|
CreateCalendarAclResp |
CalendarService.CalendarAcl.create(CreateCalendarAclReq req,
RequestOptions reqOptions)
创建访问控制，该接口用于以当前身份（应用 / 用户）给日历添加访问控制权限，即日历成员。
|
CreateCalendarEventAttendeeResp |
CalendarService.CalendarEventAttendee.create(CreateCalendarEventAttendeeReq req,
RequestOptions reqOptions)
创建日程参与人;，批量给日程添加参与人。
|
CreateCalendarEventResp |
CalendarService.CalendarEvent.create(CreateCalendarEventReq req,
RequestOptions reqOptions)
创建日程，该接口用于以当前身份（应用 / 用户）在日历上创建一个日程。
|
CreateCalendarResp |
CalendarService.Calendar.create(CreateCalendarReq req,
RequestOptions reqOptions)
创建日历，该接口用于为当前身份（应用 / 用户）创建一个共享日历。
|
CreateExchangeBindingResp |
CalendarService.ExchangeBinding.create(CreateExchangeBindingReq req,
RequestOptions reqOptions)
创建Exchange绑定关系，本接口将Exchange账户绑定到飞书账户，进而支持Exchange日历的导入
操作用户需要是企业超级管理员 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/create
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/CreateExchangeBindingSample.java
;
|
CreateTimeoffEventResp |
CalendarService.TimeoffEvent.create(CreateTimeoffEventReq req,
RequestOptions reqOptions)
创建请假日程，为指定用户创建一个请假日程，可以是一个普通请假日程，也可以是一个全天日程。
|
DeleteCalendarAclResp |
CalendarService.CalendarAcl.delete(DeleteCalendarAclReq req,
RequestOptions reqOptions)
删除访问控制，该接口用于以当前身份（应用 / 用户）删除日历的控制权限，即日历成员。
|
DeleteCalendarEventResp |
CalendarService.CalendarEvent.delete(DeleteCalendarEventReq req,
RequestOptions reqOptions)
删除日程，该接口用于以当前身份（应用 / 用户）删除日历上的一个日程。
|
DeleteCalendarResp |
CalendarService.Calendar.delete(DeleteCalendarReq req,
RequestOptions reqOptions)
删除日历，该接口用于以当前身份（应用 / 用户）删除一个共享日历。
|
DeleteExchangeBindingResp |
CalendarService.ExchangeBinding.delete(DeleteExchangeBindingReq req,
RequestOptions reqOptions)
解除Exchange绑定关系，本接口解除Exchange账户和飞书账户的绑定关系，Exchange账户解除绑定后才能绑定其他飞书账户
操作用户需要是企业超级管理员 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/exchange_binding/delete
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/calendarv4/DeleteExchangeBindingSample.java
;
|
DeleteTimeoffEventResp |
CalendarService.TimeoffEvent.delete(DeleteTimeoffEventReq req,
RequestOptions reqOptions)
删除请假日程，删除一个指定的请假日程，请假日程删除，用户个人签名页的请假信息也会消失。
|
GenerateCaldavConfSettingResp |
CalendarService.Setting.generateCaldavConf(GenerateCaldavConfSettingReq req,
RequestOptions reqOptions)
生成CalDAV配置，用于为当前用户生成一个CalDAV账号密码，用于将飞书日历信息同步到本地设备日历。
|
GetCalendarEventResp |
CalendarService.CalendarEvent.get(GetCalendarEventReq req,
RequestOptions reqOptions)
获取日程，该接口用于以当前身份（应用 / 用户）获取日历上的一个日程。
|
GetCalendarResp |
CalendarService.Calendar.get(GetCalendarReq req,
RequestOptions reqOptions)
获取日历，该接口用于以当前身份（应用 / 用户）根据日历 ID 获取日历信息。
|
GetExchangeBindingResp |
CalendarService.ExchangeBinding.get(GetExchangeBindingReq req,
RequestOptions reqOptions)
获取绑定状态，本接口获取Exchange账户的绑定状态，包括exchange日历是否同步完成。
|
ListCalendarAclResp |
CalendarService.CalendarAcl.list(ListCalendarAclReq req,
RequestOptions reqOptions)
获取访问控制列表，该接口用于以当前身份（应用 / 用户）获取日历的控制权限列表。
|
ListCalendarEventAttendeeChatMemberResp |
CalendarService.CalendarEventAttendeeChatMember.list(ListCalendarEventAttendeeChatMemberReq req,
RequestOptions reqOptions)
获取日程参与群成员列表，获取日程的群参与人的群成员列表。
|
ListCalendarEventAttendeeResp |
CalendarService.CalendarEventAttendee.list(ListCalendarEventAttendeeReq req,
RequestOptions reqOptions)
获取日程参与人列表，获取日程的参与人列表，若参与者列表中有群组，请使用 [获取参与人群成员列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar-event-attendee-chat_member/list)
。
|
ListCalendarEventResp |
CalendarService.CalendarEvent.list(ListCalendarEventReq req,
RequestOptions reqOptions)
获取日程列表，该接口用于以当前身份（应用 / 用户）获取日历下的日程列表。
|
ListCalendarResp |
CalendarService.Calendar.list(ListCalendarReq req,
RequestOptions reqOptions)
获取日历列表，该接口用于分页获得当前身份（应用 / 用户）的日历列表。
|
ListFreebusyResp |
CalendarService.Freebusy.list(ListFreebusyReq req,
RequestOptions reqOptions)
查询忙闲，查询用户主日历或会议室的忙闲信息。
|
PatchCalendarEventResp |
CalendarService.CalendarEvent.patch(PatchCalendarEventReq req,
RequestOptions reqOptions)
更新日程，该接口用于以当前身份（应用 / 用户）更新日历上的一个日程。
|
PatchCalendarResp |
CalendarService.Calendar.patch(PatchCalendarReq req,
RequestOptions reqOptions)
更新日历，该接口用于以当前身份（应用 / 用户）修改日历信息。
|
PrimaryCalendarResp |
CalendarService.Calendar.primary(PrimaryCalendarReq req,
RequestOptions reqOptions)
获取主日历，获取当前身份的主日历信息。
|
SearchCalendarEventResp |
CalendarService.CalendarEvent.search(SearchCalendarEventReq req,
RequestOptions reqOptions)
搜索日程，该接口用于以用户身份搜索某日历下的相关日程。
|
SearchCalendarResp |
CalendarService.Calendar.search(SearchCalendarReq req,
RequestOptions reqOptions)
搜索日历，该接口用于通过关键字查询公共日历或用户主日历。
|
SubscribeCalendarResp |
CalendarService.Calendar.subscribe(SubscribeCalendarReq req,
RequestOptions reqOptions)
订阅日历，该接口用于以当前身份（应用 / 用户）订阅某个日历。
|
SubscriptionCalendarResp |
CalendarService.Calendar.subscription(RequestOptions reqOptions)
订阅日历变更事件，该接口用于以用户身份订阅当前身份下日历列表中的所有日历变更。
|
SubscriptionCalendarAclResp |
CalendarService.CalendarAcl.subscription(SubscriptionCalendarAclReq req,
RequestOptions reqOptions)
订阅日历访问控制变更事件;，该接口用于以用户身份订阅指定日历下的日历成员变更事件。
|
SubscriptionCalendarEventResp |
CalendarService.CalendarEvent.subscription(SubscriptionCalendarEventReq req,
RequestOptions reqOptions)
订阅日程变更事件，该接口用于以用户身份订阅指定日历下的日程变更事件。
|
UnsubscribeCalendarResp |
CalendarService.Calendar.unsubscribe(UnsubscribeCalendarReq req,
RequestOptions reqOptions)
取消订阅日历，该接口用于以当前身份（应用 / 用户）取消对某日历的订阅状态。
|
UnsubscriptionCalendarResp |
CalendarService.Calendar.unsubscription(RequestOptions reqOptions)
取消订阅日历变更事件，该接口用于以用户身份取消订阅当前身份下日历列表中的日历变更事件。
|
UnsubscriptionCalendarAclResp |
CalendarService.CalendarAcl.unsubscription(UnsubscriptionCalendarAclReq req,
RequestOptions reqOptions)
取消订阅日历访问控制变更事件，该接口用于以用户身份取消订阅指定日历下的日历成员变更事件。
|
UnsubscriptionCalendarEventResp |
CalendarService.CalendarEvent.unsubscription(UnsubscriptionCalendarEventReq req,
RequestOptions reqOptions)
取消订阅日程变更事件，该接口用于以用户身份取消订阅指定日历下的日程变更事件。
|
| 限定符和类型 | 方法和说明 |
|---|---|
AddGroupMemberResp |
ContactService.GroupMember.add(AddGroupMemberReq req,
RequestOptions reqOptions)
添加用户组成员，向用户组中添加成员(目前成员仅支持用户，未来会支持部门)，如果应用的通讯录权限范围是“全部员工”，则可将任何成员添加到任何用户组。
|
BatchAddGroupMemberResp |
ContactService.GroupMember.batchAdd(BatchAddGroupMemberReq req,
RequestOptions reqOptions)
批量添加用户组成员，向普通用户组中批量添加成员(目前仅支持添加用户，暂不支持添加部门），如果应用的通讯录权限范围是“全部员工”，则可将任何成员添加到任何用户组。
|
BatchGetIdUserResp |
ContactService.User.batchGetId(BatchGetIdUserReq req,
RequestOptions reqOptions)
通过手机号或邮箱获取用户 ID，通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
|
BatchRemoveGroupMemberResp |
ContactService.GroupMember.batchRemove(BatchRemoveGroupMemberReq req,
RequestOptions reqOptions)
批量移除用户组成员，从普通用户组中批量移除成员 (目前仅支持移除用户，暂不支持移除部门）。
|
BindDepartmentUnitResp |
ContactService.Unit.bindDepartment(BindDepartmentUnitReq req,
RequestOptions reqOptions)
建立部门与单位的绑定关系，通过该接口建立部门与单位的绑定关系，需更新单位的权限，需对应部门的通讯录权限。
|
ChildrenDepartmentResp |
ContactService.Department.children(ChildrenDepartmentReq req,
RequestOptions reqOptions)
获取子部门列表，通过部门ID获取部门的子部门列表。
|
CreateDepartmentResp |
ContactService.Department.create(CreateDepartmentReq req,
RequestOptions reqOptions)
创建部门，该接口用于向通讯录中创建部门。
|
CreateEmployeeTypeEnumResp |
ContactService.EmployeeTypeEnum.create(CreateEmployeeTypeEnumReq req,
RequestOptions reqOptions)
|
CreateGroupResp |
ContactService.Group.create(CreateGroupReq req,
RequestOptions reqOptions)
创建用户组，使用该接口创建用户组，请注意创建用户组时应用的通讯录权限范围需为“全部员工”，否则会创建失败，[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
CreateUnitResp |
ContactService.Unit.create(CreateUnitReq req,
RequestOptions reqOptions)
创建单位，使用该接口创建单位，需要有更新单位的权限。
|
CreateUserResp |
ContactService.User.create(CreateUserReq req,
RequestOptions reqOptions)
创建用户，使用该接口向通讯录创建一个用户，可以理解为员工入职。
|
DeleteDepartmentResp |
ContactService.Department.delete(DeleteDepartmentReq req,
RequestOptions reqOptions)
删除部门，该接口用于向通讯录中删除部门。
|
DeleteEmployeeTypeEnumResp |
ContactService.EmployeeTypeEnum.delete(DeleteEmployeeTypeEnumReq req,
RequestOptions reqOptions)
|
DeleteGroupResp |
ContactService.Group.delete(DeleteGroupReq req,
RequestOptions reqOptions)
删除用户组，通过该接口可删除企业中的用户组，请注意删除用户组时应用的通讯录权限范围需为“全部员工”，否则会删除失败，[点击了解通讯录权限范围](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
|
DeleteUnitResp |
ContactService.Unit.delete(DeleteUnitReq req,
RequestOptions reqOptions)
删除单位，使用该接口删除单位，需要有更新单位的权限。
|
DeleteUserResp |
ContactService.User.delete(DeleteUserReq req,
RequestOptions reqOptions)
删除用户，该接口向通讯录删除一个用户信息，可以理解为员工离职。
|
FindByDepartmentUserResp |
ContactService.User.findByDepartment(FindByDepartmentUserReq req,
RequestOptions reqOptions)
获取部门直属用户列表，基于部门ID获取部门直属用户列表。
|
GetDepartmentResp |
ContactService.Department.get(GetDepartmentReq req,
RequestOptions reqOptions)
获取单个部门信息，该接口用于向通讯录获取单个部门信息。
|
GetGroupResp |
ContactService.Group.get(GetGroupReq req,
RequestOptions reqOptions)
查询用户组，根据用户组 ID 查询某个用户组的基本信息，支持查询普通用户组和动态用户组。
|
GetUnitResp |
ContactService.Unit.get(GetUnitReq req,
RequestOptions reqOptions)
获取单位信息，调用该接口获取单位信息，需有获取单位的权限
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/GetUnitSample.java
;
|
GetUserResp |
ContactService.User.get(GetUserReq req,
RequestOptions reqOptions)
获取单个用户信息，该接口用于获取通讯录中单个用户的信息。
|
ListCustomAttrResp |
ContactService.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 |
ContactService.Department.list(ListDepartmentReq req,
RequestOptions reqOptions)
获取部门信息列表，该接口用于获取当前部门子部门列表。
|
ListEmployeeTypeEnumResp |
ContactService.EmployeeTypeEnum.list(ListEmployeeTypeEnumReq req,
RequestOptions reqOptions)
|
ListScopeResp |
ContactService.Scope.list(ListScopeReq req,
RequestOptions reqOptions)
获取通讯录授权范围，该接口用于获取应用被授权可访问的通讯录范围，包括可访问的部门列表、用户列表和用户组列表。
|
ListUnitResp |
ContactService.Unit.list(ListUnitReq req,
RequestOptions reqOptions)
批量获取单位列表，通过该接口获取企业的单位列表，需获取单位的权限
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListUnitSample.java
;
|
ListUserResp |
ContactService.User.list(ListUserReq req,
RequestOptions reqOptions)
获取用户列表，基于部门ID获取部门下直属用户列表。
|
ListDepartmentUnitResp |
ContactService.Unit.listDepartment(ListDepartmentUnitReq req,
RequestOptions reqOptions)
获取单位绑定的部门列表，通过该接口获取单位绑定的部门列表，需具有获取单位的权限
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListDepartmentUnitSample.java
;
|
MemberBelongGroupResp |
ContactService.Group.memberBelong(MemberBelongGroupReq req,
RequestOptions reqOptions)
查询用户所属用户组，通过该接口可查询该用户所属的用户组列表，可分别查询普通用户组和动态用户组。
|
ParentDepartmentResp |
ContactService.Department.parent(ParentDepartmentReq req,
RequestOptions reqOptions)
获取父部门信息，该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。
|
PatchDepartmentResp |
ContactService.Department.patch(PatchDepartmentReq req,
RequestOptions reqOptions)
修改部门部分信息，该接口用于更新通讯录中部门的信息中的任一个字段。
|
PatchGroupResp |
ContactService.Group.patch(PatchGroupReq req,
RequestOptions reqOptions)
更新用户组，使用该接口更新用户组信息，请注意更新用户组时应用的通讯录权限范围需为“全部员工”，否则会更新失败。
|
PatchUnitResp |
ContactService.Unit.patch(PatchUnitReq req,
RequestOptions reqOptions)
修改单位信息，调用该接口，需要有更新单位的权限。
|
PatchUserResp |
ContactService.User.patch(PatchUserReq req,
RequestOptions reqOptions)
修改用户部分信息，该接口用于更新通讯录中用户的字段，未传递的参数不会更新。
|
RemoveGroupMemberResp |
ContactService.GroupMember.remove(RemoveGroupMemberReq req,
RequestOptions reqOptions)
移除用户组成员，从用户组中移除成员 (目前成员仅支持用户，未来会支持部门)，如果应用的通讯录权限范围是“全部员工”，则可将任何成员移出任何用户组。
|
SearchDepartmentResp |
ContactService.Department.search(SearchDepartmentReq req,
RequestOptions reqOptions)
搜索部门，搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。
|
SimplelistGroupMemberResp |
ContactService.GroupMember.simplelist(SimplelistGroupMemberReq req,
RequestOptions reqOptions)
查询用户组成员列表，通过该接口可查询某个用户组的成员列表（支持查询成员中的用户和部门）, 本接口支持普通用户组和动态用户组。
|
SimplelistGroupResp |
ContactService.Group.simplelist(SimplelistGroupReq req,
RequestOptions reqOptions)
查询用户组列表，通过该接口可查询企业的用户组列表，可分别查询普通用户组或动态用户组。
|
UnbindDepartmentUnitResp |
ContactService.Unit.unbindDepartment(UnbindDepartmentUnitReq req,
RequestOptions reqOptions)
解除部门与单位的绑定关系，通过该接口解除部门与单位的绑定关系，需更新单位的权限，需对应部门的通讯录权限。
|
UnbindDepartmentChatDepartmentResp |
ContactService.Department.unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req,
RequestOptions reqOptions)
部门群转为普通群，通过该接口将部门群转为普通群。
|
UpdateDepartmentResp |
ContactService.Department.update(UpdateDepartmentReq req,
RequestOptions reqOptions)
更新部门所有信息，该接口用于更新当前部门所有信息。
|
UpdateEmployeeTypeEnumResp |
ContactService.EmployeeTypeEnum.update(UpdateEmployeeTypeEnumReq req,
RequestOptions reqOptions)
|
UpdateUserResp |
ContactService.User.update(UpdateUserReq req,
RequestOptions reqOptions)
更新用户所有信息，该接口用于更新通讯录中用户的字段。
|
| 限定符和类型 | 方法和说明 |
|---|---|
BatchDeleteDocumentBlockChildrenResp |
DocxService.DocumentBlockChildren.batchDelete(BatchDeleteDocumentBlockChildrenReq req,
RequestOptions reqOptions)
删除块，指定需要操作的块，删除其指定范围的子块。
|
BatchUpdateDocumentBlockResp |
DocxService.DocumentBlock.batchUpdate(BatchUpdateDocumentBlockReq req,
RequestOptions reqOptions)
批量更新块，批量更新块的富文本内容。
|
CreateDocumentBlockChildrenResp |
DocxService.DocumentBlockChildren.create(CreateDocumentBlockChildrenReq req,
RequestOptions reqOptions)
创建块，指定需要操作的块，为其创建一批子块，并插入到指定位置。
|
CreateDocumentResp |
DocxService.Document.create(CreateDocumentReq req,
RequestOptions reqOptions)
创建文档，创建新版文档，文档标题和目录可选。
|
GetDocumentBlockChildrenResp |
DocxService.DocumentBlockChildren.get(GetDocumentBlockChildrenReq req,
RequestOptions reqOptions)
获取所有子块，给定一个指定版本的文档，并指定需要操作的块，分页遍历其所有子块富文本内容 。
|
GetDocumentBlockResp |
DocxService.DocumentBlock.get(GetDocumentBlockReq req,
RequestOptions reqOptions)
获取块，获取指定块的富文本内容。
|
GetDocumentResp |
DocxService.Document.get(GetDocumentReq req,
RequestOptions reqOptions)
获取文档基本信息，获取文档最新版本号、标题等
在调用此接口前，请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnWKAE4aSaIU4GcdLInSaVde)，了解相关规则及约束。
|
ListDocumentBlockResp |
DocxService.DocumentBlock.list(ListDocumentBlockReq req,
RequestOptions reqOptions)
获取文档所有块，获取文档所有块的富文本内容并分页返回。
|
PatchDocumentBlockResp |
DocxService.DocumentBlock.patch(PatchDocumentBlockReq req,
RequestOptions reqOptions)
更新块，更新指定的块。
|
RawContentDocumentResp |
DocxService.Document.rawContent(RawContentDocumentReq req,
RequestOptions reqOptions)
获取文档纯文本内容，获取文档的纯文本内容。
|
| 限定符和类型 | 方法和说明 |
|---|---|
GetAttachmentResp |
EhrService.Attachment.get(GetAttachmentReq req,
RequestOptions reqOptions)
下载附件，根据文件 token 下载文件。
|
ListEmployeeResp |
EhrService.Employee.list(ListEmployeeReq req,
RequestOptions reqOptions)
批量获取员工花名册信息，根据员工飞书用户 ID / 员工状态 / 雇员类型等搜索条件 ，批量获取员工花名册字段信息。
|
| 限定符和类型 | 方法和说明 |
|---|---|
ListOutboundIpResp |
EventService.OutboundIp.list(ListOutboundIpReq req,
RequestOptions reqOptions)
获取事件出口 IP，飞书开放平台向应用配置的回调地址推送事件时，是通过特定的 IP 发送出去的，应用可以通过本接口获取所有相关的 IP 地址。
|
| 限定符和类型 | 方法和说明 |
|---|---|
CreateFileResp |
ExtService.createFile(CreateFileReq req,
RequestOptions requestOptions) |
AuthenAccessTokenResp |
ExtService.getAuthenAccessToken(AuthenAccessTokenReq req,
RequestOptions requestOptions) |
GetAuthenUserInfoResp |
ExtService.getAuthenUserInfo(RequestOptions requestOptions) |
RefreshAuthenAccessTokenResp |
ExtService.refreshAuthenAccessToken(RefreshAuthenAccessTokenReq req,
RequestOptions requestOptions) |
| 限定符和类型 | 方法和说明 |
|---|---|
DetectFaceAttributesImageResp |
FaceDetectionService.Image.detectFaceAttributes(DetectFaceAttributesImageReq req,
RequestOptions reqOptions)
人脸检测和属性分析，检测图片中的人脸属性和质量等信息
注意：返回值为 -1 表示该功能还暂未实现 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/face_detection-v1/image/detect_face_attributes
;
使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/face_detectionv1/DetectFaceAttributesImageSample.java
;
|