sub100/notifications

Sub100 Notifications Laravel SDK

dev-master 2021-02-03 14:02 UTC

Requires

• php: >=7.1
• ext-json: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• orchestra/testbench: ^6.0

MIT

• André Silva

README

This package uses Sub100 notification api to send email, sms and whatsapp notifications.

Usage as a composer package in your Laravel project

Install via composer

composer req sub100/notifications

Publish config

php artisan vendor:publish --provider="sub100\Notifications\Sub100NotificationServiceProvider"

Configure .env file

NOTIFICATION_URL=https://path-to-notification/api/

<?php

$message = new Message();
$message->subject('Subject');
$message->mailTemplate('notification.template.dir.filename');
$message->mailVariables(['name' => 'User']);
$message->addEmail('[e-mail]');

Notification::notify($message);

Usage in another projects

Install via composer

composer req sub100/notifications

<?php

$authToken = '';

$message = new Message();
$message->message('Message text');
$message->addWhatsapp('[phone]');

$notification = new Notification('http://notification-api.example.com');

$notification->notify($message, $authToken);

Other Examples

Send Twilio Whatsapp message

<?php

$authToken = '';

$message = new Message();
$message->message('Message text');
$message->addWhatsapp('[phone]');
$message->senderServiceType('twilio');
$message->senderServiceCredentials([
    "twilio_auth_token"   => "8b74ff6655248c86fe0813e07d0f58a8",
    "twilio_account_sid"  => "AC16909ae3f38b03c7495d7dfbfd9dcbb4",
    "twilio_from"         => "whatsapp:[phone]"
]);

$notification = new Notification('http://notification-api.example.com');

$notification->notify($message, $authToken);

Send Email with pre-defined mail body

<?php

$authToken = '';

$message = new Message();
$message->mailBody('<p>Message text</p>');
$message->addEmail('[e-mail]');

$notification = new Notification('http://notification-api.example.com');

$notification->notify($message, $authToken);

Get notifications history

$authToken = '';

$originId = '';

$clientIds = ['',];

$notificationIds = ['',];

$notification = new Notification('http://notification-api.example.com');

$notification->historyByOrigin($originId, $authToken)

$notification->historyByClientAndOrigin($clientIds, $originId, $authToken);

$notification->historyByNotificationAndOrigin($notificationIds, $originId, $authToken)