https://github.com/jevonsflash/sms
适用于AbpBoilerplate的短信服务(Short Message Service，SMS)模块，通过简单配置即可使用，仅更改一处代码即可切换短信服务提供商
https://github.com/jevonsflash/sms
aliyun sms tencent-cloud
Last synced: 3 months ago
JSON representation
适用于AbpBoilerplate的短信服务(Short Message Service，SMS)模块，通过简单配置即可使用，仅更改一处代码即可切换短信服务提供商
- Host: GitHub
- URL: https://github.com/jevonsflash/sms
- Owner: jevonsflash
- Created: 2022-10-24T09:33:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-13T03:22:41.000Z (about 3 years ago)
- Last Synced: 2026-02-15T05:59:13.261Z (4 months ago)
- Topics: aliyun, sms, tencent-cloud
- Language: C#
- Homepage:
- Size: 24.4 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sms
适用于AbpBoilerplate的短信服务(Short Message Service，SMS)模块，通过简单配置即可使用，仅更改一处代码即可切换短信服务提供商。
Aliyun.Sms由阿里云Sms提供服务(https://www.aliyun.com/product/sms)
TencentCloud.Sms由腾讯云Sms提供服务(https://cloud.tencent.com/product/sms)
## 快速开始
### 使用阿里云Sms服务提供商
在项目中引用[AbpBoilerplate.Aliyun.Sms]( https://www.nuget.org/packages/AbpBoilerplate.Aliyun.Sms)
```
dotnet add package AbpBoilerplate.Aliyun.Sms
```
添加AliyunSmsModule模块依赖
```
[DependsOn(typeof(AliyunSmsModule))]
public class CoreModule : AbpModule
```
appsettings.json配置文件中，添加服务相关配置
```
"AliyunSms": {
"RegionId": "cn-hangzhou",
"AccessKey": "",
"AccessKeySecret": ""
}
...
```
### 使用腾讯云Sms服务提供商
在项目中引用[AbpBoilerplate.TencentCloud.Sms]( https://www.nuget.org/packages/AbpBoilerplate.TencentCloud.Sms)
```
dotnet add package AbpBoilerplate.TencentCloud.Sms
```
添加TencentCloudSmsModule模块依赖
```
[DependsOn(typeof(TencentCloudSmsModule))]
public class CoreModule : AbpModule
```
appsettings.json配置文件中，添加服务相关配置
```
"TencentCloudSms": {
"SmsSdkAppId": "",
"SecretId": "",
"SecretKey": ""
}
...
```
## 使用帮助
在Service层中注入ISmsService服务即可
发送短信示例
```
public class CaptchaManager : DomainService
{
private readonly ISmsService smsService;
public CaptchaManager(ISmsService smsService)
{
this.smsService=smsService;
}
public async Task SendCaptchaAsync(string phoneNumber)
{
var captcha = CommonHelper.GetRandomCaptchaNumber();
var model = new SendSmsRequest();
model.PhoneNumbers= new string[] { phoneNumber };
model.SignName="MatoApp"; //阿里云或腾讯云后台签名管理中设置应用名称
model.TemplateCode="SMS_255330989"; //阿里云或腾讯云后台模板管理中设置模板
model.TemplateParam="{'code':'"+captcha+"'}";
await smsService.SendSmsAsync(model);
}
}
```
注意！不同服务商所传参数有可能不同，如腾讯的短信模板参数为字符串数组，而阿里云为键值对
```
//for aliyun
model.TemplateParam= JsonConvert.SerializeObject(new { code = captcha });
//for tencent-cloud
model.TemplateParam= JsonConvert.SerializeObject(new string[] {captcha});
```
## 作者信息
作者：林小
邮箱：jevonsflash@qq.com
## License
The MIT License (MIT)