4.4 KiB
4.4 KiB
短信发送配置
本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。
上级文档:基础配置管理
配置清单
短信发送配置用于维护基础平台登录验证、账号通知、安全提醒等短信发送能力。
推荐配置:
| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 |
|---|---|---|---|
| 短信启用开关 | 是否启用短信发送能力 | 平台级 | 必须 |
| 短信服务商 | 当前使用的短信服务商 | 平台级 | 必须 |
| 访问凭证 | AccessKey、SecretKey 等调用凭证 | 平台级 | 必须 |
| 短信签名 | 短信服务商审核通过的签名 | 平台级 | 必须 |
| 默认区域 | 短信服务区域或 Region | 平台级 | 建议 |
| 发送频控 | 单手机号、单账号或单 IP 的发送频率限制 | 平台级 | 必须 |
| 短信模板 | 不同短信场景对应的模板编码和模板参数 | 平台级 | 必须 |
| 配置连通性测试 | 保存前或保存后测试短信服务是否可用 | 平台级 | 建议 |
支持的短信服务商:
| 服务商 | 说明 |
|---|---|
| 阿里云 | 阿里云短信服务 |
| 腾讯云 | 腾讯云短信服务 |
| 华为云 | 华为云短信服务 |
首版建议支持的短信模板场景:
| 模板场景 | 说明 |
|---|---|
| 登录验证码 | 用户短信验证码登录或二次验证 |
| 绑定手机号验证码 | 用户绑定或更换手机号 |
| 重置密码验证码 | 用户重置平台账号密码 |
| 账号开通通知 | 创建用户或账号后发送通知 |
| 安全提醒 | 异地登录、密码变更等安全提醒 |
界面设计
短信发送配置页用于维护短信服务商、短信签名、发送频控和短信模板。
展示方式:
- 采用上下结构展示。
- 上方为短信服务商配置表单。
- 下方为短信模板配置页签 / 表格。
- 页面底部固定操作按钮:取消、保存、测试发送。
表单字段:
| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 |
|---|---|---|---|
| 短信启用开关 | Switch | 人工选择 | 控制短信发送能力是否启用 |
| 短信服务商 | 下拉框 | 阿里云、腾讯云、华为云 | 必填 |
| Region | 文本输入框 / 下拉框 | 服务商区域或人工录入 | 建议填写 |
| AccessKey | 文本输入框 | 人工录入 | 必填,敏感字段 |
| SecretKey | 密码输入框 | 人工录入 | 必填,敏感字段 |
| 短信签名 | 文本输入框 | 人工录入 | 必填 |
| 单手机号发送间隔 | 数字输入框 + 单位选择 | 人工录入 | 建议配置 |
| 单手机号日发送上限 | 数字输入框 | 人工录入 | 建议配置 |
| 单 IP 日发送上限 | 数字输入框 | 人工录入 | 可选 |
| 备注 | 多行文本框 | 人工录入 | 选填 |
短信模板配置展示方式:
- 表格。
- 支持新增、编辑、启用、停用、删除模板。
- 新增 / 编辑模板采用弹窗表单。
短信模板字段:
| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 |
|---|---|---|---|
| 模板场景 | 下拉框 | 登录验证码、绑定手机号验证码、重置密码验证码、账号开通通知、安全提醒 | 必填 |
| 模板名称 | 文本输入框 | 人工录入 | 必填 |
| 服务商模板编号 | 文本输入框 | 人工录入 | 必填,服务商审核通过的模板编号 |
| 模板内容预览 | 多行文本框 | 人工录入 / 服务商模板内容复制 | 选填,仅用于查看 |
| 模板参数 | 标签输入 / 表格 | 人工录入 | 例如 code、userName、expireMinutes |
| 启用状态 | Switch | 人工选择 | 默认启用 |
| 备注 | 多行文本框 | 人工录入 | 选填 |
页面规则:
- 短信服务商、AccessKey、SecretKey、短信签名为必填。
- SecretKey 保存后不在页面明文回显,仅展示脱敏结果。
- 每个模板场景同一时间只能启用一个模板。
- 启用短信发送配置前,至少需要维护一个启用短信模板。
- 登录验证码、绑定手机号验证码、重置密码验证码属于验证码类模板,必须配置发送频控。
- 测试发送需要输入测试手机号和模板场景。
- 测试发送必须记录操作日志,但日志中不得记录验证码、SecretKey 等敏感内容。
- 停用短信发送配置时,需要提示短信验证码登录、手机号绑定、密码重置等能力可能不可用。