百宝云 | 帮助中心
  • 帮助文档
  • 功能模块
  • 后端开发
  • 专题详解
  • 常见问题
  • 更新日志
  • 视频学院
返回控制台
  • 返回控制台
  • 百宝云简介
  • 百宝云新版功能简介
  • 快速入门
    • 百宝云账号注册
    • 表单、报表新建与共享
    • 应用管理
    • 从excel导入创建表单
    • 表单、流程表单与报表的区别
    • 平台性能解释
      • 什么是用户数
      • 什么是数据量
      • 什么是流量
  • 工作台
    • 应用管理
      • 任务待办
      • 应用分组
      • 应用排序
      • 创建新应用
      • 快捷操作
      • 应用分享给他人安装
      • 导出安装包
    • 账户中心
      • 基础
      • 会员中心
      • 财务
      • 已安装模块
      • 安全
      • 语言包
    • 消息中心
      • 消息类型
      • 通知设置
      • 消息接收人管理
  • 通讯录管理
    • 成员
    • 组织架构
    • 设置部门主管
    • 子管理员
    • 角色
  • 表单设计
    • 表单控件
      • 控件基础说明
      • 单行文本
      • 多行文本
      • 数字
      • 日期时间
      • 按钮
      • 分割线
      • 地址
      • 定位
      • 图片
      • 附件
      • 子表单
        • 子表单补充说明
        • 子表单数据加载
      • 关联查询
      • 关联数据
      • 手写签名
      • 流水号
      • 数据加载
      • 下拉框和单选按钮组
      • 复选框和下拉复选框
      • 成员和部门
      • 控件设计常用功能
        • 字段名称下添加超链接
        • 字段上添加图片
        • 收集外部数据
        • 公开查询
        • 下拉框和下拉复选框字段排序
    • 表单属性
      • 表单校验
      • 表单布局
      • 模块设置
      • 表单数据缓存
      • 记录访问来源
      • 隐藏控件赋值
    • 公式详解
      • 公式规则
      • 逻辑函数
        • AND 与运算
        • OR 或运算
        • TRUE/FALSE 布尔型
        • IF 条件判断
        • NOT 非运算
        • XOR 异或运算
        • IFS 多条件判断
      • 文本函数
        • CONCATENATE 文本合并
        • EXACT 文本比较
        • LEFT 取左
        • RIGHT 取右
        • MID 取中间
        • LEN 取长度
        • LOWER 大写转小写
        • UPPER 小写转大写
        • REPLACE 文本替换
        • REPT 重复
        • SEARCH 查找
        • SPLIT 分割
        • TRIM 删除字符串收尾空格
        • TEXT 数字转文本
        • VALUE 文本转数字
        • ISEMPTY 判断是否为空
        • GETUSERNAME 获取用户昵称
        • MD5 md5加密
        • CHAR 换行
      • 数学函数
        • AVERAGE 平均数
        • COUNT 计数
        • COUNTIF 统计满足条件的个数
        • LARGE 取大值
        • MAX 取最大值
        • MIN 取最小值
        • SMALL 取小值
        • ABS 取绝对值
        • ROUND/FIXED 四舍五入
        • CEILING 向上舍入
        • FLOOR 向下舍入
        • INT 求整
        • LOG 对数
        • MOD 取余数
        • POWER 乘幂
        • PRODUCT 乘积
        • SQRT 平方根
        • SUM 求和
        • SUMPRODUCT 乘积和
        • RAND 随机数
        • ISNAN 判断计算空值
      • 日期函数
        • DATE 时间戳转日期
        • TIMESTAMP 日期转时间戳
        • TIME 时间十进制
        • TODAY 今天
        • NOW 当前时间
        • SYSTIME 服务器时间
        • DAY 日
        • MONTH 月
        • YEAR 年
        • HOUR 小时
        • MINUTE 分钟
        • SECOND 秒数
        • DAYS 时间间隔
        • DAYS360 日期间相差的天数
        • DATEDELTA 加/减指定天数
        • WEEKNUM 周数
        • ISOWEEKNUM ISO周数
        • DATEDIFF 两个时间的差值
      • 高级函数
        • MAPX 聚合操作
        • UUID 随机码生成器
        • RECNO 累积器
        • IP 获取用户IP地址
      • 子表单函数
        • SUBFORMLESS 小于
        • SUBFORMGREATER 大于
        • SUBFORMEQUAL 等于
        • SUBFORMLESSOREQUAL 小于等于
        • SUBFORMGREATEROREQUAL 大于等于
        • SUBFORMNOTEQUAL 不等于
    • 数据关联与联动
      • 规则介绍
      • 数据关联
      • 数据联动
      • 多级联动
      • 子表单联动
    • 实例讲解
      • 选项关联控件
  • 流程表单
    • 设计
      • 建立节点和流程关系
      • 节点连线-过滤条件
      • 流转规则
      • 流程结束节点
      • 流程负责人
      • 节点校验
      • 操作权限
      • 抄送
      • 流程提醒
      • 流程撤回
      • 节点权限
      • 审批意见
      • 流程状态和日志
      • 激活流程
      • 流程决策
      • 流程版本
      • 流程节点限时处理
        • 自动提醒
        • 自动提交
        • 自动回退
      • 子流程
        • 案例-出差与报销
    • 使用
      • 工作台的流程信息
      • 流程管理
      • 筛选条件
      • 批量提交与数据刷新
    • 监管
      • 管理员监控流程
    • 流程案例与常见问题
      • 会签流程
      • 条件流程
      • 并发流程
      • 案例1:报销
      • 节点校验与流转条件的对比
      • 流程节点的打印模版选择
  • 数据管理与协作
    • 导出表样、导入数据
    • 特殊控件的数据导入
    • 数据管理
    • 数据权限
      • 普通表单数据权限
      • 流程表单数据权限
      • 表单数据权限举例
    • 数据动态与评论
    • 数据分享
    • 批量修改
    • 批量打印
    • 批量打印二维码
    • 批量调整负责人
    • 批量结束流程
    • 数据协作介绍
    • 数据协作使用方法
    • Excel导入导出图片
  • 表单设置
    • 提交提示
    • 多标签显示
    • 打印功能介绍
      • 模板设计
      • 模板使用范围
      • 案例1:自定义模板
      • 案例2:套打
    • 推送提醒
      • 提醒设置
        • 新数据提交时提醒
        • 数据修改后提醒
        • 自定义时间提醒
        • 根据表单中的日期字段提醒
      • 提醒方式
    • 计划任务
    • 字段索引
    • 微信增强
  • 分析报表
    • 数据表
      • 数据表菜单栏
    • 日历
    • 后端表
    • 图形表
      • 图形表的属性与特点
      • 双轴图
      • 辅助线
      • 颜色设置
      • 图表联动
      • 图表自定义联动
      • 同比环比
      • 地图
    • 文本组件
    • 筛选条件
    • 排序
      • 数据表排序
      • 指标排序
      • 透视图排序
      • 图表排序
        • 柱形图、条形图、面积图排序
        • 折线图、雷达图排序
        • 饼图排序
    • 报表菜单栏
    • 数据菜单冻结
    • 报表权限
      • 基础报表
      • 分析报表
      • 场景报表
    • 过滤条件
    • 数据格式
    • 图片预览
    • 案例:数据表-菜单操作
    • 老报表
      • 报表权限
      • 数据表
      • 数据表移动端卡片样式
      • 汇总表
      • 柱形图
      • 折线图
      • 饼图
      • 面积图
      • 雷达图
      • 排班表
      • 日历
      • 地图
      • 报表查询条件
      • 报表条件过滤
      • 报表联动
      • 多表关联
        • 多表关联规则
        • 数据表多表关联
      • 显示格式
      • 汇总逻辑
  • 场景报表
    • 卡片
    • 地图
  • 权限设置
    • 表单/报表分享
    • 普通表单数据权限管理
    • 流程表单数据权限管理
  • 数据视图
    • 认识数据视图
    • 新建视图
      • 视图设计
      • 视图节点选择
        • 横向连接
        • 追加合并
        • 数据筛选
        • 分组汇总
        • 字段设置
        • 字段排序
        • 含有子表单的数据源处理
        • 节点设置
        • 输出表
    • 案例:多渠道订单汇总
  • 外链使用
    • 对外收集数据
    • 对外展示数据
    • 外链扩展
    • 报表外链权限
    • 表单外链样式
    • 外链限制
  • 事件表单
    • 事件表单
    • 事件流程表单
    • 后端开发
    • 初始化事件
    • 提交事件
    • 控件事件的触发
    • 前置触发后置触发
  • 应用设置
    • 页面共享
    • 移动自定义菜单
    • 应用发布
    • 应用日志
    • 应用管理
    • 聚合表
      • 聚合表介绍
      • 案例1:进销存
  • 高级功能
    • 数据回收站
    • 批量导出附件
    • 跨应用
    • Web API
      • 开发指南
      • 表单&数据API
      • 通讯录API
      • POST接口
    • 安装多模块
    • 控件回收站
    • 安全策略
    • 单点登录
      • 开发指南
      • SAML2.0配置
      • 自定义接口配置
  • 企业微信
    • 企业微信账号创建与应用添加
    • 百宝云普通账号绑定企业微信
    • 通讯录同步及修改
    • 企业微信第三方应用通讯录授权
    • 在企业微信使用百宝云的方式
    • 应用权限设置
    • 企业微信管理员账号与成员账号的区别
  • 收费版本介绍
    • 套餐购买
    • 套餐购买升级续费
  • 移动端帮助手册
    • 工作台
    • 应用
    • 我的
    • 流程管理
  • 数据助手
    • 数据助手介绍
    • 新建数据助手
      • 设计数据助手
      • 节点选择
        • 输入数据
          • 输入数据
          • 数据源
          • 输入数据含有子表单的处理
        • 数据处理
          • 横向连接
          • 追加合并
          • 数据筛选
          • 分组汇总
          • 字段设置
          • 字段排序
        • 执行动作
          • 新增数据
          • 修改数据
          • 删除数据
          • 功能模块
          • 数据联动
          • 其他设置
        • 输出表
        • 节点基础设置
    • 案例-修改商品信息单价
通讯录API
阅读人数:

458

  • 部门API
    • POST /api/v2/department/{ dept_no }/department_list - (递归)获取部门列表
    • POST /api/v2/department/create - 创建部门
    • POST /api/v2/department/{ dept_no }/update - 修改部门
    • POST /api/v2/department/{ dept_no }/delete - 删除部门
  • 成员API
    • POST /api/v2/department/{ dept_no }/member_list -(递归)获取部门成员
    • POST /api/v2/user/{ uniqueid }/user_retrieve - 获取成员信息
    • POST /api/v2/user/create - 添加成员
    • POST /api/v2/user/{ uniqueid }/update - 修改成员
    • POST /api/v2/user/{ uniqueid }/delete - 删除成员
    • POST /api/v2/user/batch_delete - 批量删除成员
  • 批量管理API
    • POST /api/v2/department/import - 全量导入部门
    • POST /api/v2/user/import - 增量导入用户

注意事项:

每个通讯录都是一棵部门树,且根部门的部门编号都是1;

普通模式的企业以下接口全部支持;

集成模式的企业仅支持获取部门列表、获取部门成员和获取成员信息接口;

部门实体结构(department)

属性 类型 含义
dept_no number 部门编号,企业内唯一
name string 部门名称
parent_no number 部门的父级部门编号

用户实体结构(user)

属性 类型 含义
_id string 用户ID,全局唯一
username string 用户名
name string 昵称
category number 用户状态(-1表示被邀请的人尚未同意其邀请, 同意后自动变为2, 0表示团队创建者, 2表示普通成员)
uniqueid string 企业内用户ID
remark string 备注
title string 职称
departments number[] 成员所在部门编号列表

部门API

POST /api/v2/department/{ dept_no }/department_list - (递归)获取部门列表

能够(递归)获取指定部门id的所有子部门。

请求参数:

参数 必需 类型 说明
has_child Boolean 是否递归获取所有子部门。默认为false,即只获取一级子部门

请求数据样例:

递归获取当前企业的根部门下所有部门列表。 注:数字1为根部门编号。

POST /api/v2/department/1/department_list

{
    "has_child": true
}

响应内容:

参数 类型 含义
departments array 当前指定部门下的子部门列表
departments[].dept_no number 部门编号
departments[].name string 部门名称
departments[].parent_no number 父部门编号

响应数据样例:

{
  "departments": [
    {
      "dept_no": 3,
      "name": "webapi添加",
      "parent_no": 1 //表示父部门编号
    }, {
      "dept_no": 33,
      "name": "开发",
      "parent_no": 3
    }
  ]
}

POST /api/v2/department/create - 创建部门

请求参数:

参数 必需 类型 说明
name 是 string 部门名称
parent_no number 父部门编号,不传默认为根部门
dept_no number 部门编号,不传自动生成(上限 100000 )

请求数据样例:

{
    "name": "研发部门",
    "parent_no": 1,
    "dept_no": 2
}

响应内容:

参数 类型 含义
department json 创建的部门信息
department.dept_no number 部门编号
department.name string 部门名称
department.parent_no number 父部门编号

响应数据样例:

{
  "department": {
    "dept_no": 2,
    "name": "研发部门",
    "parent_no": 1
  }
}

POST /api/v2/department/{ dept_no }/update - 修改部门

请求参数:

参数 必需 类型 说明
name 是 string 部门名称

请求数据样例:

{
    "name": "测试部门"
}

响应内容:

参数 类型 含义
department json 创建的部门信息
department.dept_no number 部门编号
department.name string 部门名称
department.parent_no number 父部门编号

响应数据样例:

{
  "department": {
    "dept_no": 3,
    "name": "测试部门",
    "parent_no": 2
  }
}

POST /api/v2/department/{ dept_no }/delete - 删除部门

请求参数:

无

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}

成员API

POST /api/v2/department/{ dept_no }/member_list -(递归)获取部门成员

能够(递归)获取指定部门编号下的所有成员。

请求参数:

参数 必需 类型 说明
has_child Boolean 是否递归获取所有成员。默认为false,即只获取当前部门下的成员,而不获取其子部门的成员

请求数据样例:

递归获取当前企业下所有成员列表

{
    "has_child": true
}

响应内容:

参数 含义
users 当前指定部门下的成员列表

单个成员的返回数据结构:

参数 含义
_id 用户ID
name 昵称
username 用户名
category 用户状态(-1表示被邀请的人尚未同意其邀请, 同意后自动变为2, 0表示团队创建者, 2表示普通成员)
uniqueid      企业内用户ID
remark          备注
title          职称
departments  用户所属的部门ID列表

响应数据样例:

{
    "users": [
        {
            "_id": "575ffc5e885898ce0d2afe43",
            "name": "xiaoyun",
            "username": "xiaoyun",
            "category": "2",
            "uniqueid": "XiaoYun",
            "remark": "",
            "title": "",
            "departments": [
                1,
                3
            ]
        },
        {
            "_id": "55cb7d57f7a190e382857119",
            "name": "小宝",
            "username": "xiaobao",
            "category": "2",
            "uniqueid": "110911062",
            "remark": "领导",
            "title": "教授",
            "departments": [
                1
            ]
        },
        {
            "_id": "5ae9b2e763476bd11c13c9ba",
            "name": "测试02",
            "username": "ceshi",
            "category": "2",
            "uniqueid": "100005",
            "remark": "测试号",
            "title": "",
            "departments": [
                2
            ]
        }
    ]
}

POST /api/v2/user/{ uniqueid }/user_retrieve - 获取成员信息

请求参数:无

响应内容:

参数 含义
user 成员信息,同单个成员的返回数据结构

响应数据样例:

{
    "user": {
        "_id": "575ffc5e885898ce0d2afe43",
        "name": "xiaoyun",
        "username": "xiaoyun",
        "category": "2",
        "uniqueid": "XiaoYun",
        "remark": "",
        "title": "",
        "departments": [
           1,
           3
        ]
    }
}

POST /api/v2/user/create - 添加成员

在指定部门下添加一位成员,该成员用户自动激活(可直接通过单点登录进行访问,并且会占用1个用户数),但是没有手机、邮箱和密码等个人注册信息。

请求参数

参数 必需 类型 说明
name 是 string 昵称
departments numer[] 用户所属部门列表
uniqueid string 成员编号
remark string 备注
title string 职称

请求数据样例:

{
    "uniqueid": "GaoCenXing3",
    "name": "小高3",
    "remark":"6月1",
    "title":"会员",
    "departments": [
        1
    ]
}

响应内容:

参数 类型 说明
usre json 新添加的该成员信息,同单个成员的返回数据结构

响应数据样例:

{
    "user": {
        "_id": "575ffc5e885898ce0d2afe55",
        "name": "小高3",
        "username": "bby_8zzhth90591",
        "category": "2",
        "uniqueid": "GaoCenXing3",
        "remark": "6月1",
        "title": "会员",
        "departments": [
           1
        ]
    }
}

POST /api/v2/user/{ uniqueid }/update - 修改成员

修改指定成员的信息,比如部门、昵称、备注、职称。

注意:企业内用户ID不允许修改。

请求参数

参数 必需 类型 说明
name string 昵称
departments numer[] 用户所属部门列表
remark string 备注
title string 职称

请求数据样例:

{
    "name": "Gcx",
    "remark":"5月30号加入",
    "title":"荣誉会长",
    "departments": [
        7
    ]
}

响应内容:

参数 类型 说明
usre json 修改后的该成员信息,同单个成员的返回数据结构

响应数据样例:

{
    "user": {
        "_id": "51616fa9c2668f496283094c",
        "name": "Gcx",
        "username": "bby_qvsusl53003",
        "category": "2",
        "uniqueid": "GaoCenXing",
        "remark": "5月30号加入",
        "title": "荣誉会长",
        "departments": [
            7
        ]
    }
}

POST /api/v2/user/{ uniqueid }/delete - 删除成员

从通讯录中删除指定企业内用户ID的用户。

请求参数

无

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}

POST /api/v2/user/batch_delete - 批量删除成员

请求参数

参数 必需 类型 说明
usernames 是 array 用户编号列表

请求数据样例:

{
    "uniqueids": [
        "CeShiDaoRu",
        "CC"
    ]
}

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}

批量管理API

POST /api/v2/department/import - 全量导入部门

本接口以dept_no(部门编号)为主键,全量覆盖企业内的通讯录部门树。

注意事项:

  1. 部门编号为数字类型且唯一。
  2. 除了根部门以外所有部门的父部门必须存在。如果新导入列表中不存在根部门, 则会自动插入根部门, 且部门名称为企业名称。
  3. 同级部门名称不能有重复。
  4. 部门层级不能超过16级。
  5. 如果导入数据存在,且现有企业通讯录中也存在,则更新该部门的信息。
  6. 如果导入数据存在,而现有企业通讯录中不存在,则新建该部门。
  7. 如果导入数据不存在,但现有企业通讯录中存在,则继续判断该部门下是否存在子部门和成员,如果都没有则自动删除该部门,否则继续保留。
  8. 该接口允许导入的部门数上限为1000。
  9. 该接口调用执行期间,将无法同时调用其他对通讯录的修改、删除、新增接口。

请求参数

参数 必需 类型 说明
departments 是 array 部门列表
departments[].dept_no 是 number 部门编号(上限 1000)
departments[].name 是 string 部门名称
departments[].parent_no number 父部门编号,不传默认为根部门下

请求数据样例:

{
    "departments": [
        {
            "dept_no": 3,
            "name": "部门名称1",
            "parent_no": 2
        },
        {
            "dept_no": 2,
            "name": "部门名称2",
            "parent_no": 1
        }
    ]
}

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}

POST /api/v2/user/import - 增量导入用户

本接口以企业内的username(用户编号)为主键,更新创建企业成员。

注意事项:

  1. 企业内唯一ID在企业内唯一,仅支持字母,数字,下划线32位内。
  2. 用户昵称最长为26个字符。
  3. 所有用户必须在部门下,如果导入用户不存在部门,则会移动到根部门下。
  4. 通过该接口导入的用户会自动激活,且没有邮箱、密码、手机号等信息,可以配合单点登录功能实现企业用户登录。
  5. 如果导入数据存在,但是现有企业通讯录中不存在该用户,则新建成员。
  6. 如果导入数据存在,且现有企业通讯录中存在该用户,则更新成员信息。
  7. 该接口不会执行删除成员操作。
  8. 该接口每次调用允许导入的用户数为2000。
  9. 该接口调用执行期间,将无法同时调用其他对通讯录的修改、删除、新增接口。

请求参数

参数 必需 类型 说明
users 是 json[] 用户列表
users[].uniqueid 是 string 用户编号
users[].name 是 string 昵称
users[].departments 是 number[] 所在部门编号列表

请求数据样例:

{
    "users": [
        {
            "uniqueid": "GaoCenXing3",
            "name": "小高吗",
            "departments": [
                1,
                2
            ]
        },
        {
            "uniqueid": "xiaoyun",
            "name": "小云",
            "departments": [
                70
            ]
        }
    ]
}

响应内容:

参数 类型 说明
status string 返回请求结果

响应数据样例:

{
    "status": "success"
}