Fazland's Skebby Rest Client is an unofficial PHP Rest Client for the italian SMS GatewayProvider Skebby.
php
>= 7.4php xml extension
symfony/options-resolver
giggsey/libphonenumber-for-php
>= 8.0
The suggested installation method is via composer:
$ composer require fazland/skebby-rest-client
It's really simple. First of all, configuration!
The mandatory configuration parameters are:
username
password
sender
method
Just create a Client
object passing to the constructor the parameters as an array:
$this->skebbyRestClient = new Client([
'username' => 'your_username',
'password' => 'your_password',
'sender' => '+393333333333',
'method' => SendMethods::CLASSIC,
'encoding_scheme' => EncodingSchemas::NORMAL, // Optional
'charset' => Charsets::UTF8, // Optional
'endpoint_uri' => 'https://gateway.skebby.it/api/send/smseasy/advanced/rest.php' // (default)
]);
You can also set default values for delivery_start
and validity_period
, thus they can be overridden by the Sms object
To create an SMS just follow the example:
Sms::create()
->setRecipients([
'+393473322444',
'+393910000000'
])
->setRecipientVariables('+393473322444', [
'name' => 'Mario',
'quest' => 'Go and rescue Peach, Bowser kidnapped her!'
])
->setRecipientVariables('+393910000000', [
'name' => 'Luigi',
'quest' => 'Help Mario, Bowser is really bad!!'
])
->setText('Hey ${name}! ${quest}')
;
Just use the Client::send(Sms $sms)
method to send sms!
$client->send($sms);
A single client will send SMS through the method you specified in configuration. If you want to send it through another method, just create a new client.
You can leverage your preferred event system, as long as it implements PSR-14. Just pass your dispatcher as third argument of Client constructor:
$dispatcher = new EventDispatcher(); // any dispatcher implementing EventDispatcherInterface
$options = [/* .. */]; // see above for detailed options
$this->skebbyRestClient = new Client($options, null, $dispatcher);
Each time an SMS is sent, a \Fazland\SkebbyRestClient\Event\SmsMessageEvent
will be dispatched.
Run
$ vendor/bin/phpunit
Contributions are welcome. Feel free to open a PR or file an issue here on GitHub!
Skebby Rest Client is licensed under the MIT License - see the LICENSE file for details