搜索部门

搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。

注意事项：

• 根据用户可见性搜索部门数据

• 根据应用和用户的通讯录权限过滤

• 入参query为部门名称

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/contact/v2/departments/search
HTTP Method	POST
支持的应用类型	自建应用 商店应用
权限要求 开启任一权限即可	以应用身份读取通讯录 搜素用户/部门
字段权限要求	该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 获取部门组织架构信息 获取部门基础信息 获取用户 user_id（仅自建应用）

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	描述
user_id_type	string	用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求： 获取用户 user ID

请求体

名称	类型	必填	描述
query	string	是	搜索关键词，匹配字段为部门名称

请求体示例

{
  "query": "DemoName"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟ name	string	部门名称 字段权限要求（满足任一）： 获取部门基础信息
∟ parent_department_id	string	父部门的ID * 创建根部门，该参数值为 “0” 字段权限要求（满足任一）： 获取组织架构信息
∟ department_id	string	本部门的自定义部门ID 字段权限要求（满足任一）： 获取部门基础信息
∟ leader_user_id	string	部门主管用户ID 字段权限要求（满足任一）： 获取用户 user_id
∟ order	int	部门的排序，即部门在其同级部门的展示顺序
∟ member_count	int	部门下用户的个数
∟ status	object	部门状态 字段权限要求（满足任一）： 获取部门基础信息
∟ ∟ is_deleted	boolean	是否删除

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "data": [
    {
      "department_id": "0102",
      "name": "父部门",
      "parent_department_id": "01",
      "leader_user_id": "9279",
      "order": 0,
      "member_count": 1,
      "status": {
        "is_deleted": false
      }
    }
  ],
  "msg": "操作成功"
}