慧企星助 开放平台文档

慧企星助 开放平台面向企业三方系统提供标准 HTTP API,支持员工、绑定关系、项目、目标与目标复盘、任务、通知、便签、标签、贡献点和附件上传能力。 所有接口默认只作用于当前 API Key 所属企业,权限由后端统一控制并在请求时强校验。

显示全部接口

员工接口

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

GET /api/openplatform/employees

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

查询参数

参数类型必填说明
pageint页码,默认 1。
pageSizeint每页条数,默认 20,最大 100。
keywordstring按员工姓名或拼音模糊查询。

响应示例

{
  "statusCode": 100,
  "msg": "获取成功",
  "data": {
    "total": 1,
    "items": [
      {
        "virtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
        "name": "张三",
        "phone": "138****5678",
        "departmentName": "运营部",
        "positionName": "运营经理",
        "isBound": true
      }
    ]
  }
}
字段说明:virtualId 在当前企业 + 当前 API Key 维度唯一且稳定,由平台按算法实时生成;重置 ApiSecret 不会改变同一员工在当前 API Key 下的 virtualIdisBound 表示当前 API Key 下是否已存在第三方账号绑定关系。
GET /api/openplatform/employees/{virtualId}

virtualId 查询员工详情。

响应示例

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