慧企星助开放平台文档

员工接口

员工接口用于查询当前企业员工及其开放平台映射信息。返回手机号已脱敏。

GET /api/openplatform/employees

查询当前企业员工分页列表。

查询参数

参数	类型	必填	说明
`page`	int	否	页码，默认 1。
`pageSize`	int	否	每页条数，默认 20，最大 100。
`keyword`	string	否	按员工姓名或拼音模糊查询。

响应示例

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "total": 1,
    "items": [
      {
        "virtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
        "name": "张三",
        "phone": "138****5678",
        "departmentName": "运营部",
        "positionName": "运营经理",
        "isBound": true
      }
    ]
  }
}

响应字段

员工列表的 data.items 单项与员工详情的 data 使用相同的 Employee 结构。

字段	类型	说明
`data.total`	long	列表接口的员工总数。
`data.page`	int	列表接口当前页码，从 1 开始。
`data.pageSize`	int	列表接口当前页返回条数上限，范围为 1 到 100。
`data.items`	Employee[]	列表接口当前页员工数据。
`virtualId`	string	员工在当前企业和 API Key 维度的公开稳定标识。
`name`	string	员工姓名。
`phone`	string	脱敏手机号。
`departmentName`	string	部门名称；未设置时为空字符串。
`positionName`	string	岗位名称；未设置时为空字符串。
`isBound`	bool	当前 API Key 下是否已存在第三方账号绑定关系。

字段说明：virtualId 在当前企业 + 当前 API Key 维度唯一且稳定，由平台按算法实时生成；重置 ApiSecret 不会改变同一员工在当前 API Key 下的 virtualId。isBound 表示当前 API Key 下是否已存在第三方账号绑定关系。

GET /api/openplatform/employees/{virtualId}

按 virtualId 查询员工详情。

响应示例

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "virtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
    "name": "张三",
    "phone": "138****5678",
    "departmentName": "运营部",
    "positionName": "运营经理",
    "isBound": true
  }
}

响应字段：详情 data 返回一个 Employee 对象，字段、类型和含义见员工列表下方“响应字段”表。