主题
短信模版、日志与回调
SYS-SMS-02 | 模块
system| 维护短信模版并记录每条短信的发送结果,同时接收服务商的状态回执。
1. 使用角色与场景
角色:管理员、运维
- 新增验证码模版并提交审核
- 按手机号查短信是否送达
- 接收运营商回执更新状态
2. 接口与权限点
| 方法 | 路径 | 权限点 | 摘要 | 代码行 |
|---|---|---|---|---|
| POST | /system/sms-template/create | system:sms-template:create | 创建短信模板 | SmsTemplateController#L43 |
| PUT | /system/sms-template/update | system:sms-template:update | 更新短信模板 | SmsTemplateController#L50 |
| DELETE | /system/sms-template/delete | system:sms-template:delete | 删除短信模板 | SmsTemplateController#L58 |
| DELETE | /system/sms-template/delete-list | system:sms-template:delete | 批量删除短信模板 | SmsTemplateController#L67 |
| GET | /system/sms-template/get | system:sms-template:query | 获得短信模板 | SmsTemplateController#L76 |
| GET | /system/sms-template/page | system:sms-template:query | 获得短信模板分页 | SmsTemplateController#L85 |
| GET | /system/sms-template/list-all-simple | — | 获得短信模板精简列表 | SmsTemplateController#L93 |
| GET | /system/sms-template/simple-list | — | 获得短信模板精简列表 | SmsTemplateController#L93 |
| GET | /system/sms-template/export-excel | system:sms-template:export | 导出短信模板 Excel | SmsTemplateController#L101 |
| POST | /system/sms-template/send-sms | system:sms-template:send-sms | 发送短信 | SmsTemplateController#L114 |
| GET | /system/sms-log/page | system:sms-log:query | 获得短信日志分页 | SmsLogController#L41 |
| GET | /system/sms-log/get | system:sms-log:query | 获得短信日志 | SmsLogController#L49 |
| GET | /system/sms-log/export-excel | system:sms-log:export | 导出短信日志 Excel | SmsLogController#L58 |
| POST | /system/sms/callback/aliyun | — | 阿里云短信的回调 | SmsCallbackController#L26 |
| POST | /system/sms/callback/tencent | — | 腾讯云短信的回调 | SmsCallbackController#L36 |
| POST | /system/sms/callback/huawei | — | 华为云短信的回调 | SmsCallbackController#L47 |
| POST | /system/sms/callback/qiniu | — | 七牛云短信的回调 | SmsCallbackController#L56 |
3. 代码定位
| 层 | 位置 |
|---|---|
| Controller | modules/system/src/main/java/com/pmforge/module/system/controller/admin/sms/SmsTemplateController.java#L43 |
| Controller | modules/system/src/main/java/com/pmforge/module/system/controller/admin/sms/SmsLogController.java#L41 |
| Controller | modules/system/src/main/java/com/pmforge/module/system/controller/admin/sms/SmsCallbackController.java#L26 |
| DO | modules/system/src/main/java/com/pmforge/module/system/dal/dataobject/sms/SmsTemplateDO.java |
| DO | modules/system/src/main/java/com/pmforge/module/system/dal/dataobject/sms/SmsLogDO.java |
| DO | modules/system/src/main/java/com/pmforge/module/system/dal/dataobject/sms/SmsCodeDO.java |
4. 数据表
| 表 | DO |
|---|---|
system_sms_template | SmsTemplateDO |
system_sms_log | SmsLogDO |
system_sms_code | SmsCodeDO |
5. 机制与配置
- 模版参数为 JSON;发送结果异步回写
- 验证码单独存 Redis 并设有效期
6. 常见问题与排查
- 回调接口需放行鉴权,同时校验签名防伪造
7. 关联
- 需求原件:01-07-消息通知
- 相关卡片:SYS-SMS-01