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.

Send SMS

Send a text message to a single recipient.


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

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

// send the message
client.messages.send({
  to: 'your phone number', // in E.164 format
  signature: 'your sender name',
  content: 'Your verification code is 2048.',
})
  .then(ret => {
    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',
  },
})