通讯录API

开发准备

开发前,请仔细阅读 开发指南

注:以下接口中,统一使用root代表根部门ID

部门API

POST /api/v1/department/{ dept_id }/department_list (递归)获取指定部门的子部门列表

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

请求参数:

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

请求数据样例:

递归获取当前企业下所有部门列表

POST /api/v1/department/root/department_list

{
    "has_child": true
}

响应内容:

参数 含义
departments 当前指定部门下的子部门列表

单个部门的返回数据结构:

参数 含义
_id 部门ID
name 部门名称
parent_id 父部门ID

响应数据样例:

{
  "departments": [
    {
      "_id": "57357498efcde044335bc4b9",
      "name": "销售部",
      "parent_id": "root" //表示根部门
    }, {
      "_id": "55748998efcde044335bcefd",
      "name": "华东区销售小组",
      "parent_id": "57357498efcde044335bc4b9"
    }
  ]
}

成员API

POST /api/v1/department/{ dept_id }/member_list (递归)获取指定部门里的成员列表

请求参数:

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

请求数据样例:

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

POST /api/v1/department/root/member_list

{
    "has_child": true
}

响应内容:

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

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

参数 含义
_id 用户ID
name 昵称
username 用户名
departments 用户所属的部门ID列表

响应数据样例:

{
    users: [
        {
            _id: "58afe156f2c7c032de8df272",
            username: "aubrey",
            name: "aubrey",
            departments: ["57357498efcde044335bc4b9"]
        }
    ]
}

POST /api/v1/user/{ user_id }/user_retrieve 获取指定成员信息

请求参数:无

响应内容:

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

响应数据样例:

{
    user: {
        _id: "58afe156f2c7c032de8df272",
        username: "aubrey",
        name: "aubrey",
        departments: ["57357498efcde044335bc4b9"]
    }
}
Peach是此帮助页面的作者。如果您对此页面的内容有任何意见,请在下方给她反馈。如需获取即时帮助,请联系技术支持。
本文是否对您有帮助?