# ts-addon-sms

**Repository Path**: notadd/ts-addon-sms

## Basic Information

- **Project Name**: ts-addon-sms
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-05-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# notadd 短信验证码插件

## 功能

1. 短信插件管理
2. 短信模板管理
3. 短信发送记录管理
4. 使用腾讯云短信服务发送短信验证码
5. 校验验证码合法性

## 安装

```bash
# install
yarn add @notadd/addon-sms
```

## 使用

```typescript
// application.module.ts
import { SmsModule } from "@notadd/addon-sms";

@Module({
    imports: [
        ...
        SmsModule,
        ...
    ],
    ...
})
...

// your service
import { SmsComponent } from "@notadd/addon-sms";

@Injectable()
export class ExampleService {
    constructor(
        @Inject("SmsComponentToken") private readonly smsComponentProvider: SmsComponent,
    ) { }

    // SmsRequest example：(2 , { appId: "1234567890", templateId: 123456, templateParam: ["xxxxx", "xxxxx"], "mobile": ["13512345678"] })
    async sendSms(type: number, smsRequest: SmsRequest) {
        // 短信类型 0为通知短信，1为验证码短信，2为自定义参数短信
        // 成功时返回 { code: 200, message: "发送短信成功" };
        //
        // 失败时会抛出以下几种异常：
        // HttpException (`指定短信插件'appId=xxxxx'不存在`, 404);
        // HttpException (`指定短信模板'templateId=xxxxx'不存在`, 404);
        // HttpException (`发送失败，原因：xxxxx`, xxxxx);
        await this.smsComponentProvider(type, smsRequest);
    }

    async smsValidator(mobile: string, validationCode: number) {
        // 校验验证码合法性，成功时没有返回值，失败时抛出 HttpException { code: number, message: string }
        //
        // 校验顺序：
        // step 1，判断手机号是否和接收短信手机号一致，失败时： HttpException ("输入的手机号码与接收短信的手机号码不一致", 404);
        // step 2，判断验证码是否正确，失败时： HttpException ("验证码错误", 406);
        // step 3，判断验证码是否超时，失败时： HttpException ("验证超时，请重新获取验证码", 408);
        await this.smsComponentProvider.smsValidator(mobile, validationCode);
    }
}
```