Unimatrix Node.js SDK

Installation

The recommended way to install the Unimatrix SDK for Node.js is to use the npm package manager, which is available on npm.

Run the following command to add uni-sdk as a dependency to your project:

npm i uni-sdk

or use Yarn:

yarn add uni-sdk

Usage

The following example shows how to use the Unimatrix Node.js SDK to interact with Unimatrix services.

Initialize a client

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

const client = new UniClient({
  accessKeyId: 'your access key id',
  accessKeySecret: 'your access key secret' // if using simple auth mode, delete this line
})

or you can configure your credentials by environment variables:

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

Send SMS

Send a text message to a single recipient.

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

client.messages.send({
  to: '+1206880xxxx', // in E.164 format
  text: 'Your verification code is 2048.'
})
  .then(ret => {
    console.log('Result:', ret)
  })
  .catch(e => {
    console.error(e)
  })

or use async/await keyword:

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

Send a message using a template with variables.

client.messages.send({
  to: '+1650253xxxx',
  signature: 'Unimatrix',
  templateId: 'pub_verif_en_basic2',
  templateData: {
    code: '2048'
  }
})

Send OTP

Send a one-time passcode (OTP) to a recipient. The following example will send a automatically generated verification code to the user.

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

client.otp.send({
  to: '+1206880xxxx'
})
  .then(ret => {
    console.log('Result:', ret)
  })

Verify OTP

Verify the one-time passcode (OTP) that a user provided. The following example will check whether the user-provided verification code is correct.

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

client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' // the code user provided
})
  .then(ret => {
    console.log('Valid:', ret.valid)
  })