loopcraft/msgowl

This is my package msgowl

Fund package maintenance!
loopcraft

dev-main 2023-08-28 06:27 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

A secure SMS Messaging platform allowing your business to send bulk SMS Messages to your clients

Support us

68747470733a2f2f7777772e6c6f63616c2e6d762f77702d636f6e74656e742f75706c6f6164732f6c697374696e672d75706c6f6164732f6c6f676f2f323032302f30312f4c6f6f7043726166745f6c6f676f2e706e67

Installation

You can install the package via composer:

composer require loopcraft/msgowl

You can publish the config file with:

php artisan vendor:publish --tag="msgowl-config"

This is the contents of the published config file:

return [
    'sender' =>  env('MSG_OWL_SENDER'), //required
    
    'urls' => [
        'otp' =>  env('MSG_OWL_OTP_URL', 'https://otp.msgowl.com'),
        'rest' =>  env('MSG_OWL_REST_URL', 'https://rest.msgowl.com'),
    ],
    
    'keys' => [
        'rest_key' =>  env('MSG_OWL_REST_KEY'),  //required
        'otp_key' => env('MSG_OWL_OTP_KEY'),  //required
    ],
    
    'notification' => [
        'active' => env('MSG_OWL_NOTIFICATION_ACTIVE', true),
        'threshold' => 50,
        'contact_number' => env('MSG_OWL_SMS_NUMBER'),  //required if notification active is true
        'message' => env('MSG_OWL_SMS_MSG', 'Your MsgOwl balance is getting low'), 
    ],

];

Usage

MsgOwl::sendMessage('body of sms needed to send','960123456,9603212...',);

Testing

composer test

Credits

  • Write test
  • Add OTP support

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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