README

This package makes it easy to send notifications using Hellio Messaging

Content

• Installation
  • Setting up the Hellio Messaging Service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

To get the latest version of Hellio Messaging Notification channel is intended for Laravel 5.5 and up, simply require the project using Composer:

composer require helliomessaging/helliomessaging-laravel-notification-channel

If you use Laravel 5.5+ you don't need the following step. If not, once package is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

• NotificationChannels\Hellio\HellioServiceProvider::class

Setting up the Hellio Messaging Service

First, you must have an account with Hellio. Once you've registered for an account, login into your account and click on the Profile & API Integration menu on your Hellio Messaging dashboard. Click on the API Keys & Webhooks tab and copy your Client ID and Application Secret

In your terminal run

php artisan vendor:publish --provider="NotificationChannels\Hellio\HellioServiceProvider"

This creates a hellio.php file in your config directory.

Paste your api keys in the config/hellio.php configuration file. You may copy the example configuration below to get started:

<?php

return [
    'config' => [
        'client_id' => env('HELLIO_CLIENT_ID'),
        'app_secret' => env('HELLIO_APP_SECRET')
    ],

];

Or

Add the HELLIO_CLIENT_ID and HELLIO_APP_SECRET to your .env file

Usage

Now you can use the channel in your via() method in any notification you want to send using Hellio Messaging:

<?php

use Illuminate\Notifications\Notification;
use NotificationChannels\Hellio\HellioChannel;
use NotificationChannels\Hellio\HellioMessage;

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

    public function toHellioSMS($notifiable)
    {
        return (new HellioMessage)
   ->from("HellioSMS")
   ->to("233242813656") //Add the country code to the number you wish to send to without the need to add the  +
              ->content("Welcome to Hellio Messaging, a new world of litmitless possibilities.")
              ->messageType(0); //0 = text, 1 = flash
    }
}

In order to let your Notification know which phone number you are sending to, add the routeNotificationForHellioSMS method to your Notifiable model e.g your User Model

public function routeNotificationForHellioSMS()
{
    return $this->phone; // where phone is a column in your users table;
}

Available Message methods

• from($from) : set the sender's id
• senderID($id): an alias for from($from)
• to($to) : set the recipient's phone number
• msisdn($msisdn): an alias for to($to)
• messageType($messageType): an alias for type($type)
• content($content) : set the message content
• message($message): an alias for content($content)

Read more about the available methods on the Hellio Messaging Documentation Portal

Testing

composer test

Security

If you discover any security related issues, please email support@helliomessaging.com instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Norris Oduro Tei
• Abdul Kudus
• All Contributors

License

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