taiwan-sms/twsms

台灣簡訊 twsms api client

v1.0.7 2022-12-06 10:05 UTC

Requires

• php: >=5.5.9
• nesbot/carbon: ^1.22|^v2.0
• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.2
• php-http/httplug: ^1.1|^2.0
• php-http/message: ^1.5

Requires (Dev)

• illuminate/config: ^5.1|^6.0|^7.0|^8.0|^9.0
• illuminate/container: ^5.1|^6.0|^7.0|^8.0|^9.0
• illuminate/notifications: ^5.1|^6.0|^7.0|^8.0|^9.0
• illuminate/queue: ^5.1|^6.0|^7.0|^8.0|^9.0
• illuminate/support: ^5.1|^6.0|^7.0|^8.0|^9.0
• mockery/mockery: ^1.0
• phpunit/phpunit: ~4.8|~5.4|~6.1|^8.5|^9.5
• roave/security-advisories: dev-latest

Suggests

• illuminate/notifications: If you need Laravel Notification

MIT

• recca0120

• sms
• notification
• laravel
• Taiwan
• twsms

README

This package makes it easy to send notifications using [twsms] with Laravel 5.3+.

Contents

• Installation
  • Setting up the TwSMS service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require taiwan-sms/twsms illuminate/notifications php-http/guzzle6-adapter

Then you must install the service provider:

// config/app.php
'providers' => [
    ...
    TaiwanSms\TwSMS\TwSMSServiceProvider::class,
],

Setting up the TwSMS service

Add your TwSMS login, secret key (hashed password) and default sender name (or phone number) to your config/services.php:

// config/services.php
...
'twsms' => [
    'username' => env('SERVICES_TWSMS_USERNAME'),
    'password' => env('SERVICES_TWSMS_PASSWORD'),
],
...

Usage

You can use the channel in your via() method inside the notification:

use TaiwanSms\TwSMS\TwSMSMessage;
use TaiwanSms\TwSMS\TwSMSChannel;
use Illuminate\Notifications\Notification;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [TwSMSChannel::class];
    }

    public function toTwSMS($notifiable)
    {
        return TwSMSMessage::create("Task #{$notifiable->id} is complete!");
    }
}

In your notifiable model, make sure to include a routeNotificationForTwSMS() method, which return the phone number.

public function routeNotificationForTwSMS()
{
    return $this->phone;
}

Available methods

content(): Sets a content of the notification message.

sendTime(): Set send time of the notification message.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• JhaoDa
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

API Only

composer require taiwan-sms/twsms php-http/guzzle6-adapter

How to use

require __DIR__.'/vendor/autoload.php';

use TaiwanSms\TwSMS\Client;

$userId = 'xxx';
$password = 'xxx';

$client = new Client($userId, $password);

var_dump($client->credit()); // 取得額度
var_dump($client->send([
    'to' => '09xxxxxxxx',
    'text' => 'test message',
]));
/*
return [
    'code' => '00000',
    'text' => 'Success',
    'msgid' => '265078525',
];
*/