multicaret/laravel-unifonic

一个用于集成 Unifonic API 发送短信的库

v2.1.0 2023-11-08 12:50 UTC

This package is auto-updated.

Last update: 2024-09-08 14:28:21 UTC


README

Laravel Unifonic 8.x+

立即使用 Laravel 开始发送 Unifonic 短信。

Total Downloads Latest Stable Version License

安装

首先,通过 Composer 安装此包。

$ composer require multicaret/laravel-unifonic

Laravel 5.5 及以上

您不需要做任何事情,此包使用自动发现功能,安装后应该立即可用。

Laravel 5.4 及以下

然后在 config/app.php 中包含服务提供者。

'providers' => [
    ...
    Multicaret\Unifonic\UnifonicServiceProvider::class,
    ...
];

并添加别名

'aliases' => [
    ...
    'Unifonic' => Multicaret\Unifonic\UnifonicFacade::class,
    ...
],

配置

前往 仪表板 创建一个新应用程序(如果您愿意,请查看下面的图片)。在此应用程序中,您将找到 APP SID,请复制它。现在将这些添加到您的 config/services.php 文件中

'unifonic' => [
    'app_id' => env('UNIFONIC_APP_ID'),
    'sender_id' => env('UNIFONIC_SENDER_ID'), // String, Optional
    'account_email' => env('UNIFONIC_ACCOUNT_EMAIL'),
    'account_password' => env('UNIFONIC_ACCOUNT_PASSWORD')
],

现在将这些放置在您的 .env 文件中。

UNIFONIC_APP_ID=
UNIFONIC_SENDER_ID=
UNIFONIC_ACCOUNT_EMAIL=
UNIFONIC_ACCOUNT_PASSWORD=

用法

账户相关方法

// To test credentials and make sure the APP SID, email & password are set correctly. 
Unifonic::retrieveCredentialsForTesting();

消息相关方法

Unifonic::send(int $recipient, string $message, string $senderID = null);
Unifonic::getMessageIDStatus(int $messageID);

您可以通过在方法前加 async() 函数来对 Unifonic API 进行异步调用

Unifonic::async(true); // async calls on, default value is true
Unifonic::async(false);// async calls off

// Later you can append the callback() to be executed when the response returns.
Unifonic::async()->callback(Callable $requestCallback); 

有关参数的更多详细信息,请参阅 API 文档 或阅读 源代码

贡献

查看 CONTRIBUTING 指南。

变更日志

请查看 CHANGELOG 以了解最近的变化。