wecom_it_smart_desk/docs/01-产品文档/05-用户端H5/PRD-REQ-用户-004-坐席在线状态查询-v1.0.md

PRD-REQ-用户-004-坐席在线状态查询-v1.0

基本信息

字段	内容
需求编号	REQ-用户-004
版本	v1.2
日期	2026-07-25
状态	已实现（BUG-用户-001 已修复）
作者	Simon
关联模块	05-用户端H5

---

1. 需求描述

1.1 背景

当前 H5 员工端的标题栏显示"坐席在线"状态是硬编码为 true（始终显示在线），无法反映真实的坐席在线状态。

用户希望在 H5 员工端能够显示真实的坐席在线/离线状态，供员工判断是否有人工坐席可提供服务。

1.2 目标

• H5 员工端能够查询并显示真实的坐席在线/离线状态
• 定时轮询获取状态，无需用户手动刷新

---

2. 用户故事

序号	角色	故事	优先级
US1	员工	作为员工，我希望在 H5 员工端看到坐席是否在线，以便判断是否需要转人工	P0

---

3. 功能需求

3.1 API 设计

3.1.1 接口路径

GET /h5/agents/online-status

3.1.2 请求参数

无（公开接口，无需认证）

3.1.3 响应格式

{
  "code": 0,
  "message": "success",
  "data": {
    "online": true
  }
}

字段	类型	说明
online	boolean	是否有在线坐席（true=有在线坐席，false=无在线坐席）

3.1.4 业务逻辑

• 查询 agents 表中 status = 'online' 的记录数量
• 有在线坐席（数量 > 0）返回 online: true
• 无在线坐席（数量 = 0）返回 online: false

3.2 前端轮询设计

3.2.1 轮询机制

• 页面加载时立即查询一次
• 之后每 30 秒自动查询一次
• 页面不可见时（如切换到其他标签页）暂停轮询
• 页面恢复可见时立即查询一次

3.2.2 状态显示

后端返回	前端显示
online: true	🟢 坐席在线
online: false	⚪ 坐席离线

---

4. 验收标准

序号	验收条件	验证方式
AC1	调用 /api/h5/agents/online-status 返回正确的 JSON 格式	手动 curl 测试
AC2	当数据库有 status='online' 的坐席时，返回 online: true	手动测试
AC3	当数据库没有 status='online' 的坐席时，返回 online: false	手动测试
AC4	H5 页面显示正确的在线/离线状态	浏览器验证
AC5	轮询机制正常工作，每30秒更新状态	浏览器验证
AC6	坐席离线时，H5 "人工咨询"按钮显示为不可用状态，提示"坐席离线，暂不可用"	浏览器验证
AC7	坐席离线时，后端呼叫人工接口拒绝入队，返回错误提示	手动 curl 测试

---

5. Non-goals

• 不返回在线坐席的具体数量
• 不返回在线坐席的详细信息列表
• 不支持 WebSocket 推送（后续迭代考虑）

---

6. 技术约束

• H5 员工端未登录，无法复用现有的 /api/agents 接口（需要认证）
• 需要新增公开接口，不依赖用户认证

---

7. 风险与依赖

风险	影响	缓解措施
轮询频率过高	增加服务器压力	限制为 30 秒
接口被恶意调用	无（只读数据）	-

---

8. 变更记录

日期	版本	变更内容	变更人
2026-07-25	v1.0	初始版本	Simon
2026-07-25	v1.1	修正 API 路径（/api/h5/ → /h5/）；补充 WS 断连自动离线逻辑；Nginx 路由配置；状态更新为已实现	Simon
2026-07-25	v1.2	BUG-用户-001 修复：增加坐席离线时限制呼叫人工的验收标准（AC6/AC7）；关联 BUG-用户-001	Simon