# 用户中心模块

API域名以及签名统一签名, 此模块路由地址为/open/v6, 旧版本路由可以继续使用

全局响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	Object	返回数据
message	String	错误信息

# 一、用户管理

# 1、根据修改时间增量获取用户信息

（1）接口地址:/user/list

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
pageNo	Integer	true	当前页数
pageSize	Integer	true	每页条数,最大为200
endUpdateTime	String	false	截止更新时间，开始时间与结束时间相差不能超过3天
isValid	Integer	false	数据是否有效，1表示有效，0表示无效
startUpdateTime	String	false	开始更新时间，开始时间与结束时间相差不能超过3天，开始时间不得早与当前时间30天
username	String	false	员工姓名

（6）请求示例:

/user/list?pageNo=1&amp;pageSize=200

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	Object	返回数据
└ data	List	用户基本信息列表
└ avatar	String	头像url
└ createTime	String	创建时间
└ department	String	部门列表
└ email	String	个人邮箱
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ jobNumber	String	工号
└ mainDeptId	Long	主部门id
└ mobile	String	手机号码
└ nick	String	用户昵称（花名）
└ orgEmail	String	企业邮箱
└ updateTime	String	更新时间
└ userId	String	员工id
└ username	String	员工姓名
└ workPosition	String	职位信息
└ pageNo	Long	当前页数
└ pageSize	Long	每页条数
└ pages	Long	总页数
└ total	Long	总数
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "data": [
      {
        "avatar": "",
        "createTime": "",
        "department": "",
        "email": "",
        "isValid": 0,
        "jobNumber": "",
        "mainDeptId": 0,
        "mobile": "",
        "nick": "",
        "orgEmail": "",
        "updateTime": "",
        "userId": "",
        "username": "",
        "workPosition": ""
      }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "pages": 0,
    "total": 0
  },
  "message": ""
}

# 2、查询单个用户信息

（1）接口地址:/user

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
jobNumber	String	false	工号
userId	String	false	员工id

（6）请求示例:

/user?jobNumber=

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	Object	用户基本信息
└ avatar	String	头像url
└ createTime	String	创建时间
└ department	String	部门列表,多部门英文逗号分隔
└ email	String	个人邮箱
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ jobNumber	String	工号
└ mainDeptId	Long	主部门id
└ mobile	String	手机号码
└ nick	String	用户昵称（花名）
└ orgEmail	String	企业邮箱
└ updateTime	String	更新时间
└ userId	String	员工id
└ username	String	员工姓名
└ workPosition	String	职位信息
└ feiShuUser	Object	飞书用户信息
└ avatar	String	用户头像信息
└ createTime	String	创建时间
└ departmentIds	String	用户所属部门的列表（open_department_id）
└ email	String	邮箱
└ employeeNo	String	员工工号
└ employeeType	Integer	员工类型 1:正式员工 2:实习生 3:外包 4:劳务 5:顾问
└ enName	String	英文名
└ enterpriseEmail	String	企业邮箱
└ feiShuUserId	String	飞书用户id
└ gender	Integer	性别 0:保密、1:男、2:女
└ jobTitle	String	职务
└ joinTime	String	入职日期
└ leaderUserId	String	用户的直接主管
└ name	String	用户名
└ nickname	String	昵称/别名
└ status	String	用户状态信息
└ unionId	String	飞书用户unionId
└ updateTime	String	更新时间
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "avatar": "",
    "createTime": "",
    "department": "",
    "email": "",
    "isValid": 1,
    "jobNumber": "",
    "mainDeptId": 0,
    "mobile": "",
    "nick": "",
    "orgEmail": "",
    "updateTime": "",
    "userId": "",
    "username": "",
    "workPosition": "",
    "feiShuUser": {
      "avatar": "",
      "createTime": "",
      "departmentIds": "",
      "email": "",
      "employeeNo": "",
      "employeeType": 0,
      "enName": "",
      "enterpriseEmail": "",
      "feiShuUserId": "",
      "gender": 0,
      "jobTitle": "",
      "joinTime": "",
      "leaderUserId": "",
      "name": "",
      "nickname": "",
      "status": "",
      "unionId": "",
      "updateTime": ""
    }
  },
  "message": ""
}

# 3、查询用户手机号码

（1）接口地址:/user/getMobile

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
userId	String	true	员工id

（6）请求示例:

/user/getMobile?userId=

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	Object	返回数据
└ mobile	String	手机号码
└ userId	String	员工id
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": {
    "mobile": "",
    "userId": ""
  },
  "message": ""
}

# 4、根据部门查询用户信息

（1）接口地址:/user/getUserListByDeptId

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
deptId	Long	true	部门id
isValid	Integer	false	数据是否有效，1表示有效，0表示无效

（6）请求示例:

/user/getUserListByDeptId?deptId=

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	List	用户基本信息列表
└ avatar	String	头像url
└ createTime	String	创建时间
└ department	String	部门列表
└ email	String	个人邮箱
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ jobNumber	String	工号
└ mainDeptId	Long	主部门id
└ mobile	String	手机号码
└ nick	String	用户昵称（花名）
└ orgEmail	String	企业邮箱
└ updateTime	String	更新时间
└ userId	String	员工id
└ username	String	员工姓名
└ workPosition	String	职位信息
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": [
    {
      "avatar": "",
      "createTime": "",
      "department": "",
      "email": "",
      "isValid": 0,
      "jobNumber": "",
      "mainDeptId": 0,
      "mobile": "",
      "nick": "",
      "orgEmail": "",
      "updateTime": "",
      "userId": "",
      "username": "",
      "workPosition": ""
    }
  ],
  "message": ""
}

# 二、部门管理

# 1、根据变更时间增量查询部门信息

（1）接口地址:/dept/list

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
endUpdateTime	String	false	截止更新时间，开始时间与结束时间相差不能超过3天
isValid	Integer	false	数据是否有效，1表示有效，0表示无效
startUpdateTime	String	false	开始更新时间，开始时间与结束时间相差不能超过3天，开始时间不得早与当前时间30天

（6）请求示例:

/dept/list?startUpdateTime=&amp;endUpdateTime=

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	List	部门信息列表
└ createTime	String	创建时间
└ deptId	Long	部门id
└ deptManagerUserIdList	String	管理员列表
└ deptName	String	部门名称
└ hasSubDept	Boolean	是否有子部门
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ parentId	Long	父部门id
└ sort	Long	排序值
└ updateTime	String	更新时间
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": [
    {
      "createTime": "",
      "deptId": 0,
      "deptManagerUserIdList": "",
      "deptName": "",
      "hasSubDept": true,
      "isValid": 1,
      "parentId": 0,
      "sort": 0,
      "updateTime": ""
    }
  ],
  "message": ""
}

# 2、获取用户的所属部门信息

（1）接口地址:/dept/listByUserId

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
userId	String	true	员工id

（6）请求示例:

/dept/listByUserId?userId=

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	List	部门信息列表
└ createTime	String	创建时间
└ deptId	Long	部门id
└ deptManagerUserIdList	String	管理员列表
└ deptName	String	部门名称
└ feiShuDept	Object	飞书部门信息
└ chatId	String	部门群ID
└ createTime	String	创建时间
└ departmentId	String	飞书部门 department_id
└ deptId	Long	部门id
└ leaderUserId	String	部门主管用户union_id
└ name	String	部门名称
└ openDepartmentId	String	飞书部门 open_department_id
└ orders	String	排序信息
└ parentDepartmentId	String	飞书部门父节点 open_department_id
└ status	String	状态信息
└ updateTime	String	更新时间
└ hasSubDept	Boolean	是否有子部门
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ parentId	Long	父部门id
└ sort	Long	排序值
└ updateTime	String	更新时间
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": [
    {
      "createTime": "",
      "deptId": 0,
      "deptManagerUserIdList": "",
      "deptName": "",
      "feiShuDept": {
        "chatId": "",
        "createTime": "",
        "departmentId": "",
        "deptId": 0,
        "leaderUserId": "",
        "name": "",
        "openDepartmentId": "",
        "orders": "",
        "parentDepartmentId": "",
        "status": "",
        "updateTime": ""
      },
      "hasSubDept": true,
      "isValid": 0,
      "parentId": 0,
      "sort": 0,
      "updateTime": ""
    }
  ],
  "message": ""
}

# 3、获取父部门信息

（1）接口地址:/dept/parent/{deptId}

（2）请求方式:GET

（3）请求数据类型:application/x-www-form-urlencoded

（4）响应数据类型:application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
deptId	Long	true	部门id,路径参数

（6）请求示例:

/dept/parent/1

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	List	部门信息列表
└ createTime	String	创建时间
└ deptId	Long	部门id
└ deptManagerUserIdList	String	管理员列表
└ deptName	String	部门名称
└ feiShuDept	Object	飞书部门信息
└ chatId	String	部门群ID
└ createTime	String	创建时间
└ departmentId	String	飞书部门 department_id
└ deptId	Long	部门id
└ leaderUserId	String	部门主管用户union_id
└ name	String	部门名称
└ openDepartmentId	String	飞书部门 open_department_id
└ orders	String	排序信息
└ parentDepartmentId	String	飞书部门父节点 open_department_id
└ status	String	状态信息
└ updateTime	String	更新时间
└ hasSubDept	Boolean	是否有子部门
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ parentId	Long	父部门id
└ sort	Long	排序值
└ updateTime	String	更新时间
message	String	错误信息

（8）响应示例:

{
  "code": 0,
  "data": [
    {
      "createTime": "",
      "deptId": 0,
      "deptManagerUserIdList": "",
      "deptName": "",
      "feiShuDept": {
        "chatId": "",
        "createTime": "",
        "departmentId": "",
        "deptId": 0,
        "leaderUserId": "",
        "name": "",
        "openDepartmentId": "",
        "orders": "",
        "parentDepartmentId": "",
        "status": "",
        "updateTime": ""
      },
      "hasSubDept": true,
      "isValid": 0,
      "parentId": 0,
      "sort": 0,
      "updateTime": ""
    }
  ],
  "message": ""
}

# 4、获取子部门信息

（1）接口描述:只获取下一级，根部门id为1

（2）接口地址:/dept/sub/{deptId}

（3）请求方式:GET

（4）请求数据类型:application/x-www-form-urlencoded

（5）响应数据类型:application/json

（6）请求参数:

参数名称	数据类型	是否必须	参数说明
deptId	Long	true	部门id,路径参数

（7）请求示例:

/dept/sub/1

（8）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	List	部门信息列表
└ createTime	String	创建时间
└ deptId	Long	部门id
└ deptManagerUserIdList	String	管理员列表
└ deptName	String	部门名称
└ feiShuDept	Object	飞书部门信息
└ chatId	String	部门群ID
└ createTime	String	创建时间
└ departmentId	String	飞书部门 department_id
└ deptId	Long	部门id
└ leaderUserId	String	部门主管用户union_id
└ name	String	部门名称
└ openDepartmentId	String	飞书部门 open_department_id
└ orders	String	排序信息
└ parentDepartmentId	String	飞书部门父节点 open_department_id
└ status	String	状态信息
└ updateTime	String	更新时间
└ hasSubDept	Boolean	是否有子部门
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ parentId	Long	父部门id
└ sort	Long	排序值
└ updateTime	String	更新时间
message	String	错误信息

（9）响应示例:

{
  "code": 0,
  "data": [
    {
      "createTime": "",
      "deptId": 0,
      "deptManagerUserIdList": "",
      "deptName": "",
      "feiShuDept": {
        "chatId": "",
        "createTime": "",
        "departmentId": "",
        "deptId": 0,
        "leaderUserId": "",
        "name": "",
        "openDepartmentId": "",
        "orders": "",
        "parentDepartmentId": "",
        "status": "",
        "updateTime": ""
      },
      "hasSubDept": true,
      "isValid": 0,
      "parentId": 0,
      "sort": 0,
      "updateTime": ""
    }
  ],
  "message": ""
}

# 5、根据部门id获取部门信息

（1）接口描述:根部门id为1

（2）接口地址:/dept/{deptId}

（3）请求方式:GET

（4）请求数据类型:application/x-www-form-urlencoded

（5）响应数据类型:application/json

（6）请求参数:

参数名称	数据类型	是否必须	参数说明
deptId	Long	true	部门id,路径参数

（7）请求示例:

/dept/1

（8）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功其他失败
data	Object	部门信息
└ createTime	String	创建时间
└ deptId	Long	部门id
└ deptManagerUserIdList	String	管理员列表
└ deptName	String	部门名称
└ feiShuDept	Object	飞书部门信息
└ chatId	String	部门群ID
└ createTime	String	创建时间
└ departmentId	String	飞书部门 department_id
└ deptId	Long	部门id
└ leaderUserId	String	部门主管用户union_id
└ name	String	部门名称
└ openDepartmentId	String	飞书部门 open_department_id
└ orders	String	排序信息
└ parentDepartmentId	String	飞书部门父节点 open_department_id
└ status	String	状态信息
└ updateTime	String	更新时间
└ hasSubDept	Boolean	是否有子部门
└ isValid	Integer	数据是否有效，1表示有效，0表示无效
└ parentId	Long	父部门id
└ sort	Long	排序值
└ updateTime	String	更新时间
message	String	错误信息

（9）响应示例:

{
  "code": 0,
  "data": {
    "createTime": "",
    "deptId": 0,
    "deptManagerUserIdList": "",
    "deptName": "",
    "feiShuDept": {
      "chatId": "",
      "createTime": "",
      "departmentId": "",
      "deptId": 0,
      "leaderUserId": "",
      "name": "",
      "openDepartmentId": "",
      "orders": "",
      "parentDepartmentId": "",
      "status": "",
      "updateTime": ""
    },
    "hasSubDept": true,
    "isValid": 0,
    "parentId": 0,
    "sort": 0,
    "updateTime": ""
  },
  "message": ""
}

← 渠道库存模块百胜对接模块 →