批量查询部门下的成员信息

查询部门成员信息

请求说明

请求地址	https://openapi.wps.cn/v7/depts/{dept_id}/members/batch_read
请求方法	POST
签名方式	KSO-1
权限要求	查询和管理通讯录信息（应用授权） kso.contact.readwrite 查询通讯录信息（应用授权） kso.contact.read

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

路径参数（Path）

名称	参数类型	说明
dept_id	string	部门 id

请求体（Body）

名称	参数类型	是否必填	说明
status	array[string]	是	用户状态，必填。 可选值：active：正常；notactive：未激活；disabled：禁用
user_ids	array[string]	是	用户的唯一标识，可以是用户 id、用户名、邮箱、手机号、外部 id、在外部身份源的 id，为空则自动生成
with_user_detail	boolean	否	是否返回用户详情信息

请求地址示例

[POST] https://openapi.wps.cn/v7/depts/{dept_id}/members/batch_read

请求体示例

{
  "status": ["string"],
  "user_ids": ["string"],
  "with_user_detail": false
}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	成员信息列表
∟ ∟ ctime	integer	创建时间
∟ ∟ dept_id	string	部门 id 列表
∟ ∟ is_leader	boolean	在所在的部门内是否为部门负责人
∟ ∟ mtime	integer	修改时间
∟ ∟ order	integer	部门内的排序值
∟ ∟ user_id	string	用户 id
∟ ∟ user_info	object	用户详细信息
∟ ∟ ∟ avatar	string	账户头像
∟ ∟ ∟ city	string	城市
∟ ∟ ∟ country	string	国家
∟ ∟ ∟ email	string	邮箱 需额外获取字段权限：查询用户的邮箱（应用授权）kso.user_email.read
∟ ∟ ∟ employee_id	string	工号
∟ ∟ ∟ employer	string	就职单位
∟ ∟ ∟ employment_status	string	员工状态
∟ ∟ ∟ employment_type	string	员工类型
∟ ∟ ∟ gender	string[enum]	性别 undefined：未设置；male：男性；female：女性；secrecy：保密 需额外获取字段权限：查询用户的性别（应用授权）kso.user_gender.read
∟ ∟ ∟ id	string	用户 id
∟ ∟ ∟ phone	string	手机号码 需额外获取字段权限：查询用户的手机号（应用授权）kso.user_phone.read
∟ ∟ ∟ role	string[enum]	用户角色 super-admin：超级管理员；admin：普通管理员；normal：普通用户
∟ ∟ ∟ status	string[enum]	用户状态 active：正常；notactive：未激活；disabled：禁用；dimission：离职
∟ ∟ ∟ telephone	string	座机
∟ ∟ ∟ title	string	职务信息
∟ ∟ ∟ user_name	string	账号
∟ ∟ ∟ work_place	string	办公地点
∟ ∟ ∟ def_dept_id	string	主部门id

响应体示例

{
  "data": {
    "items": [
      {
        "ctime": 0,
        "dept_id": "string",
        "is_leader": false,
        "mtime": 0,
        "order": 0,
        "user_id": "string",
        "user_info": {
          "avatar": "string",
          "city": "string",
          "country": "string",
          "email": "string",
          "employee_id": "string",
          "employer": "string",
          "employment_status": "string",
          "employment_type": "string",
          "gender": "string[enum]",
          "id": "string",
          "phone": "string",
          "role": "string[enum]",
          "status": "string[enum]",
          "telephone": "string",
          "title": "string",
          "user_name": "string",
          "work_place": "string",
          "def_dept_id": "string"
        }
      }
    ]
  },
  "msg": "string",
  "code": 0
}