Unimatrix Ruby SDK

安装

安装适用于 Ruby 的 Unimatrix SDK 的推荐方法是使用 gem 包管理器，可在 RubyGems 上获得。

运行以下命令将 uni-sdk 添加为项目依赖：

gem install uni-sdk

如果您通过 Bundler 安装，请将此行添加到程序的 Gemfile 文件中：

gem 'uni-sdk'

使用示例

以下示例展示如何使用 Unimatrix Ruby SDK 快速调用 Unimatrix 服务。

初始化客户端

require 'uni-sdk'

client = Uni::Client.new('your access key id', 'your access key secret') # 若使用简易验签模式仅传入第一个参数即可
client.endpoint = 'https://api-cn.unimtx.com' # 设置接入点到中国大陆, 若使用全球节点请移除此行代码

或者您也可以通过环境变量来配置您的访问凭证：

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

发送短信

向单个收件人发送短信

require 'uni-sdk'

client = Uni::Client.new()

begin
  resp = client.messages.send({
    to: '+861865800xxxx', # 以 E.164 格式传入手机号
    signature: '合一矩阵', # 替换为您的短信签名
    content: '您的验证码是123456，5分钟内有效。'
  })
  puts resp.data
rescue Uni::UniError => e
  puts 'Exception: ' + e.message
end

使用模版和模版变量发送短信

client.messages.send({
  to: '+861865800xxxx',
  signature: '合一矩阵',
  templateId: 'pub_verif_ttl2',
  templateData: {
    code: '123456',
    ttl: '5'
  }
})

发送验证码

向用户发送验证码/一次性验证码（OTP），以下示例将向用户发送一个自动生成的验证码

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.send({
  to: '+861865800xxxx',
  signature: '合一矩阵' # 替换为您的短信签名
})
puts resp.data

校验验证码

校验用户提交的验证码/一次性验证码（OTP），以下示例将检查用户提供的验证码是否正确

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.verify({
  to: '+861865800xxxx',
  code: '123456' # 用户提交的验证码
})
puts resp.valid