boyo/laravel-link-mobility

Laravel notifications with Link Mobility

v1.2 2024-12-05 14:36 UTC

This package is auto-updated.

Last update: 2025-02-20 09:47:04 UTC


README

This package adds a notification channel for linkmobility.com services. You can use it to send SMS messages and Viber for Business messages.

Installation

composer require boyo/laravel-link-mobility

Config

Add the following to your services config file.

'link-mobility' => [
	'api_key' => env('LINK_MOBILITY_API_KEY',''),
	'api_secret' => env('LINK_MOBILITY_API_SECRET',''),
	'service_id' => env('LINK_MOBILITY_SERVICE_ID', '1'),
	'sc_sms' => env('LINK_MOBILITY_SMS_SENDER', ''),
	'sc_viber' => env('LINK_MOBILITY_VIBER_SENDER', ''),
	'prefix' => '',
	'log' => env('LINK_MOBILITY_LOG',true),
	'log_channel' => env('LINK_MOBILITY_LOG_CHANNEL','stack'),
	'send' => env('LINK_MOBILITY_SEND',false),
	'bulglish' => true,
	'allow_multiple' => false,
],
  • api_key your LINK Mobility API_KEY
  • api_secret your LINK Mobility API_SECRET
  • service_id your LINK Mobility Service ID
  • log if the messages should be written to a log file
  • log_channel the log channel to log messages to
  • send if the messages should be sent (production/dev environment)
  • bulglish if cyrillic text should be converted to latin letters for SMS messages (cyrillic messages are limited to 67 characters)
  • allow_multiple if SMS messages above 160 characters should be allowed (billed as multiple messages)

Send test

To send a test message use the following artisan command:

php artisan link-mobility:test phone --message='content' --channel=sms --promo

  • channel can have the following values: sms|viber|viber-sms
  • promo will send a promo test message with image and button

Direct usage

You can instantiate a Boyo\LinkMobility\LinkMobilityMessage object and send it immediately.

use Boyo\LinkMobility\LinkMobilityMessage;
use Boyo\LinkMobility\LinkMobilitySender;

class MyClass
{
	public function myFunction()
	{
		$message = (new LinkMobilityMessage())->to('359888888888')->channel('viber-sms')->sms('SMS text')->viber('Viber text');
		
		$client = new LinkMobilitySender();
		$client->send($message);	
	}
}

Usage with notifications

  1. Create a message file that extends Boyo\LinkMobility\LinkMobilityMessage. It can take whatever data you need in the construct and should implement a build() method that defines the messages text content - a good practice would be to render a view file, so that your message content is in your views. You should only define the methods for the delivery channels that your are going to use.
use Boyo\LinkMobility\LinkMobilityMessage;

class MyMessage extends LinkMobilityMessage 
{
	public function __construct($data)
    {
        $this->id = $data->id; // your unique message id, add other parameters if needed
    }
    
	public function build() {
		// set your sms text 
		$this->sms('SMS text');
	
		// set your viber text
		$this->viber('Viber text');
		
		return $this;
	}	
}
  1. In your Notification class you can now include the LinkMobility channel in the $via array returned by the via() method.
use Boyo\LinkMobility\LinkMobilityChannel;

via($notifiable) 
{
	
	// ...
	
	$via[] = LinkMobilityChannel::class;
	
	return $via 
	
}

Within the same Notification class you should also define a method toSms():

public function toSms($notifiable)
{
	return (new MyMessage($unique_id))->to($notifiable->phone)->channel('viber-sms');
}

The channel method is where you define the delivery channel you wish to use.

  • sms delivery by sms only (this is the default value, if you omit the channel method)
  • viber delivery by viber only
  • viber-sms delivery attempted by viber, if not successful delivery by sms