multicaret/laravel-unifonic

A library to integrate with Unifonic API to send SMS

v2.0.0 2020-10-22 16:43 UTC

This package is auto-updated.

Last update: 2021-07-22 18:31:52 UTC


README

687474703a2f2f63646e2e6d756c746963617265742e636f6d2f7061636b616765732f6173736574732f696d672f756e69666f6e69632d6c6f676f2e706e67

Laravel Unifonic 8.x +

Start sending SMS with Unifonic right away using Laravel.

Total Downloads Latest Stable Version License

Installation

First, install the package through Composer.

$ composer require multicaret/laravel-unifonic

Laravel 5.5 and up

You don't have to do anything else, this package uses the package Auto-Discovery feature, and should be available as soon as you install it via Composer.

Laravel 5.4 and below

Then include the service provider inside config/app.php.

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

And add the alias as well

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

Configurations

Head to Dashboard to create a new Application (check image below if you wish). Within in this app, you will find the APP SID copy it please. Now add these to your config/services.php file:

'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')
],

687474703a2f2f63646e2e6d756c746963617265742e636f6d2f7061636b616765732f6173736574732f696d672f756e69666f6e69632d6170702d7369642d696e737472756374696f6e732e706e67

Now Place these in your .env file.

UNIFONIC_APP_ID=
UNIFONIC_SENDER_ID=
UNIFONIC_ACCOUNT_EMAIL=
UNIFONIC_ACCOUNT_PASSWORD=

Usage

Account related methods:

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

Messages related methods:

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

You may make asynchronous calls to Unifonic API, by prefixing your methods with the async() function:

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); 

For more details about the parameters please refer to the Api Documentation for more info, or read the source code.

Contributing

See the CONTRIBUTING guide.

Changelog

Please see CHANGELOG for more information about what has changed recently.