飞书 API
  1. 应用权限
飞书 API
  • 应用权限
    • 简介
    • 权限列表
  • API 调用服务指南
    • API 列表
    • 通用参数
    • 频控策略
    • 通用错误码
    • 调用流程
      • 流程概述
      • 申请权限
      • 获取访问凭证
      • 设置 IP 白名单
      • 调用 API
  • 事件订阅指南
    • 概述
    • 事件列表
    • 订阅流程
      • 配置 Encrypt Key
      • 修改 Verification Token
      • 配置请求地址
      • 添加事件
      • 申请权限
      • 接收并处理事件
  • 服务端 SDK
    • 服务端 SDK
  • 鉴权管理
    • 访问凭证
      • 自建应用获取 tenant_access_token
      • 自建应用获取 app_access_token
      • 商店应用获取 app_access_token
      • 商店应用获取 tenant_access_token
      • 获取 user_access_token
      • 刷新 user_access_token
      • 重新获取 app_ticket
    • 登录态管理
      • 资源介绍
      • 获取登录预授权码
      • 获取登录用户信息
      • 批量获取脱敏的用户登录信息
  • 事件管理
    • 获取事件出口 IP
      GET
  • 通讯录
    • 概述
    • 常见问题
    • 权限范围
      • 资源介绍
      • 权限范围详解
      • 事件
        • 通讯录权限范围变更
      • 获取通讯录授权范围
    • 用户
      • 资源介绍
      • 国家/地区 Code 参照表
      • 事件
        • 员工信息被修改
        • 员工离职
        • 员工入职
      • 创建用户
      • 删除用户
      • 修改用户部分信息
      • 获取单个用户信息
      • 更新用户所有信息
      • 获取单个用户信息
      • 获取部门直属用户列表
      • 通过手机号或邮箱获取用户 ID
    • 用户组
      • 资源介绍
      • 创建用户组
      • 删除用户组
      • 更新用户组
      • 查询指定用户组
      • 查询用户组列表
      • 查询用户所属用户组
    • 自定义用户字段
      • 资源介绍
      • 事件
        • 成员字段变更
      • 获取企业自定义用户字段
    • 人员类型
      • 资源介绍
      • 事件
        • 新建人员类型
        • 启用人员类型
        • 停用人员类型
        • 删除人员类型
        • 修改人员类型名称
      • 新增人员类型
      • 删除人员类型
      • 更新人员类型
      • 查询人员类型
    • 部门
      • 资源介绍
      • 事件
        • 创建部门
        • 删除部门
        • 修改部门信息
      • 创建部门
      • 删除部门
      • 修改部门部分信息
      • 获取单个部门信息
      • 更新部门所有信息
      • 部门群转为普通群
      • 获取单个部门信息
      • 获取子部门列表
      • 获取父部门信息
      • 搜索部门
    • 单位
      • 资源介绍
      • 创建单位
      • 删除单位
      • 修改单位信息
      • 建立部门与单位的绑定关系
      • 解除部门与单位的绑定关系
      • 获取单位绑定的部门列表
      • 获取单位信息
      • 获取单位列表
    • 用户组成员
      • 资源介绍
      • 添加用户组成员
      • 批量添加用户组成员
      • 移除用户组成员
      • 查询用户组成员列表
      • 批量移除用户组成员
  • 消息
    • 概述
    • 常见问题
    • 消息内容介绍
      • 发送消息内容
      • 接收消息内容
    • 消息管理
      • 资源介绍
      • 事件
        • 接收消息
        • 消息已读
        • 撤回消息
      • 发送消息
      • 回复消息
      • 撤回消息
      • 查询消息已读信息
      • 获取会话历史消息
      • 获取消息中的资源文件
      • 获取指定消息的内容
    • 消息加急
      • 发送应用内加急
      • 发送短信加急
      • 发送电话加急
    • 批量消息
      • 批量发送消息
      • 批量撤回消息
      • 查询批量消息推送和阅读人数
      • 查询批量消息整体进度
    • 图片信息
      • 上传图片
      • 下载图片
    • 文件信息
      • 上传文件
      • 下载文件
    • 消息-消息卡片
      • 资源介绍
      • 更新应用发送的消息卡片
      • 延时更新消息卡片
      • 发送仅特定人可见的消息卡片
      • 删除仅特定人可见的消息卡片
    • 表情回复
      • 资源介绍
      • 表情文案说明
      • 事件
        • 新增消息表情回复
        • 删除消息表情回复
      • 添加消息表情回复
      • 删除消息表情回复
      • 获取消息表情回复
    • Pin
      • Pin 消息
      • 移除 Pin 消息
      • 获取群内 Pin 消息
  • 群组
    • 概述
    • 群组管理
      • 资源介绍
      • 群 ID 说明
      • 事件
        • 群解散
        • 群配置修改
      • 创建群
      • 解散群
      • 更新群信息
      • 更新群发言权限
      • 获取群信息
      • 更新群置顶
      • 撤销群置顶
      • 获取用户或机器人所在的群列表
      • 搜索对用户或机器人可见的群列表
      • 获取群成员发言权限
      • 获取群分享链接
    • 群成员
      • 资源介绍
      • 事件
        • 用户进群
        • 用户出群
        • 撤销拉用户进群
        • 机器人进群
        • 机器人被移出群
        • 用户和机器人的会话首次被创建
      • 指定群管理员
      • 删除群管理员
      • 将用户或机器人拉入群聊
      • 用户或机器人主动加入群聊
      • 将用户或机器人移出群聊
      • 获取群成员列表
      • 判断用户或机器人是否在群里
    • 群公告
      • 资源介绍
      • 更新群公告信息
      • 获取群公告信息
    • 会话标签页
      • 添加会话标签页
      • 删除会话标签页
      • 更新会话标签页
      • 会话标签页排序
      • 拉取会话标签页
    • 群菜单
      • 资源介绍
      • 添加群菜单
      • 删除群菜单。
      • 修改群菜单元信息
      • 排序群菜单
      • 获取群菜单
  • 云文档
    • 概述
    • 常见问题
    • 云空间
      • 云空间概述
      • 云空间常见问题
      • 文件夹
        • 获取我的空间(root folder)元信息
        • 获取文件夹下的清单
        • 获取文件夹元信息
        • 新建文件夹
        • 移动文件
        • 删除文件
      • 文件
        • 异步任务状态
          • 查询异步任务状态
        • 获取文档元数据
        • 新建在线文档
        • 复制文件
        • 移动文件
        • 删除文件
        • 获取文件统计信息
      • 素材
        • 素材概述
        • 分片上传素材
          • 概述
          • 分片上传素材(预上传)
          • 分片上传素材(上传分片)
          • 分片上传素材(完成上传)
        • 上传素材
        • 下载素材
        • 获取素材临时下载链接
      • 事件
        • 列表
          • 多维表格字段变更
          • 多维表格记录变更
          • 文件标题变更
          • 文件已读
          • 文件编辑
          • 文件协作者添加
          • 文件协作者移除
          • 文件删除到回收站
          • 文件彻底删除
        • 订阅云文档事件
      • 搜索
        • 文档搜素
      • 上传
        • 分片上传文件
          • 概述
          • 分片上传文件(预上传)
          • 分片上传文件(上传分片)
          • 分片上传文件(完成上传)
        • 上传文件
      • 下载
        • 下载文件
      • 导入
        • 概述
        • 创建导入任务
        • 查询导入结果
      • 导出
        • 导出文件指南
        • 创建导出任务
        • 查询导出任务结果
        • 下载导出文件
      • 文档版本
        • 概述
        • 创建文档版本
        • 删除文档版本
        • 获取文档版本
        • 获取文档版本列表
    • 权限
      • 权限概述
      • 常见问题
      • 成员
        • 转移所有者
        • 判断当前用户是否有某权限
        • 获取协作者列表(新版本)
        • 获取协作者列表
        • 增加协作者权限
        • 更新协作者权限
        • 移除协作者权限
      • 设置
        • 获取云文档权限设置
        • 更新云文档权限设置
    • 评论
      • 分页获取文档评论
      • 添加评论
      • 获取评论
      • 更新回复
      • 删除回复
      • 解决/恢复 评论
    • 文档
      • 新版文档接入指南
      • 新版文档
        • 概述
        • 数据结构
        • 接入指南
        • 文档
          • 获取文档基本信息
          • 获取文档纯文本内容
          • 获取文档所有块
          • 创建文档
        • 块
          • 获取块
          • 创建块
          • 更新块
          • 批量更新块
          • 删除块
          • 获取所有子块
      • 旧版文档
        • 概述
        • 准备接入文档 API
        • 文档数据结构概述
        • 文档数据结构参考
        • 文档
          • 创建文档
        • 内容
          • 获取文档富文本内容
          • 获取文档文本内容
          • 编辑文档内容
    • 权限
      • 权限成员
        • 增加权限
        • 判断协作者是否有某权限
      • 权限设置
        • 获取文档公共设置V2
        • 更新文档公共设置
      • 转移拥有者
    • 电子表格
      • 概述
      • 电子表格常见问题
      • 支持写入的数据类型
      • 支持数字格式类型
      • 表格
        • 修改电子表格属性
        • 获取电子表格信息
        • 创建表格
      • 工作表
        • 查询工作表
        • 获取工作表
        • 操作工作表
        • 更新工作表属性
      • 行列
        • 增加行列
        • 插入行列
        • 更新行列
        • 移动行列
        • 删除行列
      • 单元格
        • 追加数据
        • 插入数据
        • 读取单个范围
        • 读取多个范围
        • 向单个范围写入数据
        • 向多个范围写入数据
        • 设置单元格样式
        • 批量设置单元格样式
        • 写入图片
        • 合并单元格
        • 拆分单元格
        • 查找单元格
        • 替换单元格
      • 筛选
        • 筛选指南
        • 获取筛选
        • 创建筛选
        • 更新筛选
        • 删除筛选
      • 筛选视图
        • 筛选条件
          • 筛选视图的筛选条件指南
          • 创建筛选条件
          • 查询筛选条件
          • 更新筛选条件
          • 删除筛选条件
          • 获取筛选条件
        • 更新筛选视图
        • 获取筛选视图
        • 查询筛选视图
        • 创建筛选视图
        • 删除筛选视图
      • 表格操作
        • 创建表格
        • 获取表格元数据
        • 更新表格属性
        • 操作工作表
        • 更新工作表属性
      • 保护范围
        • 增加保护范围
        • 获取保护范围
        • 修改保护范围
        • 删除保护范围
      • 数据校验
        • 概述
        • 设置下拉列表
        • 删除下拉列表设置
        • 更新下拉列表设置
        • 查询下拉列表设置
      • 条件格式
        • 条件格式指南
        • 创建条件格式
        • 获取条件格式
        • 更新条件格式
        • 删除条件格式
      • 浮动图片
        • 浮动图片指南
        • 创建浮动图片
        • 获取浮动图片
        • 查询浮动图片
        • 更新浮动图片
        • 删除浮动图片
    • API参考
      • 创建文档
      • 编辑文档内容
      • 历史文档(不建议)
        • 获取文档中的电子表格的元数据
      • 获取文档元信息
    • 多维表格
      • 概述
      • 接入指南
      • 数据结构
      • 多维表格
        • 获取多维表格元数据
        • 更新多维表格元数据
      • 数据表
        • 更新数据表
        • 列出数据表
        • 新增数据表
        • 新增多个数据表
        • 删除一个数据表
        • 删除多个数据表
      • 仪表盘
        • 复制仪表盘
        • 列出仪表盘
      • 视图
        • 更新视图
        • 检索视图
        • 列出视图
        • 新增视图
        • 删除视图
      • 表单
        • 更新表单元数据
        • 获取表单元数据
        • 更新表单问题
        • 列出表单问题
      • 记录
        • 记录筛选开发指南
        • 检索记录
        • 列出记录
        • 新增记录
        • 更新记录
        • 删除记录
        • 新增多条记录
        • 更新多条记录
        • 删除多条记录
      • 字段
        • 字段编辑指南
        • 附件字段说明
        • 列出字段
        • 新增字段
        • 更新字段
        • 删除字段
      • 高级权限
        • 概述
        • 自定义角色
          • 列出自定义角色
          • 新增自定义角色
          • 删除自定义角色
          • 更新自定义角色
        • 协作者
          • 批量删除协作者
          • 批量新增协作者
          • 列出协作者
          • 新增协作者
          • 删除协作者
    • 知识库
      • 概述
      • 常见问题
      • 知识空间
        • 创建知识空间
        • 获取知识空间列表
        • 获取知识空间信息
      • 空间成员
        • 删除知识空间成员
        • 添加知识空间成员
      • 空间设置
        • 更新知识空间设置
      • 节点
        • 创建知识空间节点
        • 获取知识空间节点信息
        • 获取知识空间子节点列表
        • 移动知识空间节点
        • 更新知识空间节点标题
        • 创建知识空间节点副本
      • 任务
        • 获取任务结果
      • 云文档
        • 移动云空间文档至知识空间
        • 获取任务结果
      • 搜索 Wiki
        • 搜索 Wiki
    • 云文档助手
      • 订阅
        • 获取订阅状态
        • 创建订阅
        • 更新订阅状态
  • 日历
    • 概述
    • 常见问题
    • 日历管理
      • 资源介绍
      • 事件
        • 日历变更
      • 获取主日历
      • 创建共享日历
      • 删除共享日历
      • 查询主日历信息
      • 查询主日历忙闲信息
      • 查询日历信息
      • 查询日历列表
      • 更新日历
      • 搜索日历
      • 订阅日历
      • 取消订阅日历
      • 订阅日历变更事件
      • 取消订阅日历变更事件
    • 日历访问控制
      • 资源介绍
      • 事件
        • 创建 ACL
        • 删除 ACL
      • 取消订阅日历访问控制变更事件
      • 创建访问控制
      • 删除访问控制
      • 获取访问控制列表
      • 订阅日历访问控制变更事件
    • 日程管理
      • 资源介绍
      • 事件
        • 日程变更
      • 创建日程
      • 删除日程
      • 更新日程
      • 获取日程
      • 获取日程列表
      • 搜索日程
      • 订阅日程变更事件
      • 取消订阅日程变更事件
    • 请假日程管理
      • 资源介绍
      • 创建请假日程
      • 删除请假日程
    • 会议室日程管理
      • 事件
        • 会议室状态信息变更
        • 第三方会议室日程变动
      • 查询会议室日程主题和会议详情
      • 查询会议室忙闲
      • 回复会议室日程实例
    • 日程参与人
      • 资源介绍
      • 获取日程参与群成员列表
      • 添加日程参与人
      • 获取日程参与人列表
      • 删除日程参与人
    • 同步到本地日历
      • 生成 CalDAV 配置
    • 同步 Exchange 日历信息
      • 资源介绍
      • 将 Exchange 账户绑定到飞书账户
      • 解除 Exchange 账户绑定
      • 查询 Exchange 账户的绑定状态
  • 视频会议
    • 视频会议概述
    • 预约
      • 资源介绍
      • 预约会议
      • 删除预约
      • 更新预约
      • 获取预约
      • 获取活跃会议
    • 会议
      • 资源介绍
      • 事件
        • 企业会议开始
        • 企业会议结束
        • 会议开始
        • 会议结束
        • 加入会议
        • 离开会议
        • 开始录制
        • 停止录制
        • 录制完成
        • 屏幕共享开始
        • 屏幕共享结束
      • 邀请参会人
      • 移除参会人
      • 设置主持人
      • 结束会议
      • 获取会议详情
      • 获取与会议号相关联的会议列表
    • 录制
      • 资源介绍
      • 开始录制
      • 停止录制
      • 获取录制文件
      • 授权录制文件
    • 会议报告
      • 资源介绍
      • 获取会议报告
      • 获取top用户列表
    • 导出
      • 资源介绍
      • 导出会议明细
      • 导出参会人明细
      • 导出参会人会议质量数据
      • 导出会议室预定数据
      • 查询导出任务结果
      • 下载导出文件
    • 会议室层级
      • 资源介绍
      • 创建会议室层级
      • 删除会议室层级
      • 更新会议室层级
      • 查询会议室层级详情
      • 批量查询会议室层级详情
      • 查询会议室层级列表
      • 搜索会议室层级
    • 会议室管理
      • 资源介绍
      • 事件
        • 创建会议室
        • 更新会议室
        • 删除会议室
      • 创建会议室
      • 删除会议室
      • 更新会议室
      • 查询会议室详情
      • 批量查询会议室详情
      • 查询会议室列表
      • 搜索会议室
    • 会议室配置
      • 资源介绍
      • 查询会议室配置
      • 设置会议室配置
      • 获取会议室预定范围
      • 更新会议室预定范围
  • 考勤打卡
    • 概述
    • 接入指南
    • 考勤班次
      • 按名称查询班次
      • 删除班次
      • 创建班次
      • 按 ID 查询班次
      • 查询所有班次
    • 考勤组管理
      • 创建或修改考勤组
      • 删除考勤组
      • 按 ID 查询考勤组
      • 按名称查询考勤组
      • 查询所有考勤组
    • 考勤排班
      • 查询班表信息
      • 创建或修改班表
    • 考勤统计
      • 功能介绍
      • 查询统计表头
      • 更新统计设置
      • 查询统计数据
      • 查询统计设置
    • 假勤审批
      • 获取用户审批通过数据
      • 通知审批状态更新
      • 写入审批结果
    • 考勤补卡
      • 获取可补卡时间
      • 获取补卡记录
      • 通知补卡审批发起
    • 打卡信息管理
      • 批量查询打卡流水
      • 查询打卡流水
      • 获取打卡结果
      • 导入打卡流水
    • 考勤用户管理
      • 事件
        • 用户打卡成功
        • 用户任务状态变更
      • 修改用户人脸识别信息
      • 批量查询用户人脸识别信息
      • 上传用户人脸识别照片
      • 下载用户人脸识别照片
  • 审批
    • 概述
    • 常见问题
    • 接入指南
      • 审批接入指南
      • 原生审批接入指南
      • 商店应用开发指南
      • 三方审批接入
        • 三方审批接入指南
        • 三方审批接入准备
        • 审批官方连接器
    • 原生审批定义
      • 资源介绍
      • 关联外部选项说明
      • 创建审批定义
      • 查看指定审批定义
      • 查询审批定义列表
    • 原生审批实例
      • 资源介绍
      • 创建审批实例
      • 撤回审批实例
      • 抄送审批实例
      • 预览审批流程
      • 批量获取审批实例ID
      • 获取单个审批实例详情
    • 原生审批任务
      • 资源介绍
      • 同意审批任务
      • 拒绝审批任务
      • 转交审批任务
      • 退回审批任务
      • 审批任务加签
      • 重新提交审批任务
    • 原生审批文件
      • 资源介绍
      • 上传文件
    • 原生审批评论
      • 资源介绍
      • 创建评论
      • 删除评论
      • 清空评论
      • 获取评论
    • 三方审批定义
      • 资源介绍
      • 三方快捷审批回调
      • 创建三方审批定义
    • 三方审批实例
      • 资源介绍
      • 同步三方审批实例
      • 校验三方审批实例
    • 三方审批任务
      • 资源介绍
      • 获取三方审批任务状态
    • 审批 Bot 消息
      • 发送审批 Bot 消息
      • 更新审批 Bot 消息
    • 审批查询
      • 查询实例列表
      • 查询抄送列表
      • 查询任务列表
      • 查询用户的任务列表
      • 查询审批 ID(专用)
    • 审批事件
      • 功能介绍
      • 订阅步骤
      • 常见问题
      • 事件接口
        • 订阅审批事件
        • 取消订阅审批事件
      • 公用事件
        • 审批抄送状态变更
        • 审批任务状态变更
        • 审批实例状态变更
        • 审批定义更新
      • 特殊事件
        • 出差审批
        • 外出审批
        • 补卡审批
        • 换班审批
        • 加班审批
        • 请假审批
  • 服务台
    • 概述
    • 接入指南
    • 客服
      • 客服功能管理
        • 更新客服信息
        • 获取客服邮箱
      • 客服工作日程
        • 创建客服工作日程
        • 删除客服工作日程
        • 更新客服工作日程
        • 查询指定客服工作日程
        • 查询全部客服工作日程
      • 客服技能
        • 创建客服技能
        • 删除客服技能
        • 更新客服技能
        • 查询指定客服技能
        • 查询全部客服技能
      • 客服技能规则
        • 客服技能及运算符
        • 获取客服技能列表
    • 工单
      • 事件
        • 创建工单
        • 工单状态变更
      • 工单管理
        • 创建服务台对话
        • 更新工单详情
        • 查询指定工单详情
        • 获取服务台工单内消息图像
        • 回复用户提问结果至工单
        • 查询全部工单详情
        • 获取服务台自定义字段
      • 工单消息
        • 工单消息内容
        • 发送工单消息
        • 获取工单消息详情
        • 服务台机器人向工单绑定的群内发送消息
      • 工单自定义字段
        • 概述
        • 创建工单自定义字段
        • 删除工单自定义字段
        • 更新工单自定义字段
        • 获取指定工单自定义字段
        • 获取全部工单自定义字段
      • 工单自定义字段
    • 知识库
      • 知识库管理
        • 富文本
        • 创建知识库
        • 获取知识库详情
        • 修改知识库
        • 删除知识库
        • 获取全部知识库详情
        • 获取知识库图像
        • 搜索知识库
      • 知识库分类
        • 创建知识库分类
        • 获取知识库分类
        • 更新知识库分类详情
        • 删除知识库分类详情
        • 获取全部知识库分类
    • 推送中心
      • 事件
        • 推送审核通知事件
      • 创建推送
      • 更新推送
      • 查询推送
      • 预览推送
      • 提交审核
      • 取消审核
      • 执行推送
      • 取消推送
    • 事件订阅
      • 订阅服务台事件
      • 取消订阅服务台事件
  • 任务
    • 任务概述
    • Markdown 模块
    • 任务字段补充说明
    • 任务管理
      • 功能介绍
      • 事件
        • 任务信息变更(租户维度)
        • 任务信息变更
      • 创建任务
      • 删除任务
      • 更新任务
      • 完成任务
      • 取消完成任务
      • 查询指定任务
      • 查询所有任务
    • 提醒
      • 功能介绍
      • 新增提醒时间
      • 删除提醒时间
      • 查询提醒时间列表
    • 评论
      • 概述
      • 事件
        • 任务评论信息变更
      • 获取评论列表
      • 创建评论
      • 删除评论
      • 更新评论
      • 获取评论详情
    • 关注人
      • 功能介绍
      • 批量删除关注人
      • 新增关注者
      • 删除指定关注人
      • 获取关注者列表
    • 执行者
      • 功能介绍
      • 批量删除执行者
      • 新增执行者
      • 删除指定执行者
      • 获取执行者列表
  • 邮箱
    • 邮件组
      • 邮件组管理
        • 创建邮件组
        • 删除邮件组
        • 修改邮件组部分信息
        • 修改邮件组全部信息
        • 查询指定邮件组
        • 批量获取邮件组
      • 邮件组成员
        • 创建邮件组成员
        • 删除邮件组成员
        • 查询指定邮件组成员
        • 获取所有邮件组成员
        • 批量创建邮件组成员
        • 批量删除邮件组成员
      • 邮件组别名
        • 创建邮件组别名
        • 删除邮件组别名
        • 获取邮件组所有别名
      • 邮件组权限成员
        • 创建邮件组权限成员
        • 删除邮件组权限成员
        • 获取邮件组权限成员
        • 批量获取邮件组权限成员
        • 批量创建邮件组权限成员
        • 批量删除邮件组权限成员
    • 公共邮箱
      • 公共邮箱管理
        • 创建公共邮箱
        • 删除公共邮箱
        • 修改公共邮箱
        • 修改公共邮箱全部信息
        • 查询所有公共邮箱
        • 查询指定公共邮箱
      • 公共邮箱成员
        • 添加公共邮箱成员
        • 删除公共邮箱成员
        • 删除公共邮箱所有成员
        • 获取公共邮箱成员信息
        • 查询所有公共邮箱成员信息
        • 批量添加公共邮箱成员
        • 批量删除公共邮箱成员
      • 公共邮箱别名
        • 创建公共邮箱别名
        • 删除公共邮箱别名
        • 查询公共邮箱的所有别名
    • 用户邮箱
      • 从回收站删除用户邮箱地址
      • 创建用户邮箱别名
      • 删除用户邮箱别名
      • 获取用户邮箱所有别名
    • 邮箱地址
      • 查询邮箱地址状态
  • 应用信息
    • 应用管理
      • 校验应用管理员
      • 获取应用管理员管理范围
      • 获取应用在企业内的可用范围
      • 获取用户可用的应用
      • 获取企业安装的应用
      • 更新应用可用范围
      • 查询应用管理员列表
    • 应用商店
      • 查询用户是否在应用开通范围
      • 查询租户购买的付费方案
      • 查询订单详情
    • 应用
      • 获取应用版本列表
      • 查看待审核的应用列表
      • 获取应用信息
      • 获取应用版本信息
      • 更新应用审核状态
      • 更新应用分组信息
    • 应用使用情况
      • 获取应用使用概览
    • 应用反馈
      • 更新应用反馈
      • 获取应用反馈列表
    • 事件
      • 新增应用反馈
      • 反馈更新
      • 应用创建
      • 首次启用应用
      • 应用停启用
      • 应用商店应用购买
      • app_ticket 事件
      • 应用卸载
      • 应用可用性范围增加
      • 申请发布应用
      • 撤回应用发布申请
      • 未命名文档
  • 企业信息
    • 获取企业信息
  • 认证信息
    • 获取认证信息
  • 个人设置
    • 系统统计
      • 功能介绍
      • 创建系统状态
      • 删除系统状态
      • 修改系统状态
      • 获取系统状态
      • 批量开启系统状态
      • 批量关闭系统状态
  • 搜索
    • 概述
    • 接入指南
    • 常见问题
    • 数据源
      • 创建数据源
      • 删除数据源
      • 修改数据源
      • 获取数据源
      • 批量获取所有的数据源
    • 数据项
      • 批量为数据项创建索引
      • 为指定数据项创建索引
      • 获取数据项
      • 删除数据项
    • 数据范式
      • 创建数据范式
      • 删除数据范式
      • 修改数据范式
      • 获取数据范式
  • AI 能力
    • 光学字符识别
      • 识别图片中的文字
    • 语音识别
      • 识别语音文件 (ASR)
      • 识别流式语音 (ASR)
    • 机器翻译
      • 识别文本语种
      • 翻译文本
  • 管理后台
    • 登录密码管理
      • 重置用户的企业邮箱密码
    • 数据报表管理
      • 功能介绍
      • 获取部门维度的用户活跃和功能使用数据
      • 获取用户维度的用户活跃和功能使用数据
    • 企业勋章
      • 功能介绍
      • 勋章管理
        • 创建勋章
        • 修改勋章信息
        • 上传勋章图片
        • 获取勋章列表
        • 获取勋章详情
      • 勋章授予名单
        • 创建授予名单
        • 删除授予名单
        • 修改授予名单
        • 获取授予名单列表
        • 获取授予名单详情
  • 飞书人事(标准版)
    • 接入指南
    • 批量获取员工花名册信息
    • 下载人员的附件
  • 飞书人事(企业版)
    • 休假管理
      • 批量查询员工请假记录
  • 招聘
    • 概述
    • 错误码
    • 招聘相关配置
      • 职位
        • 新建职位
        • 更新职位
        • 更新职位设置
        • 获取职位设置
        • 获取职位信息
        • 获取职位上的招聘人员信息
      • 流程
        • 获取招聘流程信息
    • 获取候选人
      • 内推
        • 获取内推信息
    • 候选人管理
      • 人才
        • 通过手机号或邮箱获取人才 ID
        • 获取人才信息
      • 投递流程
        • 投递管理
          • 创建投递
          • 终止投递
          • 获取投递信息
          • 获取投递列表
        • Offer
          • 获取 Offer 信息
        • 入职
          • 更新 e-HR 导入任务结果
          • 操作候选人入职
          • 更新入职状态
          • 通过投递 ID 获取入职信息
          • 通过员工 ID 获取入职信息
      • 备注
        • 创建备注
        • 更新备注
        • 获取备注
        • 获取备注列表
      • 简历来源
        • 获取简历来源列表
    • 附件
      • 获取附件信息
      • 获取附件预览信息
  • OKR
    • 概述
    • OKR周期
      • 获取OKR周期列表
    • OKR 内容
      • 获取用户的 OKR 列表
      • 批量获取OKR
    • 用户OKR
      • 获取用户的OKR列表
    • OKR 进展记录
      • 创建 OKR 进展记录
      • 删除 OKR 进展记录
      • 更新 OKR 进展记录
      • 获取 OKR 进展记录
      • 上传进展记录图片
    • 指标管理
      • 获取指标库
      • 获取指标表
      • 更新指标项
      • 批量更新指标项
      • 获取指标项
  • 实名认证
    • 录入身份信息
    • 上传人脸基准图片
    • 裁剪人脸图片
    • 查询人脸认证结果
  • 智能门禁
    • 概述
    • 用户管理
      • 事件
        • 用户变更
      • 获取单个用户信息
      • 获取用户列表
      • 修改用户部分信息
      • 上传人脸图片
      • 下载人脸图片
    • 门禁设备
      • 获取设备列表
    • 人脸图片
      • 概述
  • 企业百科
    • 概述
    • 草稿
      • 创建草稿
      • 更新草稿
    • 词条
      • 创建免审词条
      • 更新免审词条
      • 提取潜在的百科词条
      • 获取词条详情
      • 获取词条列表
      • 精准搜索词条
      • 模糊搜索词条
      • 词条高亮
    • 分类
      • 获取百科分类
    • 图片管理
      • 上传图片
      • 下载图片
  • 妙记
    • 获取妙计统计数据
      • 获取妙记统计数据
    • 妙记信息
      • 获取妙记信息
  • 工作台
    • 我的常用推荐规则
      • 获取当前设置的推荐规则列表
  • 企业
    • 获取企业信息
  1. 应用权限

权限列表

关于应用权限的概念介绍及开通指南,请参见文档:如何开通权限
业务范围: 不限
权限等级: 不限
支持的应用类型: 不限
权限名称权限说明自建应用商店应用关联 API/事件
事件订阅
获取事件的出口 IP普通event:ip_list允许应用获取事件推送的固定出口 IP。企业可以将获取到的事件出口 IP 配置到企业防火墙中,提升网络安全性。[API] 获取事件出口 IP
通讯录
更新通讯录高级contact:contact获得以下接口权限: 1. 更新用户相关能力:包括创建用户、修改用户部分信息、修改用户所有信息、删除用户 2. 更新部门相关能力:包括创建部门、修改部分部门信息、修改部门所有信息、删除部门 3. 更新人员类型相关能力:包括新增、更新、删除人员类型 注:调用接口时,部分字段可能需要额外权限,具体以文档为准。[API] 批量新增部门[API] 新增用户[API] 删除用户查看全部
以应用身份读取通讯录普通contact:contact:readonly_as_app以 tenant_access_token 身份获得读取通讯录的权限,包括: 1. 查询单个用户、查询部门用户列表、查询用户变更事件 2. 查询单个部门、查询部门列表、查询父部门路径、查询部门变更事件 3. 查询企业自定义字段 4. 查询通讯录权限范围变更事件 注: 1. 可查询的人员、部门数据范围取决于应用被授予的通讯录权限范围 2. 部分敏感字段可能需要额外权限,具体以文档为准[API] 获取通讯录授权范围[API] 批量获取用户信息[API] 获取子部门列表查看全部
获取部门基础信息普通contact:department.base:readonly获取部门信息时,返回部门的基础信息,包括: id:部门 ID name:部门名称 chat_id:部门群 ID status:部门状态 i18n_name:部门国际化名称[API] 获取部门详情[API] 批量获取部门详情[API] 创建部门查看全部
获取部门组织架构信息高级contact:department.organize:readonly访问部门信息时,返回部门的组织架构信息,包括: parent_department_id:父部门 ID leader_user_id:部门负责人 ID member_count:部门直属成员数 order:部门在同级部门中的排序[API] 获取部门详情[API] 获取子部门列表[API] 获取企业自定义用户属性配置查看全部
更新用户组信息高级contact:group获得用户组更新权限,可创建用户组、更新用户组、删除用户组、添加用户组成员、移除用户组成员。[API] 更新用户组[API] 添加用户组成员[API] 创建用户组查看全部
获取用户组信息高级contact:group:readonly获得用户组读取权限,可查询单个用户组、查询企业用户组列表、查询用户组成员列表。[API] 查询指定用户组[API] 查询用户组列表[API] 查询用户组成员列表查看全部
获取角色权限高级contact:role:readonly获得角色查询权限,可获取组织的角色列表、获取角色下的成员列表。[API] 获取角色列表[API] 获取角色成员列表
更新单位信息高级contact:unit创建、删除、修改单位信息或修改单位和部门的绑定关系。 当应用具有这个权限后,能够创建、修改单位,删除单位信息,或修改部门与单位的绑定关系。[API] 创建单位[API] 修改单位信息[API] 删除单位查看全部
获取单位信息高级contact:unit:readonly获取单位信息或单位与部门的绑定关系。 当应用具有这个权限后,能够具有获取单位信息,获取单位与部门的绑定关系的权限。[API] 获取单位信息[API] 获取单位列表[API] 获取单位绑定的部门列表
获取用户基本信息普通contact:user.base:readonly获得获取用户基本信息权限,在调用获取用户信息相关接口时返回以下基础信息: name:用户名 en_name:用户英文名 avatar:用户头像[API] 批量获取用户信息[API] 获取部门用户详情[API] 获取部门用户列表查看全部
获取用户组织架构信息高级contact:user.department:readonly获得获取用户组织架构相关信息的权限,在调用获取用户信息相关接口时返回以下信息: department_ids:用户归属的部门 ID leader_user_id:用户的直属上级 ID orders:用户在其直属部门内的排序、用户多个部门间的排序[API] 批量获取用户信息[API] 获取部门用户详情[API] 修改用户部分信息查看全部
获取用户邮箱信息高级contact:user.email:readonly获得获取用户邮箱的权限,在调用获取用户信息相关接口时返回用户邮箱。[API] 批量获取用户信息[API] 使用手机号或邮箱获取用户 ID[API] 获取部门用户详情查看全部
获取用户受雇信息高级contact:user.employee:readonly获得获取用户受雇相关信息权限,在调用获取用户信息相关接口时可获取以下信息: employee_no:工号 employee_type:人员类型 status:状态 is_tenant_manager:是否为租户管理员 join_time:入职时间 country:国家/地区 city:城市 work_station:工位 custom_attrs:自定义字段 enterprise_email:企业邮箱 job_title:职务[API] 批量获取用户信息[API] 获取部门用户详情[API] 获取部门用户列表查看全部
获取用户 user ID高级contact:user.employee_id:readonly在调用获取用户信息相关接口时,返回 user_id/employee_id 字段。[API] 获取通讯录授权范围[API] 使用统一 ID 获取用户 ID[API] 查询应用管理员列表查看全部
获取用户性别高级contact:user.gender:readonly在调用获取用户信息相关接口时,返回用户性别信息。[API] 批量获取用户信息[API] 获取部门用户详情[API] 修改用户部分信息查看全部
通过手机号或邮箱获取用户 ID高级contact:user.id:readonly获得“使用手机号或邮箱获取用户 ID”接口的调用能力,可通过用户邮箱或手机号查询用户的 open_id 和 user_id。[API] 使用手机号或邮箱获取用户 ID[API] 通过手机号或邮箱获取用户 ID
获取用户手机号高级contact:user.phone:readonly在调用获取用户信息相关接口时,返回用户手机号。[API] 批量获取用户信息[API] 使用手机号或邮箱获取用户 ID[API] 获取部门用户详情查看全部
搜索用户高级contact:user:search获取搜索用户的接口调用能力,可以以用户身份搜索其所在组织内的其他用户。[API] 搜索用户
消息与群组
获取与更新群组信息普通im:chat可以获取或更新群组信息,包括:群名称、群描述、群头像、群主 ID、群模式及群类型、 进退群的系统消息可见性、群成员的发言权限、加群审批、Tenant Key。 当群设置了“仅群主和群管理员可更改群信息”时,应用需具备权限“im:chat:operate_as_owner”(更新应用所创建群的群信息)才可更新所有群信息。[API] 判断用户或机器人是否在群里[API] 获取群公告信息[API] 将用户或机器人移出群聊查看全部
读取群消息高级im:chat.group_info:readonly可以读取群信息,包括:群名称、群描述、群头像、群主 ID、群模式及群类型、 进退群的系统消息可见性、群成员的发言权限、加群审批、Tenant Key。[API] 获取用户所在的群列表[API] 获取群成员列表[API] 判断用户或机器人是否在群里查看全部
更新应用所创建群的群信息高级im:chat:operate_as_owner可更新应用所创建的群的群信息,包括:群名称、群描述、群头像、群主 ID、群模式及群类型、 进退群的系统消息可见性、群成员的发言权限、加群审批、Tenant Key。[API] 将用户或机器人移出群聊[API] 解散群[API] 更新群信息查看全部
获取群组信息普通im:chat:readonly可获取的群信息包括:群名称、群描述、群头像、群主 ID、群模式及群类型、 进退群的系统消息可见性、群成员的发言权限、加群审批、Tenant Key。[API] 判断用户或机器人是否在群里[API] 获取群公告信息[API] 获取群成员列表查看全部
获取与发送单聊、群组消息普通im:message允许机器人在以下范围收发消息,包括: 向应用可用性范围内的用户发送单聊消息 向机器人所在的群聊发送群消息 接收用户发送给机器人的所有单聊消息 注: 1. 如需获取机器人所在群的历史消息记录,需要额外申请权限“im:message.group_msg”(获取群组中所有消息) 2. 如需订阅用户在群聊中@机器人的消息事件,需要额外申请权限“im:message.group_at_msg”(获取用户在群组中@机器人的消息)[API] 查询消息已读信息[API] 获取指定消息的内容[API] 回复消息查看全部
获取用户在群组中@机器人的消息普通im:message.group_at_msg可接收机器人所在群聊中@机器人的消息。[事件] 接收消息
接收群聊中@机器人消息事件普通im:message.group_at_msg:readonly可接收机器人所在群聊中用户@机器人的消息。[事件] 接收消息
获取群组中所有消息高级im:message.group_msg可接收机器人所在群聊中所有的消息事件。关于事件类型,可前往开放平台查看开发文档“接收消息”。[事件] 接收消息
更新应用创建群聊的信息高级im:message.groups可更新应用所创建的群的群信息,包括:群名称、群描述、群头像、群主 ID、群模式及群类型、 进退群的系统消息可见性、群成员的发言权限、加群审批、Tenant Key。[API] 将用户或机器人移出群聊[API] 解散群[API] 更新群信息查看全部
获取用户发给机器人的单聊消息普通im:message.p2p_msg可接收单聊中的用户发送的消息。[事件] 接收消息
读取用户发给机器人的单聊消息普通im:message.p2p_msg:readonly可接收单聊中用户向机器人发送的消息。[事件] 接收消息
发送应用内加急消息高级im:message.urgent可在应用内发送加急消息,被加急的用户将会收到该消息在应用内的常驻强提醒。[API] 发送应用内加急
发送电话加急消息高级im:message.urgent:phone可通过电话的方式发送加急消息,被加急的用户将会收到提醒电话。通过接口产生的短信及电话加急将消耗企业的加急额度,请慎重调用。剩余额度信息可以在“飞书管理后台 > 费用中心 > 权益数据”中查询。[API] 发送电话加急
发送短信加急消息高级im:message.urgent:sms可通过短信的方式发送加急消息,被加急的用户将会收到提醒短信。通过接口产生的短信及电话加急将消耗企业的加急额度,请慎重调用。剩余额度信息可以在“飞书管理后台 > 费用中心 > 权益数据”中查询。[API] 发送短信加急
获取单聊、群组消息普通im:message:readonly可获取消息的信息,包括:消息 ID、根消息 ID、父消息 ID、消息类型、消息生成的时间戳、消息更新的时间戳、消息是否被撤回、是否被更新、消息所属的群、发送者、消息内容、被@的用户或机器人 ID 列表、合并转发消息中上一层级的消息 ID、消息中的资源类型。[API] 查询消息已读信息[API] 获取指定消息的内容[API] 获取会话历史消息查看全部
以应用的身份发消息普通im:message:send_as_bot可使用机器人通过单聊或群聊的方式向用户发消息,可发送文本、富文本、图片、文件、可交互的消息卡片、视频、音频、表情等消息。关于可发送消息的类型,可前往开放平台查看开发文档“发送消息 content 说明”。[API] 发送图片消息[API] 发送文本消息[API] 发送群名片查看全部
给一个或多个部门的成员批量发消息高级im:message:send_multi_depts可以以部门为单位,向一个或多个部门的成员批量发送消息。可发送文本、富文本、图片、文件、可交互的消息卡片、视频、音频、表情等消息。关于可发送消息的类型,可前往开放平台查看开发文档“发送消息 content 说明”。[API] 查询批量消息推送和阅读人数[API] 批量撤回消息[API] 查询批量消息整体进度
给多个用户批量发消息普通im:message:send_multi_users可向多个用户批量发送消息。可发送文本、富文本、图片、文件、可交互的消息卡片、视频、音频、表情等消息。关于可发送消息的类型,可前往开放平台查看开发文档“发送消息 content 说明”。[API] 查询批量消息推送和阅读人数[API] 批量撤回消息[API] 查询批量消息整体进度
获取与上传图片或文件资源 高级im:resource可通过上传图片接口上传 JPEG、PNG、WEBP 格式的图片,或通过上传文件接口上传视频、音频和常见的文件类型。[API] 上传图片[API] 上传文件
云文档
查看、评论、编辑和管理多维表格高级bitable:app允许应用在多维表格访问范围内进行以下操作: 增删改加行记录 增删改加列字段 增删改视图 增删改数据表 增删改多维表格的权限授予[API] 新增记录[API] 更新多条记录[API] 删除记录查看全部
查看、评论和导出多维表格高级bitable:app:readonly允许应用在多维表格访问范围内进行以下操作: 查看多维表格的数据表、视图、记录以及字段等信息的内容和配置 查看多维表格中每行记录的评论 导出多维表格中所有数据表的数据[API] 列出记录[API] 检索记录[API] 列出数据表查看全部
查看、评论、编辑和管理文档高级docs:doc允许应用在文档访问范围内进行以下操作: 增删改文档 增删改文档内容 增删改文档的权限授予 注:该权限包含“docs:doc:readonly”(查看、评论和导出文档) 的所有授权内容。[API] 复制文档[API] 获取协作者列表[API] 增加权限查看全部
查看、评论和导出文档高级docs:doc:readonly允许应用在文档访问范围内进行以下操作: 获取文档内容[API] 获取协作者列表[API] 获取云文档权限设置V2[API] 获取文档元信息查看全部
创建及编辑新版文档高级docx:document允许应用在文档访问范围内进行以下操作: 创建新版文档 增删改查新版文档内容 注:该权限包含"docx:document:readonly"(查看新版文档) 的所有授权内容。[API] 创建文档[API] 获取所有子块[API] 创建块查看全部
查看新版文档高级docx:document:readonly允许应用在文档访问范围内进行以下操作: 获取新版文档内容[API] 获取所有子块[API] 获取文档基本信息[API] 获取文档所有块查看全部
查看、评论、编辑和管理云空间中所有文件高级drive:drive允许应用在云空间文件访问范围内进行以下操作: 增删改文件 增删改文件内容 增删改文件的权限授予 注:该权限包含“drive:drive:readonly”(查看、评论和下载云文档所有文件) 的所有授权内容。[API] 导入表格[API] 写入图片[API] 查询导入结果查看全部
查看云空间中文件元数据高级drive:drive.metadata:readonly允许应用在云空间文件访问范围内进行以下操作: 查看文件的元数据,包括文件 token、类型、标题、所有者等[API] 获取云文档权限设置V2[API] 获取文件夹元信息[API] 获取文档元信息查看全部
搜索云文档高级drive:drive.search:readonly允许应用在云空间文件访问范围内进行以下操作: 查看符合搜索条件的所有云文档/文件列表,并可查看文件的元数据[API] 文档搜索
查看、评论和下载云空间中所有文件高级drive:drive:readonly允许应用在文档访问范围内进行以下操作: 获取文件内容 评论文件内容 保存文件内容[API] 获取协作者列表[API] 获取云文档权限设置V2[API] 获取文档元信息查看全部
查看、创建、删除文档版本高级drive:drive:version开通此权限后,应用可查看、创建和删除文档版本。[API] 获取文档版本列表[API] 获取文档版本[API] 删除文档版本查看全部
查看文档版本高级drive:drive:version:readonly开通此权限后,应用可查看文档版本。[API] 获取文档版本列表[API] 获取文档版本
导出云文档高级drive:export:readonly开通此权限后,应用可以导出云文档。[API] 创建导出任务[API] 查询导出任务结果[API] 下载导出文件
上传、下载文件到云空间高级drive:file允许应用在文档访问范围内进行以下操作: 上传文件到个人空间 保存文件内容[API] 获取协作者列表[API] 增加权限[API] 获取云文档权限设置V2查看全部
查看和下载云空间中的文件高级drive:file:readonly允许应用在文档访问范围内进行以下操作: 获取文件内容 保存文件内容[API] 获取协作者列表[API] 获取云文档权限设置V2[API] 判断协作者是否有某权限查看全部
查看、评论、编辑和管理电子表格高级sheets:spreadsheet允许应用在表格访问范围内进行以下操作: 增删改表格 增删改行列数据 增删改浮动图片、筛选视图 增删改表格的权限授予 注:该权限包含“sheets:spreadsheet:readonly”(查看、评论和导出表格) 的所有授权内容。[API] 导入表格[API] 写入图片[API] 查询导入结果查看全部
查看、评论和导出电子表格高级sheets:spreadsheet:readonly允许应用在表格访问范围内进行以下操作: 查看表格的数据表、视图、记录以及字段等信息的内容和配置 查看表格中每行记录的评论 导出表格中所有数据表的数据[API] 获取协作者列表[API] 获取云文档权限设置V2[API] 判断协作者是否有某权限查看全部
查看、编辑和管理知识库高级wiki:wiki允许应用在知识库访问范围内进行以下操作: 增删改知识库 增删改知识库节点 增删改知识库成员和节点权限 注:该权限包含“wiki:wiki:readonly”(查看知识库) 的所有授权内容。[API] 搜索 Wiki[API] 增加协作者权限[API] 更新云文档权限设置查看全部
查看知识库高级wiki:wiki:readonly允许应用在知识库访问范围内进行以下操作: 获取知识库和节点的信息[API] 搜索 Wiki[API] 获取知识空间子节点列表[API] 获取知识空间列表查看全部
日历
更新日历及日程信息高级calendar:calendar获得全部日历接口的授权,包括用户访问控制、日历、日程、日程参与人、日程参与人群成员、忙闲、请假、日历设置和 Exchange 绑定。[API] 获取日程[API] 订阅日程变更事件[API] 订阅日历查看全部
获取日历、日程及忙闲信息普通calendar📆readonly仅获得读取数据接口的授权,即所有与“获取”、“查询”相关的接口,包括:获取访问控制列表、获取日历、获取日历列表、获取日程、获取日程列表、获取日程参与人列表、获取日程参与人群成员列表、查询忙闲、查询 Exchange 绑定状态。[API] 获取日程[API] 订阅日程变更事件[API] 获取日程列表查看全部
创建或删除请假日程高级calendar:timeoff请假是一种特殊的日程,创建请假日程后,除了在日历内显示该日程外,还会在个人签名上展示请假信息。开发者可以调用这个接口,将用户的请假状态同步到日历和个人签名中。 删除请假日程则会同步删除个人签名中的请假状态。[API] 删除请假日程[API] 创建请假日程
视频会议
更新会议信息高级vc:meeting允许应用更新归属于自己的会议日程信息,具体操作包括: 设置日程到期时间 设置会议主题 设置会议权限 邀请参会人 移除参会人 设置主持人 结束会议[API] 设置主持人[API] 结束会议[API] 邀请参会人查看全部
获取所有视频会议信息高级vc:meeting.all_meeting:readonly获取所有视频会议信息[事件] 企业会议开始[事件] 企业会议结束
获取会议信息普通vc:meeting:readonly允许应用获取一段时间内的归属于自己的会议日程信息,包括: 会议主题、会议 ID、会议链接 会议创建时间、开始时间、结束时间 参会人数、参会人列表、参会人状态[API] 获取会议详情[API] 获取与会议号相关联的会议列表[事件] 录制开始查看全部
更新会议录制信息高级vc:record允许应用在会议结束后更新归属于自己的会议录制文件,并可将其授权给其他用户,具体操作包括: 更新授权对象和权限,可选择授权给用户、群组、租户和互联网[API] 授权录制文件[API] 停止录制[API] 开始录制
获取会议录制信息高级vc:record:readonly允许应用在会议结束后获取归属于自己的会议录制文件信息,包括: 录制文件链接 录制总时长[API] 获取录制文件
获取会议报告高级vc:report:readonly允许应用获取一段时间内的归属于组织的每日会议使用报告: 总会议数量、总会议时长、总参会人数 每日会议报告列表、日期、会议数量、会议时长、参会人数[API] 获取top用户列表[API] 获取会议报告
更新会议预约信息高级vc:reserve允许应用更新归属于自己的会议日程信息,包括: 日程到期时间 会议主题 会议权限配置[API] 更新预约[API] 预约会议[API] 删除预约
获取会议预约信息普通vc:reserve:readonly允许应用获取一段时间内的归属于自己的会议预约信息: 会议主题、会议 ID、会议链接 会议创建时间、开始时间、结束时间 参会人数、参会人列表、参会人状态[API] 获取预约[API] 获取活跃会议
会议室
管理会议室信息高级calendar:room允许应用对会议室信息进行以下操作: 查询指定建筑物的名称、描述、ID 和所有楼层列表 查询会议室名称、会议室 ID、所在建筑物名称、所在建筑物 ID、容纳人数、描述、所在楼层名称、是否可用、忙闲状态 创建、更新、删除建筑物,查询建筑物 ID 创建、更新、删除会议室,查询会议室 ID 预定第三方系统的会议室[API] 删除会议室[API] 创建会议室[API] 创建建筑物查看全部
获取会议室信息高级calendar:room:readonly允许应用在日程访问范围内进行以下操作: 获取会议室日程主题 获取建筑物列表 获取指定建筑下的会议室列表 获取国家/地区列表 获取城市列表 获取告警会议室列表(仅字节租户) 获取会议室告警信息(仅字节租户)[API] 获取建筑物列表[API] 获取城市列表[API] 查询建筑物详情查看全部
更新视频会议室信息普通vc:room允许应用设置飞书会议室的具体信息,包括: 飞书会议室背景图配置 飞书签到板背景图配置 飞书会议室数字标牌配置及素材管理[API] 设置会议室配置[API] 更新会议室预定范围[API] 批量查询会议室层级详情查看全部
获取视频会议室信息普通vc:room:readonly允许应用查询飞书会议室的具体信息,包括: 飞书会议室背景图 飞书签到板背景图 飞书会议室数字标牌及素材[API] 查询会议室配置[API] 获取会议室预定范围[API] 批量查询会议室层级详情查看全部
考勤打卡
写入打卡管理规则高级attendance:rule获得打卡管理规则写入权限,允许写入授权范围内的考勤组、班次、用户设置等数据。[API] 按 ID 查询考勤组[API] 创建或修改排班表[API] 修改用户人脸识别信息查看全部
导出打卡管理规则高级attendance:rule:readonly获得打卡管理规则读取权限,允许查询或导出授权范围内的考勤组、班次、用户设置等数据。[API] 按 ID 查询考勤组[API] 按 ID 查询班次[API] 批量查询用户人脸识别信息查看全部
写入打卡数据高级attendance:task获得打卡数据写入权限,允许写入授权范围内的打卡流水、用户排班、审批、统计设置等数据。[API] 导入打卡流水[API] 查询打卡流水[API] 查询统计数据查看全部
导出打卡数据高级attendance:task:readonly获得打卡数据读取权限,允许查询或导出授权范围内的打卡流水、用户排班、审批、统计设置等数据。[API] 查询打卡结果[API] 获取可补卡时间[API] 查询打卡流水查看全部
审批
查看、创建、更新、删除审批应用相关信息高级approval:approval开通此权限后,应用可以查看、创建、更新、删除审批应用相关的信息。[API] 审批任务加签[API] 预览审批流程[API] 创建审批定义查看全部
查询审批列表高级approval:approval.list:readonly通过此权限可调用“实例列表查询”、“任务列表查询” 、“抄送列表查询”接口。[API] 实例列表查询[API] 任务列表查询[API] 抄送列表查询查看全部
访问审批应用高级approval:approval:readonly通过此权限可以完成自建审批和三方审批的创建审批定义、审批实例、发送更新机器人消息,并可以对机器人进行更新。[API] 三方审批实例同步[API] 审批任务转交[API] 获取单个审批实例详情查看全部
服务台
更新服务台资源详情高级helpdesk:all查看和修改服务台资源详情,包含工单详情字段、知识库、推送内容和客服状态、日程、技能等。[API] 创建客服技能[API] 创建客服工作日程[API] 删除客服技能查看全部
获取服务台资源详情高级helpdesk:all:readonly查看服务台资源详情,包含工单详情字段、知识库、推送内容和客服状态日程技能等。[API] 查询全部客服技能[API] 获取客服技能列表[API] 查询全部客服工作日程查看全部
访问服务台高级helpdesk:helpdesk:access访问服务台。应用需先获取访问服务台的权限,才可获取查看和修改服务台资源详情的权限。[API] 创建服务台对话
任务
查看、创建、修改和删除任务评论高级task:comment可通过机器人创建新的任务评论,支持查看该任务、修改该任务评论以及删除该任务的评论。[API] 更新评论[API] 获取评论详情[API] 创建评论查看全部
查看任务评论普通task:comment:readonly只可查看任务评论,无法创建任务或修改、删除评论。[API] 获取评论详情
查看、创建、编辑和删除任务高级task:task可通过机器人创建新的任务,支持查看该任务详情、修改该任务以及删除该任务。[API] 获取关注人列表[API] 新增关注人[API] 新增执行者查看全部
租户维度下任务变更事件订阅高级task:task.event_update_tenant:readonly接收与发生变更任务相关的用户的 open_id。 应用拥有此权限后,可通过订阅相关事件,接收与发生变更任务关联的用户的 open_id。凭此 open_id,应用可以获取与对应用户相关的所有任务。[事件] 任务信息变更(租户维度)
查看任务详情普通task:task:readonly只可查看任务详情,无法创建任务或修改、删除评论。[API] 获取关注人列表[API] 获取执行者列表[API] 查询指定任务查看全部
邮箱
查询、创建、修改、删除邮件组高级mail:mailgroup通过此权限可进行以下操作: 查询邮件组的信息,包括邮件组 ID、邮件组地址、邮件组名称、邮件组成员数量、邮件组内成员地址等; 更新邮件组部分字段,包括邮件组名称、邮件组描述、邮件组的发信权限 创建或删除邮件组[API] 修改邮件组部分信息[API] 查询指定邮件组成员[API] 查询指定邮件组查看全部
查询邮件组高级mail:mailgroup:readonly通过此权限可以查询邮件组的信息,包括邮件组 ID、邮件组地址、邮件组名称、邮件组成员数量、邮件组内成员地址等。[API] 查询指定邮件组成员[API] 查询指定邮件组[API] 批量获取邮件组权限成员查看全部
查询、创建、修改公共邮箱高级mail:public_mailbox通过此权限可进行以下操作: 查询公共邮箱的信息,包括公共邮箱唯一标识、公共邮箱地址和公共邮箱名称 更新公共邮箱的公共邮箱名称 创建公共邮箱[API] 创建公共邮箱[API] 查询指定公共邮箱成员信息[API] 删除公共邮箱单个成员查看全部
查询公共邮箱高级mail:public_mailbox:readonly通过此权限可以查询公共邮箱的信息,包括公共邮箱唯一标识、公共邮箱地址和公共邮箱名称。[API] 查询指定公共邮箱成员信息[API] 查询所有公共邮箱[API] 查询所有公共邮箱成员信息查看全部
查询、创建、修改和删除用户的企业邮箱高级mail:user_mailbox通过此权限,当前仅可删除用户企业邮箱。[API] 从回收站删除用户邮箱地址[API] 创建用户邮箱别名[API] 获取用户邮箱所有别名查看全部
查询用户的企业邮箱普通mail:user_mailbox:readonly通过此权限,当前仅可删除用户企业邮箱。[API] 获取用户邮箱所有别名
应用信息
校验用户是否为应用管理员普通admin:app.admin:check应用管理员负责应用的安装、安装和管理,此权限可用于校验当前用户是普通用户还是租户的应用管理员。[API] 校验应用管理员
获取应用管理员 ID、管理范围等信息高级admin:app.admin:readonly获取应用管理员的管理范围,即该应用管理员能够管理哪些部门。[API] 查询应用管理员列表[API] 校验应用管理员[API] 获取应用管理员管理范围
获取应用管理员 ID普通admin:app.admin_id:readonly应用管理员负责应用的安装、安装和管理,此权限可用于查询应用的管理员列表。[API] 查询应用管理员列表
获取应用信息高级admin:app.info:readonly允许应用查看企业内应用的基本信息和功能配置,比如应用名称、图标、创建者、应用的权限、线上版本号、最新版本号等。[API] 获取应用在企业内的可用范围[API] 获取企业安装的应用[API] 获取应用信息查看全部
获取用户可用的应用高级admin:app.user_usable:readonly允许应用查询用户可用的应用列表,可查看信息包括应用 ID、应用名称、应用图标、应用类型、启停用状态等。[API] 获取用户可用的应用
管理应用可见范围高级admin:app.visibility允许应用调整某应用的可见性,支持新增用户或部门、删除用户或部门。[API] 更新应用可用范围
更新应用信息高级application:application允许应用更新某应用的基本信息,比如应用名称、图标、创建者、应用的权限、分组等。[API] 更新应用分组信息
获取机器人发送消息的概览数据高级application:application.app_message_stats.overview:readonly允许应用查看某机器人在统计周期内的消息发送情况,包括推送消息数量、消息触达人数、消息已读数量等。
更新企业内自建应用的程序包高级application:application.app_package为企业内所有的自建应用上传不同的程序包,包括小程序包、小组件包。
获取员工使用应用的概览数据高级application:application.app_usage_stats.overview:readonly允许应用查看某应用的统计数据,比如该应用的活跃用户数、累计活跃用户数等指标。[API] 获取应用使用概览
更新应用版本信息高级application:application.app_version通过此权限可以设置应用版本的具体信息,包括应用名称、图标、权限、事件、已开启能力及具体配置、版本创建与发布时间等。[API] 更新应用审核状态
获取应用版本信息高级application:application.app_version:readonly通过此权限可以查看应用版本的具体信息,包括应用名称、图标、权限、事件、已开启能力及具体配置、版本创建与发布时间等。[API] 获取应用版本信息[API] 获取应用版本列表[事件] 撤回应用发布申请查看全部
管理应用反馈数据高级application:application.feedback.feedback_info管理应用反馈数据[API] 更新应用反馈[API] 获取应用反馈列表[事件] 反馈更新查看全部
管理应用自身资源普通application:application:self_manage通过此权限可以查看和更新当前应用的具体信息,包括应用名称、图标、权限、事件、已开启能力及具体配置、版本创建与发布时间等。[API] 获取应用信息[API] 获取应用版本信息[API] 获取应用版本列表
企业信息
获取企业信息普通tenant:tenant:readonly获取企业的详细信息,当前包括:企业名称、编号和头像。[API] 获取企业信息
搜索
查询、创建、修改和删除自定义搜索数据源、数据范式或数据项高级search:data_source飞书搜索开放是企业将外部信息搜索能力集成到飞书的解决方案,定义了数据源(datasource)、范式(schema)和数据项(item)三种资源。用户可以通过对这三个资源的管理,实现外部数据快速集成到飞书搜索,在飞书实现企业信息的统一搜索。 应用具有这个权限后,可以通过对数据源、范式和数据项的管理,完成搜索开放接入。[API] 为指定数据项创建索引[API] 修改数据源[API] 获取数据源查看全部
查询自定义搜索数据源、数据范式或数据项高级search:data_source:readonly飞书搜索开放是企业将外部信息搜索能力集成到飞书的解决方案,定义了数据源(datasource)、范式(schema)和数据项(item)三种资源。用户可以通过对这三个资源的管理,实现外部数据快速集成到飞书搜索,在飞书实现企业信息的统一搜索。 应用具有这个权限后,可以查看当前已经接入到飞书搜索开放的数据源、范式和数据项信息。[API] 获取数据源[API] 查询指定数据项[API] 批量获取数据源查看全部
AI 能力
图片识别高级optical_char_recognition:image图像识别能力可以识别图片中的文字,并按区域返回文本列表。 应用获得此权限后,可对图片进行文字识别处理。[API] 识别图片中的文字
语音识别高级speech_to_text:speech语音识别能力可以将音频中的语音转换成文字。 应用获得此权限后,可使用流式语音识别和文件语音识别两种能力,分别实现分片传入音频并实时获取识别结果,以及整段传入音频并一次性获取完成识别结果的功能。[API] 识别流式语音[API] 识别语音文件
文本翻译高级translation:text文本翻译可以实现音频语种识别和文本翻译两种能力。 应用获得此权限后,可使用语种识别能力,对音频中语音的使用语种进行识别,也可使用文本翻译能力,对文本进行中、日、英三语的互译。[API] 翻译文本[API] 识别文本语种
管理后台
获取部门维度的用户活跃和功能使用数据高级admin:admin_dept_stat:readonly获取组织内各部门的用户活跃和功能使用数据的权限,涉及 消息、日历、云文档、视频会议功能,包括部门总人数、激活人数、活跃人数、消息活跃人数、日历活跃人数、创建文件人数等数据指标。 仅支持查询组织内根部门及其下前 4 级部门的数据。[API] 获取部门维度的用户活跃和功能使用数据
获取用户维度的用户活跃和功能使用数据高级admin:admin_user_stat:readonly获取组织内每个用户活跃和功能使用数据的权限,涉及消息、日历、云文档、视频会议功能。 具体数据包括:用户激活状态、激活时间、用户活跃状态、最近活跃时间、用户消息活跃状态、发送消息数、用户云文档活跃状态、创建文件数、用户日历活跃状态、创建日程数、用户音视频会议活跃状态、会议时长、活跃设备。[API] 获取用户维度的用户活跃和功能使用数据
查看、创建、编辑勋章信息和上传勋章图片高级admin:badge开通此权限后,应用可以上传勋章图片,查看、创建、更新勋章的信息。[API] 修改勋章[API] 获取勋章列表[API] 上传勋章图片查看全部
查看、创建、编辑、删除勋章授予名单高级admin:badge.grant开通此权限后,应用可以查看、创建、更新、删除勋章的授予名单信息。授予名单中的成员范围不受应用的可用范围影响,支持关联配置租户下的所有成员。[API] 获取授予名单列表[API] 获取授予名单详情[API] 删除授予名单查看全部
修改企业邮箱的密码高级admin:ent_email_password此权限允许修改用户的企业邮箱密码,用于解决企业邮箱登录死锁问题。被修改用户的邮箱需与企业邮箱一致。[API] 重置用户的企业邮箱密码
飞书人事(标准版)
获取飞书人事(标准版)应用中的附件数据高级ehr:attachment:readonly根据“获取飞书人事(标准版)员工花名册信息”接口范围的文件凭证(token),下载附件数据。[API] 下载人员的附件
获取飞书人事(标准版)应用中的员工花名册信息高级ehr:employee:readonly获取飞书人事(标准版)应用中员工的信息,包括:姓名、手机号、部门、附件等信息。[API] 批量获取员工花名册信息
招聘
更新投递信息高级hire:application获得候选人投递、offer、入职相关信息的更新和查询权限,可进行的操作包括:创建投递、终止投递、转移阶段、获取投递列表、获取投递信息、获取 offer 信息、操作候选人入职、取消候选人入职和查询待入职。[API] 操作候选人入职[API] 创建投递[API] 终止投递查看全部
获取投递信息高级hire:application:readonly获得候选人投递、offer、入职相关信息的查询权限,可进行的操作包括:获取投递列表、获取投递信息、获取 offer 信息、查询待入职。[API] 获取投递信息[API] 获取投递列表[API] 获取 Offer 信息
上传招聘相关附件高级hire:attachment获得附件信息的更新和查询权限,支持获取附件预览信息、获取附件信息、创建附件、上传附件。[API] 获取附件信息[API] 获取附件预览信息
获取附件信息高级hire:attachment:readonly获得附件信息的查询权限,可访问和获取招聘系统中附件的元信息,如文件名、创建时间、文件链接地址等。[API] 获取附件信息
更新导入 e-HR 任务高级hire:ehr_import获得“更新 e-HR 导入任务结果”接口权限。在处理完导入 e-HR 事件后,可调用该接口更新 e-HR 导入任务结果。[API] 更新 e-HR 导入任务结果
更新招聘员工信息高级hire:employee获得招聘员工信息的更新和查询权限,可更新员工入职状态,并支持通过投递 ID 或员工 ID 查询员工的入职信息。[API] 通过投递 ID 获取入职信息[API] 通过员工 ID 获取入职信息[API] 更新入职状态
获取招聘员工信息高级hire:employee:readonly获得招聘员工信息的查询权限,支持通过投递 ID 或员工 ID 查询员工的入职信息。[API] 通过投递 ID 获取入职信息[API] 通过员工 ID 获取入职信息
获取职位信息高级hire:job:readonly获得职位、职能分类、招聘需求、招聘流程相关信息查询权限,可进行的操作包括:获取职位列表、获取职位模板、获取职位上的招聘人员信息、获取职位详细信息、搜索职位信息。[API] 获取职位信息[API] 获取职位上的招聘人员信息[API] 获取职位设置
获取招聘流程信息高级hire:job_process:readonly获得招聘流程信息的查询权限。[API] 获取招聘流程信息
获取招聘相关位置信息高级hire:location:readonly获得招聘相关位置信息的查询权限,可进行的操作包括:获取地址列表、获取地址码。
更新招聘备注信息高级hire:note获取招聘备注相关信息的更新和查询权限,可进行的操作包括:创建备注、更新备注、获取备注列表、获取备注详情。[API] 创建备注[API] 获取备注[API] 更新备注查看全部
获取招聘备注信息高级hire:note:readonly获取招聘备注相关信息的查询权限,支持获取备注列表和备注详情信息。[API] 获取备注[API] 获取备注列表
获取 offer 申请表信息高级hire:offer_schema:readonly获取 offer 申请表信息的查询权限,可进行的操作包括:获取 offer 申请表列表、获取 offer 申请表、获取 offer 申请表详细信息。[API] 获取 Offer 申请表详细信息
更新内推信息高级hire:referral获得“获取内推信息”接口权限,可根据投递 ID 获取内推信息。[API] 获取内推信息
获取内推信息高级hire:referral:readonly获得“获取内推信息”接口权限,可根据投递 ID 获取内推信息。[API] 获取内推信息
更新人才信息高级hire:talent获得人才信息、人才相关的简历来源信息、人才文件夹信息的更新与查询权限,可进行的操作包括:创建人才、更新人才、上传简历创建人才、获取人才列表、获取人才字段、获取人才信息、获取简历来源列表、查询简历来源、文件夹创建。[API] 获取简历来源列表[API] 获取人才信息[API] 通过手机号或邮箱获取人才 ID
获取人才信息高级hire:talent:readonly获得人才信息、人才相关的简历来源信息、人才文件夹信息的查询权限,可进行的操作包括:获取人才列表、获取人才字段、获取人才信息、获取简历来源列表、查询简历来源。[API] 获取简历来源列表[API] 获取人才信息[API] 通过手机号或邮箱获取人才 ID
OKR
更新 OKR 信息高级okr:okr获得 OKR 相关信息的更新和查询权限,包括: 获取 OKR 周期 获取用户的 OKR[API] 获取 OKR 周期列表[API] 批量获取 OKR[API] 获取用户的 OKR 列表查看全部
获取 OKR 信息高级okr:okr:readonly获得 OKR 相关信息的更新和查询权限,包括: 获取 OKR 周期 获取用户的 OKR[API] 获取 OKR 周期列表[API] 批量获取 OKR[API] 获取用户的 OKR 列表查看全部
智能门禁
查看智能门禁记录高级acs:access_record:readonly允许应用查看用户在智能门禁设备上的通行记录,包括: access_record_id :通行记录的唯一标识 user_id :该通行记录对应的用户 ID device_id :该通行记录对应的智能门禁设备 ID is_clock_in :该通行记录是否被用作打卡记录 access_time :通行时间 access_type :通行认证方式[API] 获取门禁记录列表[事件] 新增门禁访问记录
查看智能门禁设备列表高级acs:devices:readonly允许应用查看租户下所有智能门禁设备,设备信息包括: device_id :智能门禁设备的唯一标识 device_name :智能门禁设备的名称 device_sn:智能门禁设备的 SN 编码[API] 获取门禁设备列表
查看、更新智能门禁用户高级acs:users允许应用查看、创建、修改、删除智能门禁中的用户信息,包括: card:用户的门禁卡卡号 face:用户的人脸图片[API] 修改用户部分信息[API] 下载开门时的人脸识别图片[API] 获取单个用户信息查看全部
绩效
管理绩效数据高级performance:performance获取绩效评估信息的查询权限,可获取被评估人信息、各评估环节的评分、评级、评语内容。
查看绩效数据高级performance:performance:readonly获取绩效评估信息的查询权限,可获取被评估人信息、各评估环节的评分、评级、评语内容。
主数据
获取公司银行账号信息普通mdm:company.company_bank_account.account:readonly获取公司银行账号主数据信息。 开通此权限后,应用可查看公司银行账号主数据,多用于外部第三方 ISV 交易系统和费控对公单据的集成业务。目前包括以下几类数据: 公司银行账号
查看、创建、编辑主数据中的法人实体相关信息高级mdm:legal_entity查看、创建、编辑主数据中的法人实体相关信息。 开通此权限后,应用可查看、创建、编辑主数据中的法人实体信息,多用于外部第三方 ISV 交易系统和 SaaS 主数据管理系统的集成业务。 目前包括以下几类法人实体信息: 基础信息、银行账户。
获取主数据中的法人实体信息高级mdm:legal_entity:readonly获取主数据中的法人实体信息。 开通此权限后,应用可查询主数据中的法人实体信息,多用于外部第三方 ISV 交易系统和 SaaS 主数据管理系统的集成业务。 目前包括以下几类法人实体信息: 基础信息、银行账户。
查看、创建、编辑和删除费控主数据信息高级mdm:spend查看、创建、编辑和删除费控主数据信息。 开通此权限后,应用可对主数据进行增删改查,多用于外部第三方 ISV 交易系统和费控对公单据的集成业务。目前包括以下几类数据: 公司、公司银行资产、会计科目、会计科目与公司关系、成本中心、部门与成本中心关系、内部订单
获取费控主数据信息高级mdm:spend:readonly获取费控主数据信息。 开通此权限后,应用可对费控主数据进行查看,多用于外部第三方 ISV 交易系统和费控对公单据的集成业务。目前包括以下几类数据: 公司、公司银行资产、会计科目、会计科目与公司关系、成本中心、部门与成本中心关系、内部订单
查看、创建、编辑主数据中的供应商相关信息高级mdm:vendor查看、创建、编辑主数据中的供应商相关信息。 开通此权限后,应用可查看、创建、编辑主数据中的供应商信息,多用于外部第三方 ISV 交易系统和 SaaS 主数据管理系统的集成业务。 目前包括以下几类供应商信息: 基础信息、经营地址、联系人、银行账户、公司视图。
获取主数据中的供应商信息高级mdm:vendor:readonly获取主数据中的供应商信息。 开通此权限后,应用可查询主数据中的供应商信息,多用于外部第三方 ISV 交易系统和 SaaS 主数据管理系统的集成业务。 目前包括以下几类供应商信息: 基础信息、经营地址、联系人、银行账户、公司视图。
企业百科
查看、创建、编辑、删除企业百科词条高级baike:entity查看、创建、编辑企业百科数据信息。 应用具有此权限后,可对企业百科的数据进行增改查操作。 目前,数据主要包括:草稿(未通过审批状态的词条创建或变更记录)、词条(通过审批,可以对外展示的百科词条)。[API] 创建草稿[API] 更新草稿[API] 获取词条详情查看全部
创建、更新企业百科免审词条高级baike:entity:exempt_review免审创建、更新企业百科数据信息。 应用具有此权限后,可不经过百科管理员审批,对企业百科的数据进行增改查操作,即免审创建词条或更新词条(创建的词条将直接展示给成员,无需百科管理员审核)。[API] 创建草稿[API] 更新草稿[API] 获取词条详情查看全部
查看企业百科词条高级baike:entity:readonly查看企业百科数据信息。 应用具有此权限后,可查看企业百科内的词条信息,进行搜索词条、高亮词条等操作。仅具有查看能力,无法对词条进行变更操作。[API] 获取词条详情[API] 获取词条列表[API] 精准搜索词条查看全部
帐号
获取用户登录信息(mask)高级passport:session_mask:readonly获取用户登录信息,包括会话创建时间与设备类型。关键字段将进行脱敏处理。[API] 批量获取脱敏的用户登录信息
网页组件
获取成员名片信息高级component:user_profile在网页中展示成员名片页,名片中可能包含部门、邮箱等信息。不同企业下的成员名片字段由企业管理员设置。
小组件
创建、更新 BlockEntity普通block:entity开通此权限后,应用可创建、更新 BlockEntity。 BlockEntity 是一串标准的数据结构,包括 BlockID、SourceMeta、SourceData 等信息,存储在开放平台服务端上。小组件需要使用 BlockEntity 数据实现渲染。通过创建、更新 BlockEntity,可使 blockID 相同的小组件收到内容相同的数据推送。[API] 更新 BlockEntity[API] 创建 BlockEntity
推送小组件的协同数据普通block:message开通此权限后,应用可推送小组件的协同数据。 小组件的协同数据指以用户维度隔离的、应用自定义的需要在小组件中展示的数据。通过推送小组件的协同数据,可实现用户维度的差异化数据推送。[API] Block消息推送
认证信息
查看租户认证信息普通verification:verification_information:readonly开通此权限后,应用可查看租户认证信息。[API] 获取认证信息
个人设置
开启或关闭用户系统状态高级personal_settings:status:system_status_operate系统状态是租户赋予用户、用于展示用户状态的一种状态标签,如"请假"。开通此权限后,应用可以开启或关闭租户内用户对系统状态的使用权。[API] 批量开启系统状态[API] 批量关闭系统状态
获取与更新系统状态高级personal_settings:status:system_status_update系统状态是租户赋予用户、用于展示用户状态的一种状态标签,如"请假"。开通此权限后,应用可以对租户内所有系统状态进行添加、删除、修改、查询等操作。[API] 修改系统状态[API] 获取系统状态[API] 创建系统状态查看全部
历史版本
使用数据保险箱时根据权限判断是否过滤敏感人员信息高级ability:security_and_compliance.exempt_kp_protect使用数据保险箱时根据权限判断是否过滤敏感人员信息
获取员工使用应用的明细数据高级admin:app.usage.detail:readonly允许应用查看可以使用某应用的人员列表。
获取员工使用应用的概览数据高级admin:app.usage.overview:readonly允许应用查看某应用的统计数据,比如该应用的活跃用户数、累计活跃用户数等指标。
获取机器人发送消息的概览数据高级admin:message.bot.overview:readonly允许应用查看某机器人在统计周期内的消息发送情况,包括推送消息数量、消息触达人数、消息已读数量等。
查看、评论、编辑和管理多维表格(套件内)高级bitable:bitable该权限已不再维护,不可新增申请;你可申请开通权限“bitable:app”(查看、评论、编辑和管理多维表格)。[API] 增加协作者权限[API] 更新云文档权限设置[API] 移除协作者权限查看全部
查看、评论和导出多维表格(套件内)高级bitable:bitable:readonly该权限已不再维护,不可新增申请;你可申请开通权限“bitable:app:readonly”(查看、评论和导出多维表格)。
查询BlockEntity内容普通block:entity:readlonly查询BlockEntity内容
查看、创建、修改、删除客户360客户信息高级c360:account查看、创建、修改、删除客户360客户信息
查看客户360客户信息高级c360:account:readonly查看客户360客户信息
获得客户360对象信息变更事件推送高级c360:object:event获得客户360对象信息变更事件推送
查看、创建、修改、删除客户360商机信息高级c360:opportunity查看、创建、修改、删除客户360商机信息
查看客户360商机信息高级c360:opportunity:readonly查看客户360商机信息
查看、创建、修改、删除客户360订单信息高级c360:order查看、创建、修改、删除客户360订单信息
查看客户360订单信息高级c360:order:readonly查看客户360订单信息
查看客户360跟进记录信息高级c360:record_follow:readonly查看客户360跟进记录信息
访问日历高级calendar📆access获得全部日历接口的授权。 注:该权限已不再维护,不可新增申请;你可申请开通权限“calendar:calendar”(更新日历及日程信息)。[事件] 日程回复
以应用身份读取关联组织高级contact:collaboration.tenant:readonly开通此权限后,应用可获取关联组织的相关组织架构信息。
更新通讯录-即将下线高级contact:contact.old获得用户、部门、人员类型的相关更新能力。 注:该权限已不再维护,不可新增申请;你可申请开通权限“contact:contact”(更新通讯录)。
以应用身份访问通讯录普通contact:contact:access_as_app以 tenant_access_token 获得如下接口权限: 1. 读取用户信息相关能力,包括:获取单个用户信息、获取用户列表、获取用户变更事件 2. 读取部门信息相关能力,包括:获取单个部门信息、获取部门信息列表、获取父部门信息、搜索部门、获取部门变更事件 3. 读取人员类型相关能力,包括:查询人员类型、人员类型变更事件 4. 通讯录权限范围变更事件 注:调用接口时,部分字段可能需要额外权限,具体以文档为准。[API] 获取部门详情[API] 批量获取用户信息[API] 批量新增部门查看全部
读取通讯录高级contact:contact:readonly该权限已弃用。[API] 获取父部门信息[API] 修改用户部分信息[API] 更新用户所有信息查看全部
获取联系人基本信息普通contact:user.base_old:readonly该权限已弃用。
获取用户帐号信息普通contact:user.identity:readonly该权限已弃用。
获取用户 union ID高级contact:user.union_id:readonly获得根据 union_id 查询用户 open_id/user_id 的能力。 注:该权限已不再维护,不可新增申请;你可申请开通权限“contact:user.employee_id:readonly”(获取用户 user ID)。[API] 修改用户部分信息[API] 更新用户所有信息[API] 创建用户查看全部
获取基础数据信息高级corehr:common_data.basic_data.read获取基础数据信息
读写公司信息高级corehr:companies读写公司信息
获取公司信息高级corehr:companies:readonly获取公司信息
读写成本中心信息高级corehr:cost_centers读写成本中心信息
获取货币信息高级corehr:currencies:readonly获取货币信息
获取自定义字段信息高级corehr:custom_fields:readonly获取自定义字段信息
更新人员类型信息高级corehr:employee_types更新人员类型信息
获取人员类型信息高级corehr:employee_types:readonly获取人员类型信息
获取地理库信息高级corehr:geographic_datas:readonly获取地理库信息
更新职务序列信息高级corehr:job_families更新职务序列信息
获取职务序列信息高级corehr:job_families:readonly获取职务序列信息
更新职务级别信息高级corehr:job_levels更新职务级别信息
获取职务级别信息高级corehr:job_levels:readonly获取职务级别信息
更新职务信息高级corehr:jobs更新职务信息
获取职务信息高级corehr:jobs:readonly获取职务信息
更新地点信息高级corehr:locations更新地点信息
获取地点信息高级corehr:locations:readonly获取地点信息
更新国家证件类型信息高级corehr:national_id_types更新国家证件类型信息
获取国家证件类型信息高级corehr:national_id_types:readonly获取国家证件类型信息
读写工时制度信息高级corehr:working_hours_types读写工时制度信息
获取工时制度信息高级corehr:working_hours_types:readonly获取工时制度信息
创建、更新用户数据迁移任务(已迁移至security_and_compliance:user_migration_task)高级data_compliance:user_migration_task创建、更新用户数据迁移任务(已迁移至security_and_compliance:user_migration_task)
查看用户数据迁移任务(已迁移至security_and_compliance:user_migration_task:readonly)普通data_compliance:user_migration_task:readonly查看用户数据迁移任务(已迁移至security_and_compliance:user_migration_task:readonly)
以用户身份进行云文档操作高级docs:docs:operate_as_user该权限已弃用。
获取服务台资源列表高级helpdesk:resource.list:readonly查看服务台资源详情,包含工单详情字段、知识库、推送内容和客服状态日程技能等。 注:该权限已不再维护,不可新增申请;你可申请开通权限“helpdesk:all:readonly”(获取服务台资源详情)。
获取群聊中所有的用户聊天消息高级im:message.group_msg:readonly可接收机器人所在群聊中的所有消息。[事件] 接收消息
获取单聊、群组的历史消息普通im:message.history:readonly该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。[API] 获取会话历史消息[API] 获取消息中的资源文件
获取会话中消息撤回操作高级im:message.revert_msg:readonly该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。
发送应用内加急消息高级im:message.urgent:app_send可在应用内发送加急消息,被加急的用户将会收到该消息在应用内的常驻强提醒。 注:建议申请开通新权限“im:message.urgent”(发送应用内加急消息)。[API] 发送应用内加急
发送电话加急高级im:message.urgent:phone_send可通过电话的方式发送加急消息,被加急的用户将会收到提醒电话。通过接口产生的短信及电话加急将消耗企业的加急额度,请慎重调用。剩余额度信息可以在“飞书管理后台 > 费用中心 > 权益数据”中查询。 注:建议申请开通新权限“im:message.urgent:phone”(发送电话加急消息)。[API] 发送电话加急
发送短信加急消息高级im:message.urgent:sms_send可通过短信的方式发送加急消息,被加急的用户将会收到提醒短信。通过接口产生的短信及电话加急将消耗企业的加急额度,请慎重调用。剩余额度信息可以在“飞书管理后台 > 费用中心 > 权益数据”中查询。 注:建议申请开通新权限“im:message.urgent:sms”(发送短信加急消息)。[API] 发送短信加急
获取消息的基础信息V2普通im:message:basic该权限已不再维护,不可新增申请;你可申请开通权限“im:message:readonly”(获取单聊、群组消息)。[API] 查询消息已读信息
撤回消息V2普通im:message:recall该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。[API] 撤回消息
发送消息V2普通im:message:send该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。[API] 回复消息[API] 发送消息
应用可向未加入的群聊发送消息高级im:message:send_any_group该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。
更新应用发送的消息普通im:message:update该权限已不再维护,不可新增申请;你可申请开通权限“im:message”(获取与发送单聊、群组消息)。[API] 更新应用发送的消息卡片
上传文件V2高级im:resource:upload该权限已不再维护,不可新增申请;你可申请开通权限“im:resource”(获取与上传图片或文件资源)。[API] 上传图片[API] 上传文件
使用数据保险箱功能审计特定成员高级security_and_compliance:vault.usts使用数据保险箱功能审计特定成员

【飞书】API开发者 微信交流群

用微信扫右侧二维码,加入【飞书】API开发者 交流群,互助沟通

扫码加入交流群
上一页
简介
下一页
API 列表
Built with