Unimatrix PHP SDK

安装

使用 Composer 是安装适用于 PHP 的 Unimatrix SDK 的推荐方法，可在 Packagist 上获得。

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

composer require unimtx/uni-sdk

使用示例

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

初始化客户端

use Uni\UniClient;

$client = new UniClient([
  'accessKeyId' => 'your access key id',
  'accessKeySecret' => 'your access key secret', // 若使用简易验签模式请删除此行
  'endpoint' => 'https://api-cn.unimtx.com' // 设置接入点到中国大陆, 若使用全球节点请移除此行代码
]);

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

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

发送短信

向单个收件人发送短信

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

try {
  $resp = $client->messages->send([
    'to' => '+861865800xxxx', // 以 E.164 格式传入手机号
    'signature' => '合一矩阵', // 替换为您的短信签名
    'content' => '您的验证码是123456，5分钟内有效。'
  ]);
  var_dump($resp->data);
} catch (UniException $e) {
  print_r($e);
}

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

$client->messages->send([
  'to' => '+861865800xxxx',
  'signature' => '合一矩阵',
  'templateId' => 'pub_verif_ttl2',
  'templateData' => [
    'code' => '123456',
    'ttl' => '5'
  ]
]);

发送验证码

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

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

$resp = $client->otp->send([
  'to' => '+861865800xxxx',
  'signature' => '合一矩阵' // 替换为您的短信签名
]);
var_dump($resp->data);

校验验证码

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

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

$resp = $client->otp->verify([
  'to' => '+861865800xxxx',
  'code' => '123456' // 用户提交的验证码
]);
var_dump($resp->valid);
}