基础业务短信服务Node.js SDK

本文档的作用在于说明基础业务Hybrid组件（以下简称Hybrid组件）的使用方式及注意事项，任何人都可以维护此文档，但请确保文档内容正确合理性

1.安装

NPM

本组件已维护在npm官方库中，使用者可以通过npm相关命令进行安装，支持被符合‘CommonJS’规范的模块化加载工具所调用。

# 安装最新稳定版
$ npm install kc-message

2.使用

本SDK中所提供的方法，所需参数一致，具体可查看下列演示代码 所有方法本身在被调用时会返回一个promise对象，返回内容code为1时代表成功，否则代表失败。

(0) SDK初始化

let sms = require('kc-message');
let smsUtil = new sms({
  enable: true,  //是否启动短信服务
  filter: 'dev', //短信服务所在环境, 有'dev', 'prod', 'sandbox', 'prev', 'test', 'qa', 'local'
  timeout: '1000', //请求超时时间，毫秒
  maxConns: '100', //最大连接数量
  maxIdleConns: '100', //最大空闲连接数量
  selfDefinedHttpAgent: [Object Agent] //自定义Agent对象
});

（1）SendSMSCode方法

smsUtil.SendSMSCode({
  appId: 10000, // 业务线id
  appSecret: 'xxx', // 业务线密匙
  phone: '13444444444', // 待发送短信的手机号
  content: 'xxxx', //发送内容，需要用纯数字，如‘123456’
  appTag: 'xx', // 业务线tag
}).then(res => {
  // res.code == 1为真时，短信发送成功；否则失败
})

（2）SendVoiceCode方法

本方法可以发送语音验证码，具体调用参数和短信验证码相同。

smsUtil.SendVoiceCode({
  appId: 10000, // 业务线id
  appSecret: 'xxx', // 业务线密匙
  phone: '13444444444', // 待发送短信的手机号
  content: 'xxxx', //发送内容，需要用纯数字，如‘123456’
  appTag: 'xx', // 业务线tag
}).then(res => {
  // res.code == 1为真时，短信发送成功；否则失败
})

（3）SendSms 方法

本方法用于发送普通短信，具体调用参数和短信验证码类似，需要注意的区别是，content参数需要添加考虫签名(【考虫网】)，如'【考虫网】测试短信'

smsUtil.SendSms({
  appId: 10000, // 业务线id
  appSecret: 'xxx', // 业务线密匙
  phone: '13444444444', // 待发送短信的手机号
  content: '【考虫网】xxxx', //发送内容，需要在字符串头部添加考虫签名，如‘【考虫网】123456’
  appTag: 'xx', // 业务线tag
}).then(res => {
  // res.code == 1为真时，短信发送成功；否则失败
})

（4）SendMarketingSms 方法

本方法用于发送营销短信，具体参数和普通短信一致

smsUtil.SendMarketingSms({
  appId: 10000, // 业务线id
  appSecret: 'xxx', // 业务线密匙
  phone: '13444444444', // 待发送短信的手机号
  content: '【考虫网】xxxx', //发送内容，需要在字符串头部添加考虫签名，如‘【考虫网】123456’
  appTag: 'xx', // 业务线tag
}).then(res => {
  // res.code == 1为真时，短信发送成功；否则失败
})