UniSdk 0.3.0

Unimatrix .NET SDK

The Unimatrix .NET SDK provides convenient access to integrate communication capabilities into your .NET 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 .NET is to use the nuget package manager, which is available on NuGet.

If you are building with the .NET CLI, run the following command to add UniSdk as a dependency to your project:

dotnet add package UniSdk

If you are using the Visual Studio IDE, run the following command in the Package Manager Console:

Install-Package UniSdk

Usage

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

Initialize a client

using UniSdk;

var client = new UniClient("your access key id", "your access key secret");

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.

using System;
using UniSdk;

class Program
{
    static void Main(string[] args)
    {
        var client = new UniClient("your access key id", "your access key secret");

        try
        {
            var resp = client.Messages.Send(new {
                to = "+1206880xxxx",  // in E.164 format
                text = "Your verification code is 2048."
            });
            Console.WriteLine(resp.Data);
        }
        catch (UniException ex)
        {
            Console.WriteLine(ex);
        }
    }
}

or use async method:

using System;
using System.Threading.Tasks;
using UniSdk;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new UniClient();

        try
        {
            var resp = await client.Messages.SendAsync(new {
                // ...
            });
            Console.WriteLine(resp.Data);
        }
        catch (UniException ex)
        {
            Console.WriteLine(ex);
        }
    }
}

Send verification code

Send a one-time passcode (OTP) to a recipient. The following example will automatically generate a verification code.

using System;
using UniSdk;

class Program
{
    static void Main(string[] args)
    {
        var client = new UniClient();
        var resp = client.Otp.Send(new {
            to = "+1206880xxxx"
        });
        Console.WriteLine(resp.Data);
    }
}

Check verification code

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

using System;
using UniSdk;

class Program
{
    static void Main(string[] args)
    {
        var client = new UniClient();
        var resp = client.Otp.Verify(new {
            to = "+1206880xxxx",
            code = "123456" // the code user provided
        });
        Console.WriteLine(resp.Valid);
    }
}

Reference

Other Unimatrix SDKs

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

• Java
• Go
• Node.js
• Python
• PHP
• Ruby

License

This library is released under the MIT License.