Skip to content

strebl/inetworx-client

Repository files navigation

Very short description of the package

Latest Version on Packagist Build Status StyleCI SensioLabsInsight Quality Score Total Downloads

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Installation

You can install the package via composer:

composer require strebl/inetworx-client

Laravel

If you are using Laravel, you can register the service provider:

'providers' => [
    // ...
    Strebl\Inetworx\InetworxServiceProvider::class,
];

To publish the config file to config/inetworx.php run (optional):

php artisan vendor:publish --provider="Strebl\Inetworx\InetworxServiceProvider"

If you are using Laravel, you can register the service provider:

'aliases' => [
    // ...
    'Inetworx' => Strebl\Inetworx\InetworxFacade::class,
];

Set the environment variables with the correct values:

INETWORX_AUTH_HEADER_USERNAME=null
INETWORX_AUTH_HEADER_PASSWORD=null

INETWORX_API_USERNAME=null
INETWORX_API_PASSWORD=null

Usage

With Laravel

$skeleton = app(Strebl\Inetworx::class);
$sms->send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);

Or you can use the Facade:

\Inetworx::send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);

Without Laravel

$sms = new Strebl\Inetworx(
    $authHeaderUsername,
    $authHeaderPassword,
    $apiUsername,
    $apiPassword,
);
$sms->send($phoneNumber, 'Hello, Manuel!', $senderPhoneNumber);

Send a SMS

$sms->send($to, $message, $from);

Get the remaining SMS credits

$sms->credit();

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email manuel@strebel.xyz instead of using the issue tracker.

Credits

License

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