README-zh_CN.md

一个基于 Nest(node.js) 框架封装的 阿里云短信服务 SMS 模块。

English | 简体中文

安装前

1. 创建阿里云账号
2. 购买短信服务. (产品链接)
3. 申请 SMS 签名，到 控制台 > 短信服务 > 国内消息 > 添加签名
4. 创建短信模板, 到 控制台 > 短信服务 > 国内消息 > 模板管理 > 添加模板.

安装

npm install --save nestjs-alicloud-sms
#or
yarn add nestjs-alicloud-sms

文档

1. 使用如下配置导入 AlicloudSmsModule:

import { Module } from '@nestjs/common';
import { AlicloudSmsModule } from 'nestjs-alicloud-sms';

import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  controllers: [AppController],
  providers: [AppService],
  imports: [
    AlicloudSmsModule.forRoot({
      config: { accessKeyId: '***', accessKeySecret: '***' },
      defaults: { signName: '***', regionId: 'cn-hangzhou' },
    }),
  ],
})
export class AppModule {}

2. 发送信息

import { Controller, Logger, Post } from '@nestjs/common';
import { AlicloudSmsService } from 'nestjs-alicloud-sms';

@Controller()
export class AppController {
  constructor(private readonly smsService: AlicloudSmsService) {}

  @Post('sms/send')
  async sendSms(): Promise<any> {
    const templateCodeId = 'SMS_1490999999';
    const phoneNumber = '1388886666';
    const templateParam = { code: '888666' };

    const sendResponse = await this.smsService.sendSms(templateCodeId, phoneNumber, templateParam);

    if (sendResponse.Code === 'OK') {
      // success
    } else {
      // failed
    }
  }
}

License

The MIT License.