unimtx / uni-sdk
PHP的官方Unimatrix SDK。
v0.3.0
2023-07-28 10:18 UTC
Requires
- php: >=7.0
- ext-curl: *
README
Unimatrix PHP SDK提供了方便的接口,使您可以使用Unimatrix HTTP API将通信功能集成到您的PHP应用程序中。SDK支持发送短信、二次验证和电话号码查询。
入门
在开始之前,您需要一个Unimatrix账户。如果您还没有账户,您可以注册一个Unimatrix账户,并获得免费积分以开始使用。
文档
请访问unimtx.com/docs查看文档以获取快速概览。
安装
使用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' ]);
或者您可以通过环境变量配置您的凭据
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' => '+1206880xxxx', // in E.164 format 'text' => 'Your verification code is 2048.' ]); var_dump($resp->data); } catch (UniException $e) { print_r($e); }
发送验证码
向收件人发送一次性密码(OTP)。以下示例将自动生成的验证码发送给用户。
use Uni\UniClient; use Uni\UniException; $client = new UniClient(); $resp = $client->otp->send([ 'to' => '+1206880xxxx' ]); var_dump($resp->data);
验证验证码
验证用户提供的一次性密码(OTP)。以下示例将检查用户提供的验证码是否正确。
use Uni\UniClient; use Uni\UniException; $client = new UniClient(); $resp = $client->otp->verify([ 'to' => '+1206880xxxx', 'code' => '123456' // the code user provided ]); var_dump($resp->valid);
参考
其他Unimatrix SDK
要查找其他编程语言的Unimatrix SDK,请查看以下列表
许可
此库根据MIT许可证发布。