Skip to content

短信配置

短信配置用于接入第三方短信服务商,并通过模板化方式发送验证码、审批提醒、业务通知等短信。RuoYi Office 当前管理端包含短信渠道、短信模板和短信日志三类页面。

本地实现位置

位置
短信渠道页面ruoyi-office-vben/apps/web-antd/src/views/system/sms/channel
短信模板页面views/system/sms/template
短信日志页面views/system/sms/log
后端 ControllerSmsChannelController.javaSmsTemplateController.javaSmsLogController.javaSmsCallbackController.java
发送服务SmsSendService

发送链路

短信渠道

短信渠道保存服务商接入信息,例如渠道编码、签名、访问密钥、回调地址和状态。管理端支持新增、编辑、删除、批量删除和分页查询。

常见接口:

操作接口权限标识
创建渠道POST /system/sms-channel/createsystem:sms-channel:create
更新渠道PUT /system/sms-channel/updatesystem:sms-channel:update
删除渠道DELETE /system/sms-channel/deletesystem:sms-channel:delete
渠道分页GET /system/sms-channel/page页面查询使用
精简列表GET /system/sms-channel/list-all-simple/simple-list模板下拉使用

短信模板

短信模板定义模板编号、模板 code、模板内容、参数和绑定渠道。页面支持新增、编辑、删除、批量删除、导出和测试发送。

操作接口权限标识
创建模板POST /system/sms-template/createsystem:sms-template:create
更新模板PUT /system/sms-template/updatesystem:sms-template:update
删除模板DELETE /system/sms-template/deletesystem:sms-template:delete
模板分页GET /system/sms-template/page页面查询使用
导出模板GET /system/sms-template/export-excelsystem:sms-template:export
测试发送POST /system/sms-template/send-smssystem:sms-template:send-sms

测试发送当前通过 SmsSendService#sendSingleSmsToAdmin 发送到指定手机号,适合验证渠道、签名和模板参数是否正确。

短信日志

短信日志记录每一次发送请求、接收手机号、模板、渠道、发送状态、服务商返回结果等信息。页面支持分页、详情和导出。

操作接口权限标识
日志分页GET /system/sms-log/page页面查询使用
日志详情GET /system/sms-log/get页面查询使用
导出日志GET /system/sms-log/export-excelsystem:sms-log:export

接入建议

  1. 先渠道,后模板:模板通常需要绑定渠道和服务商模板编号。
  2. 模板参数保持一致:平台模板内容、服务商模板参数、业务 templateParams 三者名称要一致。
  3. 测试发送再接业务:新渠道上线前先在模板页面测试,确认签名、密钥、模板审核都正常。
  4. 关注回调与日志:服务商回调能补齐最终送达状态,排查时以短信日志为准。

排查清单

现象排查方向
发送失败检查渠道密钥、签名、模板编号和服务商审核状态
参数未替换检查模板参数名与业务传参是否一致
日志没有记录检查业务是否调用 SmsSendService,以及是否被异常提前中断
服务商显示成功但系统未知检查回调地址和 SmsCallbackController 可访问性
联系我们

获取报价、演示和二开方案

微信咨询二维码

微信咨询

17156169080

添加时备注「RuoYi Office」

在线体验商业版