Ruby SDK

Installation

The recommended way to install the Unimatrix SDK for Ruby is to use the gem package manager, which is available on RubyGems.

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

gem install uni-sdk

If you are installing via Bundler, add this line to your application's Gemfile:

gem 'uni-sdk'

Usage

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

Send SMS

Send a text message to a single recipient.


require 'uni-sdk'

# initialization
client = Uni::Client.new('your access key id', 'your access key secret') # if you use the simple auth mode, just pass in the first parameter

# send the message
begin
  resp = client.messages.send({
    to: 'your phone number', # in E.164 format
    signature: 'your sender name',
    content: 'Your verification code is 2048.'
  })
  puts resp.data
rescue Uni::UniError => e
  puts 'Exception: ' + e.message
end

Send a message using a template with variables.

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