README

UFLIX DESIGN SDK - SMS网关。

路由。

根据需要和可用性，在需要指定路由时，选择以下之一。

对于任何请求，您必须创建SMS网关客户端的实例。

$sms = new UFXDSMSAPI\\Client($user, $pass, $config);

参数

参数	类型	默认值	描述
$user	字符串	`必需`	提供账户用户名
$password	字符串	`必需`	提供账户密码
$config	数组	`可选` []	SDK使用`GuzzleHttp\\Guzzle`请求HTTP API，此选项只是覆盖默认选项。有关更多信息，请参阅Guzzle请求选项。

此方法用于获取账户的短信余额。

$sms->balance(): object|null

失败时返回null，成功时返回包含余额信息的对象。

此方法用于检查我们的短信服务器是否正常运行。

$sms->APIStatus($getException): boolean

参数	类型	默认值	描述
$getException	布尔值	`可选` false	如果设置为true，方法将抛出异常，而不是在错误时返回false。

成功时返回true，失败时返回false，如果$getException设置为false。失败时，如果$getException设置为true，则方法将抛出异常。

此方法用于通过我们的短信网关发送短信。

$sms->sendSMS($numbers, $message, $route): object

返回状态的对象。

将OTP（一次性密码）发送到用于稍后验证的号码。注意，您不需要生成或将OTP存储到数据库中。所有工作都由我们的API完成。

所有OTP都有一个验证时间范围，通过$ttl给出。我们的API足够智能，即使在未按顺序送达的情况下也能验证OTP。因此，如果用户发送2个或更多的OTP但它们未按顺序送达，则可以使用其中一个OTP进行验证。

$sms->sendOTP($action, $number, $message, $ttl): boolean

参数	类型	默认值	描述
$action	字符串	`必需`	最大长度：32个字符。一个命名的操作，描述OTP是什么。
$number	字符串	`必需`	发送OTP的电话号码。
$message	字符串	`可选` 默认：''	用于将自动生成的OTP替换的模板消息。如果没有指定，将使用默认模板。
$ttl	整数	`可选` 默认：5	生存时间。OTP验证的有效时间。值以分钟为单位。

成功时返回true，否则返回false。

验证之前发送到号码的OTP。

《action》定义了OTP的作用，因此action应该与发送OTP时使用的action相同。这样，一个应用可以有多个OTP验证的位置，每个位置将使用不同的action名称。例如：`login`、`cod`等。

$sms->verifyOTP($action, $number, $code): boolean

参数	类型	默认值	描述
$action	字符串	`必需`	最大长度：32个字符。一个命名action，用于描述OTP的作用。
$number	字符串	`必需`	之前发送OTP的手机号码。
$code	字符串	`必需`	发送到手机上的OTP。

如果OTP验证成功则返回`true`，否则返回`false`