API 列表
API 名称 | 说明 | 自建应用 | 商店应用 |
---|---|---|---|
模糊搜索词条POST/open-apis/baike/v1/entities/search | 传入关键词,与词条名、别名、释义等信息进行模糊匹配,返回搜到的词条信息。 | ||
---|---|---|---|
词条高亮POST/open-apis/baike/v1/entities/highlight | 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现百科词条智能高亮。 | ||
提取潜在的百科词条POST/open-apis/baike/v1/entities/extract | 提取文本中可能成为百科词条的词语,且不会过滤已经成为百科词条的词语。同时,会返回推荐的别名。 | ||
获取百科分类GET/open-apis/baike/v1/classifications | 获取企业百科当前分类。 企业百科目前为二级分类体系,每个词条可添加多个二级分类,但每个一级分类下只能添加一个分类。 | ||
上传图片POST/open-apis/baike/v1/files/upload | 百科词条图片资源上传。 | ||
下载图片GET/open-apis/baike/v1/files/:file_token/download | 通过 file_token 下载原图片。 | ||
飞书人事 | |||
批量查询员工请假记录GET/open-apis/corehr/v1/leaves/leave_request_history | 批量获取员工的请假记录数据 | ||
帐号 | |||
批量获取脱敏的用户登录信息POST/open-apis/passport/v1/sessions/query | 该接口用于查询用户的登录信息。 | ||
认证信息 | |||
获取认证信息GET/open-apis/verification/v1/verification | 获取企业主体名称、是否认证等信息。 | ||
个人设置 | |||
创建系统状态POST/open-apis/personal_settings/v1/system_statuses | 创建租户维度的系统状态。 | ||
删除系统状态DELETE/open-apis/personal_settings/v1/system_statuses/:system_status_id | 删除租户维度的系统状态。 | ||
修改系统状态PATCH/open-apis/personal_settings/v1/system_statuses/:system_status_id | 修改租户维度系统状态。 | ||
获取系统状态GET/open-apis/personal_settings/v1/system_statuses | 获取租户下所有系统状态。 | ||
批量开启系统状态POST/open-apis/personal_settings/v1/system_statuses/:system_status_id/batch_open | 批量开启用户系统状态可用。 | ||
批量关闭系统状态POST/open-apis/personal_settings/v1/system_statuses/:system_status_id/batch_close | 批量关闭用户系统状态可用。 | ||
历史版本 | |||
获取用户列表GET/open-apis/contact/v3/users | 基于部门ID获取部门下直属用户列表。常见问题答疑。 | ||
批量获取用户信息GET/open-apis/contact/v1/user/batch_get | 批量获取用户详细信息。 | ||
获取部门用户列表GET/open-apis/contact/v1/department/user/list | 获取部门用户列表。 | ||
获取部门用户详情GET/open-apis/contact/v1/department/user/detail/list | 获取部门用户详情信息。 | ||
新增用户POST/open-apis/contact/v1/user/add | 向通讯录中新增用户。 | ||
删除用户POST/open-apis/contact/v1/user/delete | 从通讯录中删除用户。 | ||
更新用户信息POST/open-apis/contact/v1/user/update | 更新通讯录中用户信息。 | ||
获取角色列表GET/open-apis/contact/v2/role/list | 获取企业的用户角色列表。 | ||
获取角色成员列表GET/open-apis/contact/v2/role/members | 获取角色下的用户列表。 | ||
使用手机号或邮箱获取用户 IDGET/open-apis/user/v1/batch_get_id | 根据用户邮箱或手机号查询用户 open_id 和 user_id,支持批量查询。 |
使用统一 ID 获取用户 IDGET/open-apis/user/v1/union_id/batch_get/list | 使用统一 ID 获取用户 ID信息。 | ||
---|---|---|---|
搜索用户GET/open-apis/search/v1/user | 以用户身份搜索其他用户的信息,无法搜索到外部企业或已离职的用户。 | ||
获取部门详情GET/open-apis/contact/v1/department/info/get | 获取部门详情信息。 | ||
获取部门信息列表GET/open-apis/contact/v3/departments | 该接口用于获取当前部门子部门列表。常见问题答疑。 | ||
获取子部门 ID 列表GET/open-apis/contact/v1/department/list | 获取子部门 ID 列表,只返回授权的部门列表。 企业根部门 ID 为 0,当参数指定的部门为根部门时,如果授权范围为全员,返回该企业的所有一级部门;否则返回管理员在设置通讯录授权范围时勾选的部门(不包含子部门)。指定获取特定部门(部门 ID 非 0)的部门列表时,需要具有该部门的通讯录授权,返回部门列表为该部门所有的子部门。 | ||
获取子部门列表GET/open-apis/contact/v1/department/simple/list | 获取当前部门子部门列表。 | ||
批量获取部门详情GET/open-apis/contact/v1/department/detail/batch_get | 批量获取部门详情,只返回权限范围内的部门。 | ||
新增部门POST/open-apis/contact/v1/department/add | 向通讯录中增加新的部门。 | ||
删除部门POST/open-apis/contact/v1/department/delete | 从通讯录中删除部门。 | ||
更新部门信息POST/open-apis/contact/v1/department/update | 更新通讯录中部门的信息。 | ||
批量新增部门POST/open-apis/contact/v2/department/batch_add | 向通讯录中批量新增多个部门。 | ||
批量新增用户POST/open-apis/contact/v2/user/batch_add | 向通讯录中批量新增多个用户。 | ||
查询批量任务执行状态GET/open-apis/contact/v2/task/get | 查询通讯录异步任务当前的执行状态以及执行结果。 | ||
获取企业自定义用户属性配置GET/open-apis/contact/v1/tenant/custom_attr/get | 获取企业配置的自定义用户属性。 | ||
获取通讯录授权范围GET/open-apis/contact/v1/scope/get | 获取应用被授权可访问的通讯录范围,包括可访问的部门列表及用户列表。授权范围为全员时,返回的部门列表为该企业所有的一级部门;否则返回的部门为管理员在设置授权范围时勾选的部门(不包含勾选部门的子部门)。 | ||
发送消息卡片POST/open-apis/message/v4/send/ | 给指定用户或者会话发送消息,其中会话包括私聊会话和群会话。 | ||
发送文本消息POST/open-apis/message/v4/send/ | 给指定用户或者会话发送消息,其中会话包括私聊会话和群会话。 | ||
发送图片消息POST/open-apis/message/v4/send/ | 给指定用户或者会话发送消息,其中会话包括私聊会话和群会话。 | ||
发送富文本消息POST/open-apis/message/v4/send/ | 给指定用户或者会话发送消息,其中会话包括私聊会话和群会话。 | ||
发送群名片POST/open-apis/message/v4/send/ | 给指定用户或者会话发送消息,其中会话包括私聊会话和群会话。 | ||
上传图片POST/open-apis/image/v4/put/ | 上传图片,获取图片的 image_key。 | ||
拉用户进群POST/open-apis/chat/v4/chatter/add/ | 机器人拉用户进群。 | ||
获取面试记录列表GET/open-apis/hire/v1/applications/:application_id/interviews | 根据投递 ID 获取面试记录列表 | ||
获取 Offer 申请表详细信息GET/open-apis/hire/v1/offer_schemas/:offer_schema_id | 根据 Offer 申请表 ID,获取 Offer 申请表的详细信息 |
修改于 2023-01-11 07:02:55