aasanakey / smsonline
v0.0.3
2023-10-23 22:30 UTC
Requires
- php: ^8.0
- guzzlehttp/guzzle: ^7.0
- illuminate/notifications: ^8.0|^9.0|^10.0
- illuminate/support: ^8.0|^9.0|^10.0
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0|^8.13
- phpunit/phpunit: ^10.1.0
Suggests
- guzzlehttp/guzzle: Required to use the HTTP Client (^7.6).
README
通过smsonline GH SMS API发送Laravel通知
安装
您可以通过composer安装此包
composer require aasanakey/smsonline
首先,您必须安装服务提供者(对于Laravel >= 5.5可跳过)
// config/app.php 'providers' => [ ... \Aasanakey\Smsonline\SmsonlineServiceProvider::class, ],
您可以使用以下命令发布配置文件
php artisan vendor:publish --tag=smsonline-config
或
php artisan vendor:publish --provider="Aasanakey\Smsonline\SmsonlineServiceProvider" --tag="smsonline-config"
配置
添加您的smsonline Gh API访问密钥、API主机、发送者ID/发送者名称。
在您的.env文件中设置您的smsonline Gh API密钥。
SMSONLINE_HOST=Sms online api host
或
将API主机添加到您的config/smsonline.php
// config/services.php ... "host" => env('SMSONLINE_HOST','api.smsonlinegh.com'), ...
在您的.env文件中设置您的smsonline Gh API密钥。
SMSONLINE_API_KEY=your smsonline api key
或
将API Key添加到您的config/smsonline.php
// config/services.php ... "api_key" => env('SMSONLINE_API_KEY',null), ...
有关smsonline API Key,请访问SMS API
在您的.env文件中设置您的smsonline Gh发送者ID。
SMSONLINE_SENDER_ID=your sender ID
或
将发送者ID添加到您的config/smsonline.php
// config/services.php ... "sender_id" => env('SMSONLINE_SENDER_ID',null), ...
有关发送者名称,请访问发送者名称
用法
现在您可以在通知中的via()
方法内使用该通道,以及使用smsonline api发送短信通知
use Illuminate\Notifications\Notification; use Aasanakey\Smsonline\SmsonlineSmsMessage; class SMSNotification extends Notification { public function via($notifiable) { return ['smsonlinegh']; } public function toSmsonline($notifiable) { return (new SmsonlineSmsMessage) ->sender('Sender ID') ->content('Your account was approved!') ->personalisedValues("List of data for personnalised message content"); // call this method if content has message variables placeholders } }
检查余额
要检查您的短信余额,请使用SMSAPI对象的checkBalance()
方法
use Aasanakey\Smsonline\Sms; $sms = new Sms(); $balance = $api->balance(); // returns balance info object $amount = $balance->ammount // returns balance ammount $currencyName = $balance->currencyName // returns the balance currency name $currencyCode = $balance->currencyCode // return the balance ccurrency code