功能说明
提供小区短信发送使用明细查询接口,展示推送时间、名称、内容、状态、成功/失败数,支持分页,供前端弹框使用。
文件位置
- Controller: src/controller/smsUsageController.ts
- Service: src/service/smsUsageService.ts
- Model: src/model/smsUsageLog.ts
接口定义
| 请求方式 | GET |
| 请求路径 | /api/v1/sms/community/{id}/usage |
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| id | number | 是 | 小区ID |
| page/pageSize | number | 否 | 分页 |
响应格式
{
"code":200,
"data":{
"list":[{"pushTime":"2024-03-01 10:00","pushName":"营销短信","content":"xxx","status":1,"successCount":900,"failCount":100}],
"total":1
},
"message":"success"
}
业务逻辑
- 参数校验:id为正整数;分页默认page=1,pageSize=20
- 权限检查:需具备小区使用记录查看权限
- 数据处理:查询sms_usage_log按push_time倒序;返回推送时间、名称、内容、状态、成功/失败数
- 返回结果:列表和总数供前端分页
错误处理
| 400 | 参数错误 | 小区ID无效 |
| 403 | 无权限 | 无查看权限 |
| 404 | 数据不存在 | 小区不存在 |
验收标准
- 接口能返回该小区全部发送记录字段完整
- 分页生效,排序按推送时间倒序
- 异常参数时返回对应错误