Unimatrix Node.js SDK

安装

安装适用于 Node.js 的 Unimatrix SDK 的推荐方法是使用 npm 包管理器，可在 npm 上获得。

运行以下命令将 uni-sdk 添加为项目依赖：

npm i uni-sdk

或使用 Yarn：

yarn add uni-sdk

使用示例

以下示例展示如何使用 Unimatrix Node.js SDK 快速调用 Unimatrix 服务。

初始化客户端

const { UniClient } = require('uni-sdk')

const client = new UniClient({
  accessKeyId: 'your access key id',
  accessKeySecret: 'your access key secret', // 若使用简易验签模式请删除此行
  endpoint: 'https://api-cn.unimtx.com' // 设置接入点到中国大陆, 若使用全球节点请移除此行代码
})

或者您也可以通过环境变量来配置您的访问凭证：

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

发送短信

向单个收件人发送短信

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.messages.send({
  to: '+861865800xxxx', // 以 E.164 格式传入手机号
  signature: '合一矩阵', // 替换为您的短信签名
  content: '您的验证码是123456，5分钟内有效。'
})
  .then(ret => {
    console.log('Result:', ret)
  })
  .catch(e => {
    console.error(e)
  })

或使用 async/await 关键字：

try {
  const ret = await client.messages.send({
    // ...
  })
  console.log('Result:', ret)
} catch (e) {
  console.error(e)
}

使用模版和模版变量发送短信

client.messages.send({
  to: '+861865800xxxx',
  signature: '合一矩阵',
  templateId: 'pub_verif_ttl2',
  templateData: {
    code: '123456',
    ttl: '5'
  }
})

发送验证码

向用户发送验证码/一次性验证码（OTP），以下示例将向用户发送一个自动生成的验证码

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.send({
  to: '+861865800xxxx',
  signature: '合一矩阵' // 替换为您的短信签名
})
  .then(ret => {
    console.log('Result:', ret)
  })

校验验证码

校验用户提交的验证码/一次性验证码（OTP），以下示例将检查用户提供的验证码是否正确

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.verify({
  to: '+861865800xxxx',
  code: '123456' // 用户提交的验证码
})
  .then(ret => {
    console.log('Valid:', ret.valid)
  })