{ "generatedAt": "2026-04-22 17:06:29", "generatedAtLocal": "2026-04-22 17:06:29", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "账号管理模块", "key": "setting.account", "folder": "setting.account", "interfaceCount": 6 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "setting.account.list", "title": "查询当前主体下的工号基础信息列表", "description": "查询当前主体下的工号基础信息列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "status", "type": "number", "required": false, "description": "状态筛选,默认 1,仅查有效工号" }, { "name": "includeDisabled", "type": "boolean", "required": false, "description": "是否包含已删除工号" } ], "response": [ { "name": "data[]", "type": "object", "required": true, "description": "工号列表项" }, { "name": "data[].employee_id", "type": "number", "required": true, "description": "工号ID" }, { "name": "data[].account_id", "type": "number", "required": true, "description": "账号ID" }, { "name": "data[].store_id", "type": "number", "required": true, "description": "主体ID" }, { "name": "data[].real_name", "type": "string", "required": true, "description": "工号姓名" }, { "name": "data[].status", "type": "number", "required": true, "description": "工号状态:1=启用,0=停用" }, { "name": "data[].username", "type": "string", "required": true, "description": "账号用户名" }, { "name": "data[].phone", "type": "string", "required": true, "description": "账号手机号" }, { "name": "data[].email", "type": "string", "required": true, "description": "账号邮箱" }, { "name": "data[].avatar_file_id", "type": "number", "required": false, "description": "头像文件ID,为空表示未设置" }, { "name": "data[].avatar_url", "type": "string", "required": true, "description": "头像访问地址" } ] }, { "method": "setting.account.add", "title": "新增工号,按手机号复用或创建账号后绑定到当前主体", "description": "新增工号,按手机号复用或创建账号后绑定到当前主体", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "phone", "type": "string", "required": true, "description": "手机号,作为账号复用/创建依据" }, { "name": "real_name", "type": "string", "required": true, "description": "工号姓名,新增时禁止直接使用保留名称" }, { "name": "username", "type": "string", "required": false, "description": "新账号用户名,不传时系统自动生成" }, { "name": "password", "type": "string", "required": false, "description": "新账号密码,不传默认 111111" }, { "name": "role_id", "type": "number", "required": false, "description": "工号角色,不传时继承当前操作人工号角色" }, { "name": "email", "type": "string", "required": false, "description": "新账号邮箱,不传时按 username 自动生成" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "新增或复用后的工号ID" }, { "name": "account_id", "type": "number", "required": true, "description": "绑定账号ID" }, { "name": "role_id", "type": "number", "required": true, "description": "绑定后的角色ID" }, { "name": "is_new_account", "type": "boolean", "required": true, "description": "是否为本次新建账号" }, { "name": "phone", "type": "string", "required": true, "description": "绑定账号手机号" }, { "name": "username", "type": "string", "required": true, "description": "绑定账号用户名" } ] }, { "method": "setting.account.delete", "title": "删除工号绑定关系,仅停用工号,不删除账号", "description": "删除工号绑定关系,仅停用工号,不删除账号", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "employee_id", "type": "number", "required": true, "description": "要删除的工号ID" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "被停用的工号ID" }, { "name": "account_id", "type": "number", "required": true, "description": "关联账号ID" }, { "name": "status", "type": "string", "required": true, "description": "固定返回 deleted" }, { "name": "already_deleted", "type": "boolean", "required": false, "description": "可选,true 表示该工号原本已停用" } ] }, { "method": "setting.account.update", "title": "更新工号姓名和头像引用", "description": "更新工号姓名和头像引用", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "employee_id", "type": "number", "required": true, "description": "要更新的工号ID" }, { "name": "real_name", "type": "string", "required": false, "description": "更新后的工号姓名" }, { "name": "file_id", "type": "number", "required": false, "description": "已有文件ID,作为头像引用" } ], "response": [ { "name": "employee_id", "type": "number", "required": true, "description": "更新后的工号ID" }, { "name": "real_name", "type": "string", "required": true, "description": "更新后的工号姓名" }, { "name": "avatar_file_id", "type": "number", "required": false, "description": "更新后的头像文件ID" }, { "name": "avatar_url", "type": "string", "required": true, "description": "更新后的头像地址" } ] }, { "method": "setting.account.getBindWechatCode", "title": "为指定工号账号获取微信绑定码", "description": "为指定工号账号获取微信绑定码", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "account_id", "type": "number", "required": true, "description": "目标账号ID,兼容 user_id / id" }, { "name": "longPoll", "type": "boolean", "required": false, "description": "是否开启长轮询等待状态变化,最长60秒" }, { "name": "waitTimeoutMs", "type": "number", "required": false, "description": "等待超时毫秒数,后端自动封顶60000" } ], "response": [] }, { "method": "setting.account.unbindWechat", "title": "为指定工号账号解绑微信", "description": "为指定工号账号解绑微信", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "account_id", "type": "number", "required": true, "description": "目标账号ID,兼容 user_id / id" } ], "response": [] } ] }