# 用户中心

API域名以及签名统一签名, 此模块路由地址为/open/v6

全局响应状态:

参数名称	类型	参数说明
code	integer	0:成功其他失败
data	boolean
message	string	错误信息

# 用户管理-根据修改时间增量获取用户信息

接口地址:/user/list

请求方式:GET

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

响应数据类型:application/json

请求参数:

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

响应参数:

参数名称	参数说明	类型	schema
data		array	用户基本信息
avatar	头像url	string
createTime	创建时间	string
department	部门列表	string
email	个人邮箱	string
isValid	数据是否有效，1表示有效，0表示无效	integer
jobNumber	工号	string
mainDeptId	主部门id	integer
mobile	手机号码	string
nick	用户昵称（花名）	string
orgEmail	企业邮箱	string
updateTime	更新时间	string
userId	员工id	string
username	员工姓名	string
workPosition	职位信息	string
pageNo		integer(int64)
pageSize		integer(int64)
pages		integer(int64)
total		integer(int64)

响应示例:

{
  "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
  },
  "errCode": "",
  "errMsg": "",
  "message": ""
}

# 用户管理-查询单个用户信息

接口地址:/user

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
jobNumber	jobNumber	query	false	string
userId	userId	query	false	string

响应参数:

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

响应示例:

{
  "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": "",
      "userId": ""
    }
  },
  "errCode": "",
  "errMsg": "",
  "message": ""
}

# 用户管理-查询用户手机号码

接口地址:/user/getMobile

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	string

响应参数:

参数名称	参数说明	类型	schema
mobile	手机号码	string
userId	员工id	string

响应示例:

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

# 用户管理-根据部门查询用户信息

接口地址:/user/getUserListByDeptId

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deptId	deptId	query	true	Long
isValid	isValid	query	false	Integer

响应参数:

参数名称	参数说明	类型
avatar	头像url	string
createTime	创建时间	string(date-time)
department	部门列表	string
email	个人邮箱	string
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
jobNumber	工号	string
mainDeptId	主部门id	integer(int64)
mobile	手机号码	string
nick	用户昵称（花名）	string
orgEmail	企业邮箱	string
updateTime	更新时间	string(date-time)
userId	员工id	string
username	员工姓名	string
workPosition	职位信息	string

响应示例:

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

# 部门管理-根据变更时间增量查询部门信息

接口地址:/dept/list

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
endUpdateTime	截止更新时间，开始时间与结束时间相差不能超过3天	query	false	string(date-time)
isValid	数据是否有效，1表示有效，0表示无效	query	false	integer(int32)
startUpdateTime	开始更新时间，开始时间与结束时间相差不能超过3天，开始时间不得早与当前时间30天	query	false	string(date-time)

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
deptId	部门id	integer(int64)
deptManagerUserIdList	管理员列表	string
deptName	部门名称	string
hasSubDept	是否有子部门	boolean
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
parentId	父部门id	integer(int64)
sort	排序值	integer(int64)
updateTime	更新时间	string(date-time)

响应示例:

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

# 部门管理-获取用户的所属部门信息

接口地址:/dept/listByUserId

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
userId	userId	query	true	string

响应参数:

参数名称	参数说明	类型	schema
createTime	创建时间	string(date-time)
deptId	部门id	integer(int64)
deptManagerUserIdList	管理员列表	string
deptName	部门名称	string
feiShuDept	飞书部门信息	飞书部门信息	飞书部门信息
chatId	部门群ID	string
createTime	创建时间	string
departmentId	飞书部门 department_id	string
deptId	部门id	integer
leaderUserId	部门主管用户union_id	string
name	部门名称	string
openDepartmentId	飞书部门 open_department_id	string
orders	排序信息	string
parentDepartmentId	飞书部门父节点 open_department_id	string
status	状态信息	string
updateTime	更新时间	string
hasSubDept	是否有子部门	boolean
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
parentId	父部门id	integer(int64)
sort	排序值	integer(int64)
updateTime	更新时间	string(date-time)

响应示例:

{
  "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": ""
    }
  ],
  "errCode": "",
  "errMsg": "",
  "message": ""
}

# 部门管理-获取父部门信息

接口地址:/dept/parent/{deptId}

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deptId	deptId	path	true	integer(int64)

响应参数:

参数名称	参数说明	类型	schema
createTime	创建时间	string(date-time)
deptId	部门id	integer(int64)
deptManagerUserIdList	管理员列表	string
deptName	部门名称	string
feiShuDept	飞书部门信息	飞书部门信息	飞书部门信息
chatId	部门群ID	string
createTime	创建时间	string
departmentId	飞书部门 department_id	string
deptId	部门id	integer
leaderUserId	部门主管用户union_id	string
name	部门名称	string
openDepartmentId	飞书部门 open_department_id	string
orders	排序信息	string
parentDepartmentId	飞书部门父节点 open_department_id	string
status	状态信息	string
updateTime	更新时间	string
hasSubDept	是否有子部门	boolean
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
parentId	父部门id	integer(int64)
sort	排序值	integer(int64)
updateTime	更新时间	string(date-time)

响应示例:

{
  "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": ""
    }
  ],
  "errCode": "",
  "errMsg": "",
  "message": ""
}

# 部门管理-获取子部门信息

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

接口地址:/dept/sub/{deptId}

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deptId	deptId	path	true	Long

响应参数:

参数名称	参数说明	类型	schema
createTime	创建时间	string(date-time)
deptId	部门id	integer(int64)
deptManagerUserIdList	管理员列表	string
deptName	部门名称	string
feiShuDept	飞书部门信息	飞书部门信息	飞书部门信息
chatId	部门群ID	string
createTime	创建时间	string
departmentId	飞书部门 department_id	string
deptId	部门id	integer
leaderUserId	部门主管用户union_id	string
name	部门名称	string
openDepartmentId	飞书部门 open_department_id	string
orders	排序信息	string
parentDepartmentId	飞书部门父节点 open_department_id	string
status	状态信息	string
updateTime	更新时间	string
hasSubDept	是否有子部门	boolean
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
parentId	父部门id	integer(int64)
sort	排序值	integer(int64)
updateTime	更新时间	string(date-time)

响应示例:

{
  "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": ""
    }
  ],
  "errCode": "",
  "errMsg": "",
  "message": ""
}

# 部门管理-根据部门id获取部门信息

接口描述:根部门id为1

接口地址:/dept/{deptId}

请求方式:GET

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

响应数据类型:application/json

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
deptId	deptId	path	true	integer(int64)

响应参数:

参数名称	参数说明	类型	schema
createTime	创建时间	string(date-time)
deptId	部门id	integer(int64)
deptManagerUserIdList	管理员列表	string
deptName	部门名称	string
feiShuDept	飞书部门信息	飞书部门信息	飞书部门信息
chatId	部门群ID	string
createTime	创建时间	string
departmentId	飞书部门 department_id	string
deptId	部门id	integer
leaderUserId	部门主管用户union_id	string
name	部门名称	string
openDepartmentId	飞书部门 open_department_id	string
orders	排序信息	string
parentDepartmentId	飞书部门父节点 open_department_id	string
status	状态信息	string
updateTime	更新时间	string
hasSubDept	是否有子部门	boolean
isValid	数据是否有效，1表示有效，0表示无效	integer(int32)
parentId	父部门id	integer(int64)
sort	排序值	integer(int64)
updateTime	更新时间	string(date-time)

响应示例:

{
  "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": ""
  },
  "errCode": "",
  "errMsg": "",
  "message": ""
}

← 渠道库存模块财务中台--百胜 →