laravel-hostpinnacle

Official laravel package for Hostpinnacle SMS Service(API). It includes all public available endpoints:

Quick SMS
Group SMS
File Upload

Installation

Run the following command to install Laravel Hostpinnacle package in your project:

composer require itsmurumba/laravel-hostpinnacle

If you are using Laravel 5.5 and above, skip to the Configurations step.

After running the composer require above, you should add a service provider and alias of the package in config/app.php file.(For Laravel 5.4 and below)

Itsmurumba\Hostpinnacle\HostpinnacleServiceProvider::class

Configurations

After installing the package, run the following command to install hostpinnacle.php configuartion file in the config folder:

php artisan hostpinnacle:install

php artisan vendor:publish

Add and define the following variables in your .env file

HOSTPINNACLE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx
HOSTPINNACLE_SENDER_ID=xxxxxxxxxx
HOSTPINNACLE_LOGIN_USERNAME=xxxxxxxxxxxxxxx
HOSTPINNACLE_LOGIN_PASSWORD=xxxxxx
HOSTPINNACLE_BASE_URL=https://smsportal.hostpinnacle.co.ke/SMSApi

Usage

Add the following constructor inside your controller:

protected $hostpinnacle;

public function __construct(){
    $this->hostpinnacle = new Hostpinnacle();
}

1. Quick SMS

a. Sending a quick SMS (Batch)

$data['mobile'] = '254720xxxxxx';
$data['msg'] = 'Hello World!';

$response = $this->hostpinnacle->sendQuickSMS($data);

b. Sending a quick scheduled SMS (Batch)

$data['scheduledTime'] = '2023-02-28 17:32:03';
$data['mobile'] = '254720xxxxxx';
$data['msg'] = 'Hello World!';

$response = $this->hostpinnacle->sendQuickScheduledSMS($data);

2. Group SMS

a. Sending a Group SMS

$data['groupIds'] = '1056';
$data['msg'] = 'Hello World!';

$response = $this->hostpinnacle->sendGroupSMS($data);

b. Sending a Group Scheduled SMS

$data['scheduledTime'] = '2023-02-28 17:32:03';
$data['groupIds'] = '1056';
$data['msg'] = 'Hello World!';

$response = $this->hostpinnacle->sendGroupScheduledSMS($data);

3. File Upload SMS

a. Sending an SMS from File with Mobile Numbers only

$data['file'] = $request->file('file');
$data['msg'] = 'Hello World!';

$response = $this->hostpinnacle->sendMobileOnlyFileSMS($data);

b. Sending an SMS from File with Mobile Numbers only Scheduled

$data['scheduledTime'] = '2023-02-28 17:32:03';
$data['file'] = $request->file('file');
$data['msg'] = 'Hello World !';

$response = $this->hostpinnacle->sendMobileOnlyFileScheduledSMS($data);

c. Sending an SMS from File with Mobile Numbers and message

$data['file'] = $request->file('file');

$response = $this->hostpinnacle->sendMobileAndMessageFileSMS($data);

d. Sending an SMS from File with Mobile Numbers and message Scheduled

$data['scheduledTime'] = '2023-02-28 17:32:03';
$data['file'] = $request->file('file');

$response = $this->hostpinnacle->sendMobileAndMessageFileScheduledSMS($data);

Contribution

This is a community package and thus welcome anyone intrested to contribute in improving the package. Kindly go through the Contribution.md before starting to contribute. Keep those PRs and Issues coming.

Buy Me Coffee

Give this repo a star and i will have my super powers recharged. You can also follow me on twitter @ItsMurumba

License

This package is licensed under the MIT License. Please review the License file for details

ItsMurumba / laravel-hostpinnacle