阿里云短信服务配置说明
1. 前置准备
1.1 开通阿里云短信服务
- 登录阿里云控制台:https://www.aliyun.com/
- 开通短信服务(发送短信套餐包)
- 申请短信签名(如:停车管理系统)
- 申请短信模板(如:验证码模板)
1.2 获取AccessKey
- 在阿里云控制台,点击右上角头像
- 选择"AccessKey管理"
- 创建或查看AccessKey ID和AccessKey Secret
2. 配置修改
2.1 修改application.yml配置文件
在 src/main/resources/application.yml
文件中,找到阿里云短信配置部分:
# 阿里云短信服务配置
aliyun:sms:# 阿里云AccessKey ID(请替换为您的实际值)accessKeyId: your_access_key_id# 阿里云AccessKey Secret(请替换为您的实际值)accessKeySecret: your_access_key_secret# 短信签名名称(请替换为您申请的签名)signName: 停车管理系统# 短信模板代码(请替换为您申请的模板代码)templateCode: SMS_000000# 阿里云短信服务端点endpoint: dysmsapi.aliyuncs.com
2.2 配置参数说明
参数名 | 说明 | 示例值 |
accessKeyId | 阿里云AccessKey ID | LTAI4G... |
accessKeySecret | 阿里云AccessKey Secret | xxx... |
signName | 短信签名名称 | 停车管理系统 |
templateCode | 短信模板代码 | SMS_123456789 |
endpoint | 短信服务端点 | dysmsapi.aliyuncs.com |
3. 短信模板配置
3.1 验证码模板示例
您的验证码是:${code},5分钟内有效,请勿泄露。
3.2 模板变量说明
${code}
: 验证码变量,系统会自动生成6位数字验证码
4. API接口说明
4.1 发送短信验证码
- 接口地址:
POST /parking/sms/sendVerificationCode
- 参数:
phoneNumber
- 手机号
- 说明: 自动生成6位数字验证码并发送
4.2 发送自定义短信
- 接口地址:
POST /parking/sms/sendCustomMessage
- 参数:
-
phoneNumber
- 手机号
-
customSignName
- 自定义签名(可选)
-
customTemplateCode
- 模板代码
-
templateParam
- 模板参数(JSON格式)
4.3 批量发送短信
- 接口地址:
POST /parking/sms/sendBatchMessage
- 参数:
-
phoneNumbers
- 手机号列表(逗号分隔)
-
customSignName
- 自定义签名(可选)
-
customTemplateCode
- 模板代码
-
templateParam
- 模板参数(JSON格式)
4.4 获取配置信息
- 接口地址:
GET /parking/sms/config
- 说明: 查看当前短信服务配置(敏感信息已脱敏)
5. 使用示例
5.1 Postman测试
# 发送验证码
POST http://localhost:8543/parking/sms/sendVerificationCode
Content-Type: application/x-www-form-urlencoded
phoneNumber=13812345678# 发送自定义短信
POST http://localhost:8543/parking/sms/sendCustomMessage
Content-Type: application/x-www-form-urlencoded
phoneNumber=13812345678&customTemplateCode=SMS_123456789&templateParam={"name":"张三","time":"2024-01-01"}
5.2 CURL测试
# 发送验证码
curl -X POST "http://localhost:8543/parking/sms/sendVerificationCode" \-H "Content-Type: application/x-www-form-urlencoded" \-d "phoneNumber=13812345678"
6. 注意事项
- 安全性: 请妥善保管AccessKey信息,不要泄露给他人
- 费用: 发送短信会产生费用,请关注账户余额
- 频率限制: 阿里云对短信发送有频率限制,请合理使用
- 测试环境: 当前代码会在响应中返回验证码,生产环境请移除相关代码
- 签名和模板: 需要先在阿里云控制台申请并审核通过短信签名和模板
7. 常见问题
Q: 如何申请短信签名?
A: 登录阿里云控制台 → 短信服务 → 国内消息 → 签名管理 → 添加签名
Q: 如何申请短信模板?
A: 登录阿里云控制台 → 短信服务 → 国内消息 → 模板管理 → 添加模板
Q: 测试时提示AccessKey错误?
A: 请检查配置文件中的AccessKey ID和Secret是否正确
Q: 短信发送失败?
A: 请检查:
- 手机号格式是否正确
- 短信签名和模板是否审核通过
- 账户余额是否充足
- AccessKey权限是否正确
8. 参考链接
- 阿里云短信服务控制台
- 阿里云短信服务API文档
- 阿里云AccessKey管理