uni-sdk

Unimatrix Node.js SDK

The Unimatrix Node.js SDK provides convenient access to integrate communication capabilities into your Node.js applications using the Unimatrix HTTP API. The SDK provides support for sending SMS, 2FA verification, and phone number lookup.

Getting started

Before you begin, you need an Unimatrix account. If you don't have one yet, you can sign up for an Unimatrix account and get free credits to get you started.

Documentation

Check out the documentation at unimtx.com/docs for a quick overview.

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')

const client = new UniClient({
  accessKeyId: 'your access key id',
  accessKeySecret: 'your access key secret',
})

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)
  })

Reference

Other Unimatrix SDKs

To find Unimatrix SDKs in other programming languages, check out the list below:

• Java
• Go
• Python
• PHP

License

This library is released under the MIT License.