UploadFileResp |
BaikeService.File.upload(UploadFileReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.bitable.v1中的方法
| 限定符和类型 |
方法和说明 |
BatchCreateAppRoleMemberResp |
BitableService.AppRoleMember.batchCreate(BatchCreateAppRoleMemberReq req,
RequestOptions reqOptions)
|
BatchCreateAppTableRecordResp |
BitableService.AppTableRecord.batchCreate(BatchCreateAppTableRecordReq req,
RequestOptions reqOptions)
新增多条记录,该接口用于在数据表中新增多条记录,单次调用最多新增 500 条记录。
|
BatchCreateAppTableResp |
BitableService.AppTable.batchCreate(BatchCreateAppTableReq req,
RequestOptions reqOptions)
|
BatchDeleteAppRoleMemberResp |
BitableService.AppRoleMember.batchDelete(BatchDeleteAppRoleMemberReq req,
RequestOptions reqOptions)
|
BatchDeleteAppTableRecordResp |
BitableService.AppTableRecord.batchDelete(BatchDeleteAppTableRecordReq req,
RequestOptions reqOptions)
删除多条记录,该接口用于删除数据表中现有的多条记录,单次调用中最多删除 500 条记录。
|
BatchDeleteAppTableResp |
BitableService.AppTable.batchDelete(BatchDeleteAppTableReq req,
RequestOptions reqOptions)
|
BatchUpdateAppTableRecordResp |
BitableService.AppTableRecord.batchUpdate(BatchUpdateAppTableRecordReq req,
RequestOptions reqOptions)
更新多条记录,该接口用于更新数据表中的多条记录,单次调用最多更新 500 条记录。
|
CreateAppRoleMemberResp |
BitableService.AppRoleMember.create(CreateAppRoleMemberReq req,
RequestOptions reqOptions)
|
CreateAppRoleResp |
BitableService.AppRole.create(CreateAppRoleReq req,
RequestOptions reqOptions)
|
CreateAppTableFieldResp |
BitableService.AppTableField.create(CreateAppTableFieldReq req,
RequestOptions reqOptions)
|
CreateAppTableRecordResp |
BitableService.AppTableRecord.create(CreateAppTableRecordReq req,
RequestOptions reqOptions)
|
CreateAppTableResp |
BitableService.AppTable.create(CreateAppTableReq req,
RequestOptions reqOptions)
|
CreateAppTableViewResp |
BitableService.AppTableView.create(CreateAppTableViewReq req,
RequestOptions reqOptions)
|
DeleteAppRoleMemberResp |
BitableService.AppRoleMember.delete(DeleteAppRoleMemberReq req,
RequestOptions reqOptions)
|
DeleteAppRoleResp |
BitableService.AppRole.delete(DeleteAppRoleReq req,
RequestOptions reqOptions)
|
DeleteAppTableFieldResp |
BitableService.AppTableField.delete(DeleteAppTableFieldReq req,
RequestOptions reqOptions)
|
DeleteAppTableRecordResp |
BitableService.AppTableRecord.delete(DeleteAppTableRecordReq req,
RequestOptions reqOptions)
|
DeleteAppTableResp |
BitableService.AppTable.delete(DeleteAppTableReq req,
RequestOptions reqOptions)
|
DeleteAppTableViewResp |
BitableService.AppTableView.delete(DeleteAppTableViewReq req,
RequestOptions reqOptions)
|
GetAppResp |
BitableService.App.get(GetAppReq req,
RequestOptions reqOptions)
|
GetAppTableFormResp |
BitableService.AppTableForm.get(GetAppTableFormReq req,
RequestOptions reqOptions)
|
GetAppTableRecordResp |
BitableService.AppTableRecord.get(GetAppTableRecordReq req,
RequestOptions reqOptions)
|
ListAppDashboardResp |
BitableService.AppDashboard.list(ListAppDashboardReq req,
RequestOptions reqOptions)
|
ListAppRoleMemberResp |
BitableService.AppRoleMember.list(ListAppRoleMemberReq req,
RequestOptions reqOptions)
|
ListAppRoleResp |
BitableService.AppRole.list(ListAppRoleReq req,
RequestOptions reqOptions)
|
ListAppTableFieldResp |
BitableService.AppTableField.list(ListAppTableFieldReq req,
RequestOptions reqOptions)
|
ListAppTableFormFieldResp |
BitableService.AppTableFormField.list(ListAppTableFormFieldReq req,
RequestOptions reqOptions)
|
ListAppTableRecordResp |
BitableService.AppTableRecord.list(ListAppTableRecordReq req,
RequestOptions reqOptions)
列出记录,该接口用于列出数据表中的现有记录,单次最多列出 500 行记录,支持分页获取。
|
ListAppTableResp |
BitableService.AppTable.list(ListAppTableReq req,
RequestOptions reqOptions)
|
ListAppTableViewResp |
BitableService.AppTableView.list(ListAppTableViewReq req,
RequestOptions reqOptions)
|
PatchAppTableFormFieldResp |
BitableService.AppTableFormField.patch(PatchAppTableFormFieldReq req,
RequestOptions reqOptions)
|
PatchAppTableFormResp |
BitableService.AppTableForm.patch(PatchAppTableFormReq req,
RequestOptions reqOptions)
|
UpdateAppResp |
BitableService.App.update(UpdateAppReq req,
RequestOptions reqOptions)
更新多维表格元数据,通过 app_token 更新多维表格元数据
- 飞书文档、飞书表格、知识库中的多维表格不支持开启高级权限;- 此接口非原子操作,先修改多维表格名字,后开关高级权限。
|
UpdateAppRoleResp |
BitableService.AppRole.update(UpdateAppRoleReq req,
RequestOptions reqOptions)
|
UpdateAppTableFieldResp |
BitableService.AppTableField.update(UpdateAppTableFieldReq req,
RequestOptions reqOptions)
|
UpdateAppTableRecordResp |
BitableService.AppTableRecord.update(UpdateAppTableRecordReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.calendar.v4中的方法
| 限定符和类型 |
方法和说明 |
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)
|
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)
|
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)
取消订阅日程变更事件,该接口用于以用户身份取消订阅指定日历下的日程变更事件。
|
参数类型为RequestOptions的com.lark.oapi.service.contact.v3中的方法
| 限定符和类型 |
方法和说明 |
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)
|
GetUserResp |
ContactService.User.get(GetUserReq req,
RequestOptions reqOptions)
获取单个用户信息,该接口用于获取通讯录中[单个用户的信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/field-overview)。
|
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)
|
ListUserResp |
ContactService.User.list(ListUserReq req,
RequestOptions reqOptions)
获取用户列表,基于部门ID获取部门下直属用户列表。
|
ListDepartmentUnitResp |
ContactService.Unit.listDepartment(ListDepartmentUnitReq req,
RequestOptions reqOptions)
|
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)
更新用户所有信息,该接口用于更新通讯录中用户的字段。
|
参数类型为RequestOptions的com.lark.oapi.service.docx.v1中的方法
| 限定符和类型 |
方法和说明 |
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)
获取文档纯文本内容,获取文档的纯文本内容。
|
参数类型为RequestOptions的com.lark.oapi.service.drive.v1中的方法
| 限定符和类型 |
方法和说明 |
BatchGetTmpDownloadUrlMediaResp |
DriveService.Media.batchGetTmpDownloadUrl(BatchGetTmpDownloadUrlMediaReq req,
RequestOptions reqOptions)
获取素材临时下载链接,通过file_token获取素材临时下载链接,链接时效性是24小时,过期失效。
|
BatchQueryMetaResp |
DriveService.Meta.batchQuery(BatchQueryMetaReq req,
RequestOptions reqOptions)
|
CopyFileResp |
DriveService.File.copy(CopyFileReq req,
RequestOptions reqOptions)
复制文件,将文件复制到用户云空间的其他文件夹中。
|
CreateExportTaskResp |
DriveService.ExportTask.create(CreateExportTaskReq req,
RequestOptions reqOptions)
|
CreateFileCommentResp |
DriveService.FileComment.create(CreateFileCommentReq req,
RequestOptions reqOptions)
添加评论,往云文档添加一条全局评论。
|
CreateFileSubscriptionResp |
DriveService.FileSubscription.create(CreateFileSubscriptionReq req,
RequestOptions reqOptions)
|
CreateImportTaskResp |
DriveService.ImportTask.create(CreateImportTaskReq req,
RequestOptions reqOptions)
创建导入任务,创建导入任务。
|
CreatePermissionMemberResp |
DriveService.PermissionMember.create(CreatePermissionMemberReq req,
RequestOptions reqOptions)
增加协作者权限,该接口用于根据 filetoken 给用户增加文档的权限。
|
CreateFolderFileResp |
DriveService.File.createFolder(CreateFolderFileReq req,
RequestOptions reqOptions)
新建文件夹,在用户云空间的指定文件夹中创建一个新的空文件夹。
|
DeleteFileCommentReplyResp |
DriveService.FileCommentReply.delete(DeleteFileCommentReplyReq req,
RequestOptions reqOptions)
删除回复,删除云文档中的某条回复。
|
DeleteFileResp |
DriveService.File.delete(DeleteFileReq req,
RequestOptions reqOptions)
删除文件,删除用户在云空间内的文件或者文件夹。
|
DeletePermissionMemberResp |
DriveService.PermissionMember.delete(DeletePermissionMemberReq req,
RequestOptions reqOptions)
移除协作者权限,该接口用于根据 filetoken 移除文档协作者的权限。
|
DownloadExportTaskResp |
DriveService.ExportTask.download(DownloadExportTaskReq req,
RequestOptions reqOptions)
|
DownloadFileResp |
DriveService.File.download(DownloadFileReq req,
RequestOptions reqOptions)
下载文件,使用该接口可以下载在云空间目录下的文件(不含飞书文档/表格/思维导图等在线文档)。
|
DownloadMediaResp |
DriveService.Media.download(DownloadMediaReq req,
RequestOptions reqOptions)
下载素材,使用该接口可以下载素材。
|
GetExportTaskResp |
DriveService.ExportTask.get(GetExportTaskReq req,
RequestOptions reqOptions)
|
GetFileCommentResp |
DriveService.FileComment.get(GetFileCommentReq req,
RequestOptions reqOptions)
获取评论,获取云文档中的某条评论。
|
GetFileStatisticsResp |
DriveService.FileStatistics.get(GetFileStatisticsReq req,
RequestOptions reqOptions)
获取文件统计信息,此接口用于获取文件统计信息,包括文档阅读人数、次数和点赞数。
|
GetFileSubscriptionResp |
DriveService.FileSubscription.get(GetFileSubscriptionReq req,
RequestOptions reqOptions)
|
GetImportTaskResp |
DriveService.ImportTask.get(GetImportTaskReq req,
RequestOptions reqOptions)
查询导入结果,根据创建导入任务返回的 ticket 查询导入结果。
|
GetPermissionPublicResp |
DriveService.PermissionPublic.get(GetPermissionPublicReq req,
RequestOptions reqOptions)
获取云文档权限设置,该接口用于根据 filetoken 获取云文档的权限设置。
|
ListFileCommentResp |
DriveService.FileComment.list(ListFileCommentReq req,
RequestOptions reqOptions)
获取评论列表,通过分页方式获取云文档中的全文评论列表。
|
ListFileResp |
DriveService.File.list(ListFileReq req,
RequestOptions reqOptions)
获取文件夹下的清单,获取用户云空间中指定文件夹下的文件清单。
|
MoveFileResp |
DriveService.File.move(MoveFileReq req,
RequestOptions reqOptions)
移动文件,将文件或者文件夹移动到用户云空间的其他位置。
|
PatchFileCommentResp |
DriveService.FileComment.patch(PatchFileCommentReq req,
RequestOptions reqOptions)
解决/恢复 评论,解决或恢复云文档中的评论。
|
PatchFileSubscriptionResp |
DriveService.FileSubscription.patch(PatchFileSubscriptionReq req,
RequestOptions reqOptions)
|
PatchPermissionPublicResp |
DriveService.PermissionPublic.patch(PatchPermissionPublicReq req,
RequestOptions reqOptions)
更新云文档权限设置,该接口用于根据 filetoken 更新云文档的权限设置。
|
SubscribeFileResp |
DriveService.File.subscribe(SubscribeFileReq req,
RequestOptions reqOptions)
订阅云文档事件,该接口仅支持**文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。
|
TaskCheckFileResp |
DriveService.File.taskCheck(TaskCheckFileReq req,
RequestOptions reqOptions)
查询异步任务状态,查询删除文件夹等异步任务的状态信息。
|
UpdateFileCommentReplyResp |
DriveService.FileCommentReply.update(UpdateFileCommentReplyReq req,
RequestOptions reqOptions)
更新回复,更新云文档中的某条回复。
|
UpdatePermissionMemberResp |
DriveService.PermissionMember.update(UpdatePermissionMemberReq req,
RequestOptions reqOptions)
更新协作者权限,该接口用于根据 filetoken 更新文档协作者的权限。
|
UploadAllFileResp |
DriveService.File.uploadAll(UploadAllFileReq req,
RequestOptions reqOptions)
上传文件,向云空间指定目录下上传一个小文件。
|
UploadAllMediaResp |
DriveService.Media.uploadAll(UploadAllMediaReq req,
RequestOptions reqOptions)
上传素材,将文件、图片、视频等素材文件上传到指定云文档中。
|
UploadFinishFileResp |
DriveService.File.uploadFinish(UploadFinishFileReq req,
RequestOptions reqOptions)
分片上传文件(完成上传),触发完成上传。
|
UploadFinishMediaResp |
DriveService.Media.uploadFinish(UploadFinishMediaReq req,
RequestOptions reqOptions)
分片上传素材(完成上传),触发完成上传。
|
UploadPartFileResp |
DriveService.File.uploadPart(UploadPartFileReq req,
RequestOptions reqOptions)
分片上传文件(上传分片),上传对应的文件块。
|
UploadPartMediaResp |
DriveService.Media.uploadPart(UploadPartMediaReq req,
RequestOptions reqOptions)
分片上传素材(上传分片),上传对应的文件块。
|
UploadPrepareFileResp |
DriveService.File.uploadPrepare(UploadPrepareFileReq req,
RequestOptions reqOptions)
分片上传文件(预上传),发送初始化请求获取上传事务ID和分块策略,目前是以4MB大小进行定长分片。
|
UploadPrepareMediaResp |
DriveService.Media.uploadPrepare(UploadPrepareMediaReq req,
RequestOptions reqOptions)
分片上传素材(预上传),发送初始化请求获取上传事务ID和分块策略,目前是以4MB大小进行定长分片。
|
参数类型为RequestOptions的com.lark.oapi.service.gray_test_open_sg.v1中的方法
| 限定符和类型 |
方法和说明 |
CreateMotoResp |
GrayTestOpenSgService.Moto.create(CreateMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
GetMotoResp |
GrayTestOpenSgService.Moto.get(GetMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
ListMotoResp |
GrayTestOpenSgService.Moto.list(ListMotoReq req,
RequestOptions reqOptions)
,
官网API文档链接:
参数类型为RequestOptions的com.lark.oapi.service.helpdesk.v1中的方法
| 限定符和类型 |
方法和说明 |
AgentEmailAgentResp |
HelpdeskService.Agent.agentEmail(RequestOptions reqOptions)
|
AnswerUserQueryTicketResp |
HelpdeskService.Ticket.answerUserQuery(AnswerUserQueryTicketReq req,
RequestOptions reqOptions)
回复用户提问结果至工单,该接口用于回复用户提问结果至工单,需要工单仍处于进行中且未接入人工状态。
|
CancelApproveNotificationResp |
HelpdeskService.Notification.cancelApprove(CancelApproveNotificationReq req,
RequestOptions reqOptions)
|
CancelSendNotificationResp |
HelpdeskService.Notification.cancelSend(CancelSendNotificationReq req,
RequestOptions reqOptions)
|
CreateAgentScheduleResp |
HelpdeskService.AgentSchedule.create(CreateAgentScheduleReq req,
RequestOptions reqOptions)
|
CreateAgentSkillResp |
HelpdeskService.AgentSkill.create(CreateAgentSkillReq req,
RequestOptions reqOptions)
|
CreateBotMessageResp |
HelpdeskService.BotMessage.create(CreateBotMessageReq req,
RequestOptions reqOptions)
服务台机器人发送消息,通过服务台机器人给指定用户的服务台专属群或私聊发送消息,支持文本、富文本、卡片、图片。
|
CreateCategoryResp |
HelpdeskService.Category.create(CreateCategoryReq req,
RequestOptions reqOptions)
创建知识库分类,该接口用于创建知识库分类。
|
CreateFaqResp |
HelpdeskService.Faq.create(CreateFaqReq req,
RequestOptions reqOptions)
创建知识库,该接口用于创建知识库。
|
CreateNotificationResp |
HelpdeskService.Notification.create(CreateNotificationReq req,
RequestOptions reqOptions)
|
CreateTicketCustomizedFieldResp |
HelpdeskService.TicketCustomizedField.create(CreateTicketCustomizedFieldReq req,
RequestOptions reqOptions)
|
CreateTicketMessageResp |
HelpdeskService.TicketMessage.create(CreateTicketMessageReq req,
RequestOptions reqOptions)
工单发送消息,该接口用于工单发送消息。
|
CustomizedFieldsTicketResp |
HelpdeskService.Ticket.customizedFields(CustomizedFieldsTicketReq req,
RequestOptions reqOptions)
获取服务台自定义字段详情,该接口用于获取服务台自定义字段详情。
|
DeleteAgentSchedulesResp |
HelpdeskService.AgentSchedules.delete(DeleteAgentSchedulesReq req,
RequestOptions reqOptions)
|
DeleteAgentSkillResp |
HelpdeskService.AgentSkill.delete(DeleteAgentSkillReq req,
RequestOptions reqOptions)
|
DeleteCategoryResp |
HelpdeskService.Category.delete(DeleteCategoryReq req,
RequestOptions reqOptions)
删除知识库分类详情,该接口用于删除知识库分类详情。
|
DeleteFaqResp |
HelpdeskService.Faq.delete(DeleteFaqReq req,
RequestOptions reqOptions)
删除知识库,该接口用于删除知识库。
|
DeleteTicketCustomizedFieldResp |
HelpdeskService.TicketCustomizedField.delete(DeleteTicketCustomizedFieldReq req,
RequestOptions reqOptions)
删除工单自定义字段,该接口用于删除工单自定义字段。
|
ExecuteSendNotificationResp |
HelpdeskService.Notification.executeSend(ExecuteSendNotificationReq req,
RequestOptions reqOptions)
|
FaqImageFaqResp |
HelpdeskService.Faq.faqImage(FaqImageFaqReq req,
RequestOptions reqOptions)
获取知识库图像,该接口用于获取知识库图像。
|
GetAgentSchedulesResp |
HelpdeskService.AgentSchedules.get(GetAgentSchedulesReq req,
RequestOptions reqOptions)
|
GetAgentSkillResp |
HelpdeskService.AgentSkill.get(GetAgentSkillReq req,
RequestOptions reqOptions)
|
GetCategoryResp |
HelpdeskService.Category.get(GetCategoryReq req,
RequestOptions reqOptions)
获取知识库分类,该接口用于获取知识库分类。
|
GetFaqResp |
HelpdeskService.Faq.get(GetFaqReq req,
RequestOptions reqOptions)
获取知识库详情,该接口用于获取服务台知识库详情。
|
GetNotificationResp |
HelpdeskService.Notification.get(GetNotificationReq req,
RequestOptions reqOptions)
|
GetTicketCustomizedFieldResp |
HelpdeskService.TicketCustomizedField.get(GetTicketCustomizedFieldReq req,
RequestOptions reqOptions)
获取工单自定义字段,该接口用于获取工单自定义字段详情。
|
GetTicketResp |
HelpdeskService.Ticket.get(GetTicketReq req,
RequestOptions reqOptions)
获取工单详情,该接口用于获取单个服务台工单详情。
|
ListAgentScheduleResp |
HelpdeskService.AgentSchedule.list(ListAgentScheduleReq req,
RequestOptions reqOptions)
|
ListCategoryResp |
HelpdeskService.Category.list(ListCategoryReq req,
RequestOptions reqOptions)
|
ListFaqResp |
HelpdeskService.Faq.list(ListFaqReq req,
RequestOptions reqOptions)
获取全部知识库详情,该接口用于获取服务台知识库详情。
|
ListTicketCustomizedFieldResp |
HelpdeskService.TicketCustomizedField.list(ListTicketCustomizedFieldReq req,
RequestOptions reqOptions)
获取全部工单自定义字段,该接口用于获取全部工单自定义字段。
|
ListTicketMessageResp |
HelpdeskService.TicketMessage.list(ListTicketMessageReq req,
RequestOptions reqOptions)
获取服务台工单消息详情,该接口用于获取服务台工单消息详情。
|
ListTicketResp |
HelpdeskService.Ticket.list(ListTicketReq req,
RequestOptions reqOptions)
获取全部工单详情,该接口用于获取全部工单详情。
|
ListAgentSkillResp |
HelpdeskService.AgentSkill.list(RequestOptions reqOptions)
|
ListAgentSkillRuleResp |
HelpdeskService.AgentSkillRule.list(RequestOptions reqOptions)
获取客服技能列表,该接口用于获取全部客服技能。
|
PatchAgentResp |
HelpdeskService.Agent.patch(PatchAgentReq req,
RequestOptions reqOptions)
|
PatchAgentSchedulesResp |
HelpdeskService.AgentSchedules.patch(PatchAgentSchedulesReq req,
RequestOptions reqOptions)
|
PatchAgentSkillResp |
HelpdeskService.AgentSkill.patch(PatchAgentSkillReq req,
RequestOptions reqOptions)
|
PatchCategoryResp |
HelpdeskService.Category.patch(PatchCategoryReq req,
RequestOptions reqOptions)
更新知识库分类详情,该接口用于更新知识库分类详情。
|
PatchFaqResp |
HelpdeskService.Faq.patch(PatchFaqReq req,
RequestOptions reqOptions)
修改知识库,该接口用于修改知识库。
|
PatchNotificationResp |
HelpdeskService.Notification.patch(PatchNotificationReq req,
RequestOptions reqOptions)
|
PatchTicketCustomizedFieldResp |
HelpdeskService.TicketCustomizedField.patch(PatchTicketCustomizedFieldReq req,
RequestOptions reqOptions)
更新工单自定义字段,该接口用于更新自定义字段。
|
PreviewNotificationResp |
HelpdeskService.Notification.preview(PreviewNotificationReq req,
RequestOptions reqOptions)
|
SearchFaqResp |
HelpdeskService.Faq.search(SearchFaqReq req,
RequestOptions reqOptions)
搜索知识库,该接口用于搜索服务台知识库。
|
StartServiceTicketResp |
HelpdeskService.Ticket.startService(StartServiceTicketReq req,
RequestOptions reqOptions)
创建服务台对话,该接口用于创建服务台对话。
|
SubmitApproveNotificationResp |
HelpdeskService.Notification.submitApprove(SubmitApproveNotificationReq req,
RequestOptions reqOptions)
|
SubscribeEventResp |
HelpdeskService.Event.subscribe(SubscribeEventReq req,
RequestOptions reqOptions)
|
TicketImageTicketResp |
HelpdeskService.Ticket.ticketImage(TicketImageTicketReq req,
RequestOptions reqOptions)
获取服务台工单内消息图像,该接口用于获取服务台工单消息图象。
|
UnsubscribeEventResp |
HelpdeskService.Event.unsubscribe(UnsubscribeEventReq req,
RequestOptions reqOptions)
|
UpdateTicketResp |
HelpdeskService.Ticket.update(UpdateTicketReq req,
RequestOptions reqOptions)
更新工单详情,该接口用于更新服务台工单详情。
|
参数类型为RequestOptions的com.lark.oapi.service.hire.v1中的方法
| 限定符和类型 |
方法和说明 |
CreateApplicationResp |
HireService.Application.create(CreateApplicationReq req,
RequestOptions reqOptions)
|
CreateNoteResp |
HireService.Note.create(CreateNoteReq req,
RequestOptions reqOptions)
|
GetApplicationResp |
HireService.Application.get(GetApplicationReq req,
RequestOptions reqOptions)
|
GetAttachmentResp |
HireService.Attachment.get(GetAttachmentReq req,
RequestOptions reqOptions)
|
GetEmployeeResp |
HireService.Employee.get(GetEmployeeReq req,
RequestOptions reqOptions)
|
GetJobManagerResp |
HireService.JobManager.get(GetJobManagerReq req,
RequestOptions reqOptions)
|
GetJobResp |
HireService.Job.get(GetJobReq req,
RequestOptions reqOptions)
|
GetNoteResp |
HireService.Note.get(GetNoteReq req,
RequestOptions reqOptions)
|
GetOfferSchemaResp |
HireService.OfferSchema.get(GetOfferSchemaReq req,
RequestOptions reqOptions)
|
GetTalentResp |
HireService.Talent.get(GetTalentReq req,
RequestOptions reqOptions)
|
GetByApplicationEmployeeResp |
HireService.Employee.getByApplication(GetByApplicationEmployeeReq req,
RequestOptions reqOptions)
|
GetByApplicationReferralResp |
HireService.Referral.getByApplication(GetByApplicationReferralReq req,
RequestOptions reqOptions)
|
ListApplicationInterviewResp |
HireService.ApplicationInterview.list(ListApplicationInterviewReq req,
RequestOptions reqOptions)
|
ListApplicationResp |
HireService.Application.list(ListApplicationReq req,
RequestOptions reqOptions)
|
ListJobProcessResp |
HireService.JobProcess.list(ListJobProcessReq req,
RequestOptions reqOptions)
|
ListNoteResp |
HireService.Note.list(ListNoteReq req,
RequestOptions reqOptions)
|
ListResumeSourceResp |
HireService.ResumeSource.list(ListResumeSourceReq req,
RequestOptions reqOptions)
|
OfferApplicationResp |
HireService.Application.offer(OfferApplicationReq req,
RequestOptions reqOptions)
|
PatchEmployeeResp |
HireService.Employee.patch(PatchEmployeeReq req,
RequestOptions reqOptions)
|
PatchNoteResp |
HireService.Note.patch(PatchNoteReq req,
RequestOptions reqOptions)
|
PreviewAttachmentResp |
HireService.Attachment.preview(PreviewAttachmentReq req,
RequestOptions reqOptions)
|
TerminateApplicationResp |
HireService.Application.terminate(TerminateApplicationReq req,
RequestOptions reqOptions)
|
TransferOnboardApplicationResp |
HireService.Application.transferOnboard(TransferOnboardApplicationReq req,
RequestOptions reqOptions)
操作候选人入职,根据投递 ID 操作候选人入职并创建员工。
|
参数类型为RequestOptions的com.lark.oapi.service.im.v1中的方法
| 限定符和类型 |
方法和说明 |
AddManagersChatManagersResp |
ImService.ChatManagers.addManagers(AddManagersChatManagersReq req,
RequestOptions reqOptions)
指定群管理员,将用户或机器人指定为群管理员。
|
CreateChatMembersResp |
ImService.ChatMembers.create(CreateChatMembersReq req,
RequestOptions reqOptions)
将用户或机器人拉入群聊,将用户或机器人拉入群聊。
|
CreateChatResp |
ImService.Chat.create(CreateChatReq req,
RequestOptions reqOptions)
创建群,创建群并设置群头像、群名、群描述等。
|
CreateChatTabResp |
ImService.ChatTab.create(CreateChatTabReq req,
RequestOptions reqOptions)
|
CreateFileResp |
ImService.File.create(CreateFileReq req,
RequestOptions reqOptions)
|
CreateImageResp |
ImService.Image.create(CreateImageReq req,
RequestOptions reqOptions)
|
CreateMessageReactionResp |
ImService.MessageReaction.create(CreateMessageReactionReq req,
RequestOptions reqOptions)
添加消息表情回复,给指定消息添加指定类型的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
CreateMessageResp |
ImService.Message.create(CreateMessageReq req,
RequestOptions reqOptions)
发送消息,给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
|
CreatePinResp |
ImService.Pin.create(CreatePinReq req,
RequestOptions reqOptions)
|
DeleteBatchMessageResp |
ImService.BatchMessage.delete(DeleteBatchMessageReq req,
RequestOptions reqOptions)
批量撤回消息,批量撤回消息
注意事项:;- 只能撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息,单条消息的撤回请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 路径参数**batch_message_id**为[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口返回值中的**message_id**字段,用于标识一次批量发送消息请求,格式为:**bm-xxx**;- 一次调用涉及大量消息,所以为异步接口,会有一定延迟。
|
DeleteChatMembersResp |
ImService.ChatMembers.delete(DeleteChatMembersReq req,
RequestOptions reqOptions)
将用户或机器人移出群聊,将用户或机器人移出群聊。
|
DeleteChatResp |
ImService.Chat.delete(DeleteChatReq req,
RequestOptions reqOptions)
|
DeleteMessageReactionResp |
ImService.MessageReaction.delete(DeleteMessageReactionReq req,
RequestOptions reqOptions)
删除消息表情回复,删除指定消息的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
DeleteMessageResp |
ImService.Message.delete(DeleteMessageReq req,
RequestOptions reqOptions)
撤回消息,机器人撤回机器人自己发送的消息或群主撤回群内消息。
|
DeletePinResp |
ImService.Pin.delete(DeletePinReq req,
RequestOptions reqOptions)
|
DeleteManagersChatManagersResp |
ImService.ChatManagers.deleteManagers(DeleteManagersChatManagersReq req,
RequestOptions reqOptions)
|
DeleteTabsChatTabResp |
ImService.ChatTab.deleteTabs(DeleteTabsChatTabReq req,
RequestOptions reqOptions)
|
DeleteTopNoticeChatTopNoticeResp |
ImService.ChatTopNotice.deleteTopNotice(DeleteTopNoticeChatTopNoticeReq req,
RequestOptions reqOptions)
|
GetChatAnnouncementResp |
ImService.ChatAnnouncement.get(GetChatAnnouncementReq req,
RequestOptions reqOptions)
获取群公告信息,获取会话中的群公告信息,公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
GetChatMembersResp |
ImService.ChatMembers.get(GetChatMembersReq req,
RequestOptions reqOptions)
获取群成员列表,如果用户在群中,则返回该群的成员列表。
|
GetChatModerationResp |
ImService.ChatModeration.get(GetChatModerationReq req,
RequestOptions reqOptions)
|
GetChatResp |
ImService.Chat.get(GetChatReq req,
RequestOptions reqOptions)
获取群信息,获取群名称、群描述、群头像、群主 ID 等群基本信息。
|
GetFileResp |
ImService.File.get(GetFileReq req,
RequestOptions reqOptions)
|
GetImageResp |
ImService.Image.get(GetImageReq req,
RequestOptions reqOptions)
|
GetMessageResp |
ImService.Message.get(GetMessageReq req,
RequestOptions reqOptions)
|
GetMessageResourceResp |
ImService.MessageResource.get(GetMessageResourceReq req,
RequestOptions reqOptions)
获取消息中的资源文件,获取消息中的资源文件,包括音频,视频,图片和文件,**暂不支持表情包资源下载**。
|
GetProgressBatchMessageResp |
ImService.BatchMessage.getProgress(GetProgressBatchMessageReq req,
RequestOptions reqOptions)
|
IsInChatChatMembersResp |
ImService.ChatMembers.isInChat(IsInChatChatMembersReq req,
RequestOptions reqOptions)
判断用户或机器人是否在群里,根据使用的access_token判断对应的用户或者机器人是否在群里。
|
ListChatResp |
ImService.Chat.list(ListChatReq req,
RequestOptions reqOptions)
获取用户或机器人所在的群列表,获取用户或者机器人所在群列表。
|
ListMessageReactionResp |
ImService.MessageReaction.list(ListMessageReactionReq req,
RequestOptions reqOptions)
获取消息表情回复,获取指定消息的特定类型表情回复列表(reaction即表情回复,本说明文档统一用“reaction”代称)。
|
ListMessageResp |
ImService.Message.list(ListMessageReq req,
RequestOptions reqOptions)
获取会话历史消息,获取会话(包括单聊、群组)的历史消息(聊天记录)。
|
ListPinResp |
ImService.Pin.list(ListPinReq req,
RequestOptions reqOptions)
|
ListTabsChatTabResp |
ImService.ChatTab.listTabs(ListTabsChatTabReq req,
RequestOptions reqOptions)
|
MeJoinChatMembersResp |
ImService.ChatMembers.meJoin(MeJoinChatMembersReq req,
RequestOptions reqOptions)
用户或机器人主动加入群聊,用户或机器人主动加入群聊。
|
PatchChatAnnouncementResp |
ImService.ChatAnnouncement.patch(PatchChatAnnouncementReq req,
RequestOptions reqOptions)
更新群公告信息,更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
|
PatchMessageResp |
ImService.Message.patch(PatchMessageReq req,
RequestOptions reqOptions)
更新应用发送的消息,更新应用已发送的消息卡片内容。
|
PutTopNoticeChatTopNoticeResp |
ImService.ChatTopNotice.putTopNotice(PutTopNoticeChatTopNoticeReq req,
RequestOptions reqOptions)
更新群置顶,更新会话中的群置顶信息,可以将群中的某一条消息,或者群公告置顶显示。
|
ReadUserBatchMessageResp |
ImService.BatchMessage.readUser(ReadUserBatchMessageReq req,
RequestOptions reqOptions)
查询批量消息推送和阅读人数,查询批量消息推送和阅读人数
注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;- 该接口返回的数据为查询时刻的快照数据。
|
ReadUsersMessageResp |
ImService.Message.readUsers(ReadUsersMessageReq req,
RequestOptions reqOptions)
查询消息已读信息,查询消息的已读信息。
|
ReplyMessageResp |
ImService.Message.reply(ReplyMessageReq req,
RequestOptions reqOptions)
回复消息,回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
|
SearchChatResp |
ImService.Chat.search(SearchChatReq req,
RequestOptions reqOptions)
搜索对用户或机器人可见的群列表,搜索对用户或机器人可见的群列表,包括:用户或机器人所在的群、对用户或机器人公开的群。
|
SortTabsChatTabResp |
ImService.ChatTab.sortTabs(SortTabsChatTabReq req,
RequestOptions reqOptions)
会话标签页排序,会话标签页排序
注意事项:;;- 当前消息标签页固定为第一顺位,不参与排序,但是请求体中必须包含。
|
UpdateChatModerationResp |
ImService.ChatModeration.update(UpdateChatModerationReq req,
RequestOptions reqOptions)
更新群发言权限,更新群组的发言权限设置,可设置为全员可发言、仅管理员可发言 或 指定用户可发言。
|
UpdateChatResp |
ImService.Chat.update(UpdateChatReq req,
RequestOptions reqOptions)
更新群信息,更新群头像、群名称、群描述、群配置、转让群主等。
|
UpdateTabsChatTabResp |
ImService.ChatTab.updateTabs(UpdateTabsChatTabReq req,
RequestOptions reqOptions)
|
UrgentAppMessageResp |
ImService.Message.urgentApp(UrgentAppMessageReq req,
RequestOptions reqOptions)
发送应用内加急,对指定消息进行应用内加急。
|
UrgentPhoneMessageResp |
ImService.Message.urgentPhone(UrgentPhoneMessageReq req,
RequestOptions reqOptions)
发送电话加急,对指定消息进行应用内加急与电话加急
特别说明:;- 通过接口产生的电话加急将消耗企业的加急额度,请慎重调用。
|
UrgentSmsMessageResp |
ImService.Message.urgentSms(UrgentSmsMessageReq req,
RequestOptions reqOptions)
发送短信加急,对指定消息进行应用内加急与短信加急。
|
参数类型为RequestOptions的com.lark.oapi.service.mail.v1中的方法
| 限定符和类型 |
方法和说明 |
ClearPublicMailboxMemberResp |
MailService.PublicMailboxMember.clear(ClearPublicMailboxMemberReq req,
RequestOptions reqOptions)
|
CreateMailgroupAliasResp |
MailService.MailgroupAlias.create(CreateMailgroupAliasReq req,
RequestOptions reqOptions)
|
CreateMailgroupMemberResp |
MailService.MailgroupMember.create(CreateMailgroupMemberReq req,
RequestOptions reqOptions)
|
CreateMailgroupPermissionMemberResp |
MailService.MailgroupPermissionMember.create(CreateMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
|
CreateMailgroupResp |
MailService.Mailgroup.create(CreateMailgroupReq req,
RequestOptions reqOptions)
|
CreatePublicMailboxAliasResp |
MailService.PublicMailboxAlias.create(CreatePublicMailboxAliasReq req,
RequestOptions reqOptions)
|
CreatePublicMailboxMemberResp |
MailService.PublicMailboxMember.create(CreatePublicMailboxMemberReq req,
RequestOptions reqOptions)
|
CreatePublicMailboxResp |
MailService.PublicMailbox.create(CreatePublicMailboxReq req,
RequestOptions reqOptions)
|
CreateUserMailboxAliasResp |
MailService.UserMailboxAlias.create(CreateUserMailboxAliasReq req,
RequestOptions reqOptions)
|
DeleteMailgroupAliasResp |
MailService.MailgroupAlias.delete(DeleteMailgroupAliasReq req,
RequestOptions reqOptions)
|
DeleteMailgroupMemberResp |
MailService.MailgroupMember.delete(DeleteMailgroupMemberReq req,
RequestOptions reqOptions)
|
DeleteMailgroupPermissionMemberResp |
MailService.MailgroupPermissionMember.delete(DeleteMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
|
DeleteMailgroupResp |
MailService.Mailgroup.delete(DeleteMailgroupReq req,
RequestOptions reqOptions)
|
DeletePublicMailboxAliasResp |
MailService.PublicMailboxAlias.delete(DeletePublicMailboxAliasReq req,
RequestOptions reqOptions)
|
DeletePublicMailboxMemberResp |
MailService.PublicMailboxMember.delete(DeletePublicMailboxMemberReq req,
RequestOptions reqOptions)
|
DeletePublicMailboxResp |
MailService.PublicMailbox.delete(DeletePublicMailboxReq req,
RequestOptions reqOptions)
释放公共邮箱地址,该接口会永久删除公共邮箱地址。
|
DeleteUserMailboxAliasResp |
MailService.UserMailboxAlias.delete(DeleteUserMailboxAliasReq req,
RequestOptions reqOptions)
|
DeleteUserMailboxResp |
MailService.UserMailbox.delete(DeleteUserMailboxReq req,
RequestOptions reqOptions)
释放用户邮箱地址,该接口会永久删除用户邮箱地址。
|
GetMailgroupMemberResp |
MailService.MailgroupMember.get(GetMailgroupMemberReq req,
RequestOptions reqOptions)
|
GetMailgroupPermissionMemberResp |
MailService.MailgroupPermissionMember.get(GetMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
|
GetMailgroupResp |
MailService.Mailgroup.get(GetMailgroupReq req,
RequestOptions reqOptions)
|
GetPublicMailboxMemberResp |
MailService.PublicMailboxMember.get(GetPublicMailboxMemberReq req,
RequestOptions reqOptions)
|
GetPublicMailboxResp |
MailService.PublicMailbox.get(GetPublicMailboxReq req,
RequestOptions reqOptions)
|
ListMailgroupAliasResp |
MailService.MailgroupAlias.list(ListMailgroupAliasReq req,
RequestOptions reqOptions)
|
ListMailgroupMemberResp |
MailService.MailgroupMember.list(ListMailgroupMemberReq req,
RequestOptions reqOptions)
|
ListMailgroupPermissionMemberResp |
MailService.MailgroupPermissionMember.list(ListMailgroupPermissionMemberReq req,
RequestOptions reqOptions)
|
ListMailgroupResp |
MailService.Mailgroup.list(ListMailgroupReq req,
RequestOptions reqOptions)
|
ListPublicMailboxAliasResp |
MailService.PublicMailboxAlias.list(ListPublicMailboxAliasReq req,
RequestOptions reqOptions)
|
ListPublicMailboxMemberResp |
MailService.PublicMailboxMember.list(ListPublicMailboxMemberReq req,
RequestOptions reqOptions)
|
ListPublicMailboxResp |
MailService.PublicMailbox.list(ListPublicMailboxReq req,
RequestOptions reqOptions)
|
ListUserMailboxAliasResp |
MailService.UserMailboxAlias.list(ListUserMailboxAliasReq req,
RequestOptions reqOptions)
|
PatchMailgroupResp |
MailService.Mailgroup.patch(PatchMailgroupReq req,
RequestOptions reqOptions)
|
PatchPublicMailboxResp |
MailService.PublicMailbox.patch(PatchPublicMailboxReq req,
RequestOptions reqOptions)
|
QueryUserResp |
MailService.User.query(QueryUserReq req,
RequestOptions reqOptions)
|
UpdateMailgroupResp |
MailService.Mailgroup.update(UpdateMailgroupReq req,
RequestOptions reqOptions)
|
UpdatePublicMailboxResp |
MailService.PublicMailbox.update(UpdatePublicMailboxReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.search.v2中的方法
| 限定符和类型 |
方法和说明 |
CreateDataSourceItemResp |
SearchService.DataSourceItem.create(CreateDataSourceItemReq req,
RequestOptions reqOptions)
|
CreateDataSourceResp |
SearchService.DataSource.create(CreateDataSourceReq req,
RequestOptions reqOptions)
|
CreateSchemaResp |
SearchService.Schema.create(CreateSchemaReq req,
RequestOptions reqOptions)
|
DeleteDataSourceItemResp |
SearchService.DataSourceItem.delete(DeleteDataSourceItemReq req,
RequestOptions reqOptions)
|
DeleteDataSourceResp |
SearchService.DataSource.delete(DeleteDataSourceReq req,
RequestOptions reqOptions)
|
DeleteSchemaResp |
SearchService.Schema.delete(DeleteSchemaReq req,
RequestOptions reqOptions)
|
GetDataSourceItemResp |
SearchService.DataSourceItem.get(GetDataSourceItemReq req,
RequestOptions reqOptions)
|
GetDataSourceResp |
SearchService.DataSource.get(GetDataSourceReq req,
RequestOptions reqOptions)
|
GetSchemaResp |
SearchService.Schema.get(GetSchemaReq req,
RequestOptions reqOptions)
|
ListDataSourceResp |
SearchService.DataSource.list(ListDataSourceReq req,
RequestOptions reqOptions)
|
PatchDataSourceResp |
SearchService.DataSource.patch(PatchDataSourceReq req,
RequestOptions reqOptions)
|
PatchSchemaResp |
SearchService.Schema.patch(PatchSchemaReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.sheets.v3中的方法
| 限定符和类型 |
方法和说明 |
CreateSpreadsheetResp |
SheetsService.Spreadsheet.create(CreateSpreadsheetReq req,
RequestOptions reqOptions)
创建表格,使用该接口可以在指定的目录下创建在线表格。
|
CreateSpreadsheetSheetFilterResp |
SheetsService.SpreadsheetSheetFilter.create(CreateSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
创建筛选,在子表内创建筛选。
|
CreateSpreadsheetSheetFilterViewConditionResp |
SheetsService.SpreadsheetSheetFilterViewCondition.create(CreateSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
创建筛选条件,在筛选视图的筛选范围的某一列创建筛选条件。
|
CreateSpreadsheetSheetFilterViewResp |
SheetsService.SpreadsheetSheetFilterView.create(CreateSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
创建筛选视图,根据传入的参数创建一个筛选视图。
|
CreateSpreadsheetSheetFloatImageResp |
SheetsService.SpreadsheetSheetFloatImage.create(CreateSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
创建浮动图片,根据传入的参数创建一张浮动图片。
|
DeleteSpreadsheetSheetFilterResp |
SheetsService.SpreadsheetSheetFilter.delete(DeleteSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
|
DeleteSpreadsheetSheetFilterViewConditionResp |
SheetsService.SpreadsheetSheetFilterViewCondition.delete(DeleteSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
删除筛选条件,删除筛选视图的筛选范围某一列的筛选条件。
|
DeleteSpreadsheetSheetFilterViewResp |
SheetsService.SpreadsheetSheetFilterView.delete(DeleteSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
删除筛选视图,删除指定 id 对应的筛选视图。
|
DeleteSpreadsheetSheetFloatImageResp |
SheetsService.SpreadsheetSheetFloatImage.delete(DeleteSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
删除浮动图片,删除 float_image_id 对应的浮动图片。
|
FindSpreadsheetSheetResp |
SheetsService.SpreadsheetSheet.find(FindSpreadsheetSheetReq req,
RequestOptions reqOptions)
查找单元格,按照指定的条件查找子表的某个范围内的数据符合条件的单元格位置。
|
GetSpreadsheetResp |
SheetsService.Spreadsheet.get(GetSpreadsheetReq req,
RequestOptions reqOptions)
获取电子表格信息,该接口用于获取电子表格的基础信息。
|
GetSpreadsheetSheetFilterResp |
SheetsService.SpreadsheetSheetFilter.get(GetSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
|
GetSpreadsheetSheetFilterViewConditionResp |
SheetsService.SpreadsheetSheetFilterViewCondition.get(GetSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
获取筛选条件,获取筛选视图某列的筛选条件信息。
|
GetSpreadsheetSheetFilterViewResp |
SheetsService.SpreadsheetSheetFilterView.get(GetSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
获取筛选视图,获取指定筛选视图 id 的名字和筛选范围。
|
GetSpreadsheetSheetFloatImageResp |
SheetsService.SpreadsheetSheetFloatImage.get(GetSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
获取浮动图片,根据 float_image_id 获取对应浮动图片的信息。
|
GetSpreadsheetSheetResp |
SheetsService.SpreadsheetSheet.get(GetSpreadsheetSheetReq req,
RequestOptions reqOptions)
查询工作表,该接口用于通过工作表ID查询工作表属性信息。
|
MoveDimensionSpreadsheetSheetResp |
SheetsService.SpreadsheetSheet.moveDimension(MoveDimensionSpreadsheetSheetReq req,
RequestOptions reqOptions)
移动行列,该接口用于移动行列,行列被移动到目标位置后,原本在目标位置的行列会对应右移或下移。
|
PatchSpreadsheetResp |
SheetsService.Spreadsheet.patch(PatchSpreadsheetReq req,
RequestOptions reqOptions)
|
PatchSpreadsheetSheetFilterViewResp |
SheetsService.SpreadsheetSheetFilterView.patch(PatchSpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
更新筛选视图,更新筛选视图的名字或者筛选范围。
|
PatchSpreadsheetSheetFloatImageResp |
SheetsService.SpreadsheetSheetFloatImage.patch(PatchSpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
更新浮动图片,更新已有的浮动图片位置和宽高,包括 range、width、height、offset_x 和 offset_y,不包括 float_image_id 和 float_image_token。
|
QuerySpreadsheetSheetFilterViewConditionResp |
SheetsService.SpreadsheetSheetFilterViewCondition.query(QuerySpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
查询筛选条件,查询一个筛选视图的所有筛选条件,返回筛选视图的筛选范围内的筛选条件。
|
QuerySpreadsheetSheetFilterViewResp |
SheetsService.SpreadsheetSheetFilterView.query(QuerySpreadsheetSheetFilterViewReq req,
RequestOptions reqOptions)
|
QuerySpreadsheetSheetFloatImageResp |
SheetsService.SpreadsheetSheetFloatImage.query(QuerySpreadsheetSheetFloatImageReq req,
RequestOptions reqOptions)
查询浮动图片,返回子表内所有的浮动图片信息。
|
QuerySpreadsheetSheetResp |
SheetsService.SpreadsheetSheet.query(QuerySpreadsheetSheetReq req,
RequestOptions reqOptions)
获取工作表,该接口用于获取电子表格下所有工作表及其属性。
|
ReplaceSpreadsheetSheetResp |
SheetsService.SpreadsheetSheet.replace(ReplaceSpreadsheetSheetReq req,
RequestOptions reqOptions)
替换单元格,按照指定的条件查找子表的某个范围内的数据符合条件的单元格并替换值,返回替换成功的单元格位置。
|
UpdateSpreadsheetSheetFilterResp |
SheetsService.SpreadsheetSheetFilter.update(UpdateSpreadsheetSheetFilterReq req,
RequestOptions reqOptions)
更新筛选,更新子表筛选范围中的列筛选条件。
|
UpdateSpreadsheetSheetFilterViewConditionResp |
SheetsService.SpreadsheetSheetFilterViewCondition.update(UpdateSpreadsheetSheetFilterViewConditionReq req,
RequestOptions reqOptions)
更新筛选条件,更新筛选视图范围的某列的筛选条件,condition id 即为列的字母号。
|
参数类型为RequestOptions的com.lark.oapi.service.task.v1中的方法
| 限定符和类型 |
方法和说明 |
BatchDeleteCollaboratorTaskResp |
TaskService.Task.batchDeleteCollaborator(BatchDeleteCollaboratorTaskReq req,
RequestOptions reqOptions)
|
BatchDeleteFollowerTaskResp |
TaskService.Task.batchDeleteFollower(BatchDeleteFollowerTaskReq req,
RequestOptions reqOptions)
|
CompleteTaskResp |
TaskService.Task.complete(CompleteTaskReq req,
RequestOptions reqOptions)
|
CreateTaskCollaboratorResp |
TaskService.TaskCollaborator.create(CreateTaskCollaboratorReq req,
RequestOptions reqOptions)
新增执行者,该接口用于新增任务执行者,一次性可以添加多个执行者。
|
CreateTaskCommentResp |
TaskService.TaskComment.create(CreateTaskCommentReq req,
RequestOptions reqOptions)
创建评论,该接口用于创建和回复任务的评论。
|
CreateTaskFollowerResp |
TaskService.TaskFollower.create(CreateTaskFollowerReq req,
RequestOptions reqOptions)
新增关注人,该接口用于创建任务关注人。
|
CreateTaskReminderResp |
TaskService.TaskReminder.create(CreateTaskReminderReq req,
RequestOptions reqOptions)
新增提醒时间,该接口用于创建任务的提醒时间。
|
CreateTaskResp |
TaskService.Task.create(CreateTaskReq req,
RequestOptions reqOptions)
创建任务,该接口可以创建一个任务(基本信息),如果需要绑定协作者等需要调用别的资源管理接口。
|
DeleteTaskCollaboratorResp |
TaskService.TaskCollaborator.delete(DeleteTaskCollaboratorReq req,
RequestOptions reqOptions)
|
DeleteTaskCommentResp |
TaskService.TaskComment.delete(DeleteTaskCommentReq req,
RequestOptions reqOptions)
|
DeleteTaskFollowerResp |
TaskService.TaskFollower.delete(DeleteTaskFollowerReq req,
RequestOptions reqOptions)
|
DeleteTaskReminderResp |
TaskService.TaskReminder.delete(DeleteTaskReminderReq req,
RequestOptions reqOptions)
|
DeleteTaskResp |
TaskService.Task.delete(DeleteTaskReq req,
RequestOptions reqOptions)
|
GetTaskCommentResp |
TaskService.TaskComment.get(GetTaskCommentReq req,
RequestOptions reqOptions)
|
GetTaskResp |
TaskService.Task.get(GetTaskReq req,
RequestOptions reqOptions)
|
ListTaskCollaboratorResp |
TaskService.TaskCollaborator.list(ListTaskCollaboratorReq req,
RequestOptions reqOptions)
|
ListTaskCommentResp |
TaskService.TaskComment.list(ListTaskCommentReq req,
RequestOptions reqOptions)
|
ListTaskFollowerResp |
TaskService.TaskFollower.list(ListTaskFollowerReq req,
RequestOptions reqOptions)
|
ListTaskReminderResp |
TaskService.TaskReminder.list(ListTaskReminderReq req,
RequestOptions reqOptions)
|
ListTaskResp |
TaskService.Task.list(ListTaskReq req,
RequestOptions reqOptions)
获取任务列表,以分页的方式获取任务列表。
|
PatchTaskResp |
TaskService.Task.patch(PatchTaskReq req,
RequestOptions reqOptions)
|
UncompleteTaskResp |
TaskService.Task.uncomplete(UncompleteTaskReq req,
RequestOptions reqOptions)
|
UpdateTaskCommentResp |
TaskService.TaskComment.update(UpdateTaskCommentReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.vc.v1中的方法
| 限定符和类型 |
方法和说明 |
ApplyReserveResp |
VcService.Reserve.apply(ApplyReserveReq req,
RequestOptions reqOptions)
预约会议,创建一个会议预约。
|
DeleteReserveResp |
VcService.Reserve.delete(DeleteReserveReq req,
RequestOptions reqOptions)
|
EndMeetingResp |
VcService.Meeting.end(EndMeetingReq req,
RequestOptions reqOptions)
|
GetExportResp |
VcService.Export.get(GetExportReq req,
RequestOptions reqOptions)
|
GetMeetingRecordingResp |
VcService.MeetingRecording.get(GetMeetingRecordingReq req,
RequestOptions reqOptions)
获取录制文件,获取一个会议的录制文件。
|
GetMeetingResp |
VcService.Meeting.get(GetMeetingReq req,
RequestOptions reqOptions)
|
GetReserveResp |
VcService.Reserve.get(GetReserveReq req,
RequestOptions reqOptions)
|
GetActiveMeetingReserveResp |
VcService.Reserve.getActiveMeeting(GetActiveMeetingReserveReq req,
RequestOptions reqOptions)
|
GetDailyReportResp |
VcService.Report.getDaily(GetDailyReportReq req,
RequestOptions reqOptions)
获取会议报告,获取一段时间内组织的每日会议使用报告。
|
GetTopUserReportResp |
VcService.Report.getTopUser(GetTopUserReportReq req,
RequestOptions reqOptions)
获取top用户列表,获取一段时间内组织内会议使用的top用户列表。
|
InviteMeetingResp |
VcService.Meeting.invite(InviteMeetingReq req,
RequestOptions reqOptions)
|
KickoutMeetingResp |
VcService.Meeting.kickout(KickoutMeetingReq req,
RequestOptions reqOptions)
|
ListByNoMeetingResp |
VcService.Meeting.listByNo(ListByNoMeetingReq req,
RequestOptions reqOptions)
|
MeetingListExportResp |
VcService.Export.meetingList(MeetingListExportReq req,
RequestOptions reqOptions)
|
ParticipantListExportResp |
VcService.Export.participantList(ParticipantListExportReq req,
RequestOptions reqOptions)
|
ParticipantQualityListExportResp |
VcService.Export.participantQualityList(ParticipantQualityListExportReq req,
RequestOptions reqOptions)
|
QueryRoomConfigResp |
VcService.RoomConfig.query(QueryRoomConfigReq req,
RequestOptions reqOptions)
查询会议室配置,查询一个范围内的会议室配置。
|
SetRoomConfigResp |
VcService.RoomConfig.set(SetRoomConfigReq req,
RequestOptions reqOptions)
设置会议室配置,设置一个范围内的会议室配置。
|
SetHostMeetingResp |
VcService.Meeting.setHost(SetHostMeetingReq req,
RequestOptions reqOptions)
|
SetPermissionMeetingRecordingResp |
VcService.MeetingRecording.setPermission(SetPermissionMeetingRecordingReq req,
RequestOptions reqOptions)
|
StartMeetingRecordingResp |
VcService.MeetingRecording.start(StartMeetingRecordingReq req,
RequestOptions reqOptions)
开始录制,在会议中开始录制。
|
StopMeetingRecordingResp |
VcService.MeetingRecording.stop(StopMeetingRecordingReq req,
RequestOptions reqOptions)
停止录制,在会议中停止录制。
|
UpdateReserveResp |
VcService.Reserve.update(UpdateReserveReq req,
RequestOptions reqOptions)
|
参数类型为RequestOptions的com.lark.oapi.service.wiki.v2中的方法
| 限定符和类型 |
方法和说明 |
CopySpaceNodeResp |
WikiService.SpaceNode.copy(CopySpaceNodeReq req,
RequestOptions reqOptions)
创建节点副本,此接口用于创建节点副本到指定地点。
|
CreateSpaceMemberResp |
WikiService.SpaceMember.create(CreateSpaceMemberReq req,
RequestOptions reqOptions)
添加知识空间成员,添加知识空间成员(管理员)。
|
CreateSpaceNodeResp |
WikiService.SpaceNode.create(CreateSpaceNodeReq req,
RequestOptions reqOptions)
创建节点,此接口用于在知识库里创建节点。
|
CreateSpaceResp |
WikiService.Space.create(CreateSpaceReq req,
RequestOptions reqOptions)
|
DeleteSpaceMemberResp |
WikiService.SpaceMember.delete(DeleteSpaceMemberReq req,
RequestOptions reqOptions)
删除知识空间成员,此接口用于删除知识空间成员。
|
GetSpaceResp |
WikiService.Space.get(GetSpaceReq req,
RequestOptions reqOptions)
获取知识空间信息,此接口用于根据知识空间ID来查询知识空间的信息。
|
GetTaskResp |
WikiService.Task.get(GetTaskReq req,
RequestOptions reqOptions)
|
GetNodeSpaceResp |
WikiService.Space.getNode(GetNodeSpaceReq req,
RequestOptions reqOptions)
|
ListSpaceNodeResp |
WikiService.SpaceNode.list(ListSpaceNodeReq req,
RequestOptions reqOptions)
获取子节点列表,此接口用于分页获取Wiki节点的子节点列表。
|
ListSpaceResp |
WikiService.Space.list(ListSpaceReq req,
RequestOptions reqOptions)
获取知识空间列表,此接口用于获取有权限访问的知识空间列表。
|
MoveSpaceNodeResp |
WikiService.SpaceNode.move(MoveSpaceNodeReq req,
RequestOptions reqOptions)
移动节点,此方法用于在Wiki内移动节点,支持跨知识空间移动。
|
MoveDocsToWikiSpaceNodeResp |
WikiService.SpaceNode.moveDocsToWiki(MoveDocsToWikiSpaceNodeReq req,
RequestOptions reqOptions)
添加已有云文档至知识库,该接口允许添加已有云文档至知识库,并挂载在指定父页面下
### 移动操作 ###;移动后,文档将从“我的空间”或“共享空间”转移至“知识库”,并将从以下功能入口消失:;- 云空间主页:最近访问、快速访问;- 我的空间;- 共享空间;- 收藏;;### 权限变更 ###;移动后,文档会向所有可查看“页面树”的用户显示,默认继承父页面的权限设置。
|
UpdateSpaceSettingResp |
WikiService.SpaceSetting.update(UpdateSpaceSettingReq req,
RequestOptions reqOptions)
|
UpdateTitleSpaceNodeResp |
WikiService.SpaceNode.updateTitle(UpdateTitleSpaceNodeReq req,
RequestOptions reqOptions)
更新标题,此接口用于更新节点标题
此接口目前仅支持文档(doc)、新版文档(docx)和快捷方式。
|
Copyright © 2022. All rights reserved.
| | | |