Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abdullahghanem/laravel-smsmisr
Laravel Package that's allows you to send SMS and SMS notifications via SmsMisr from your Laravel application.
https://github.com/abdullahghanem/laravel-smsmisr
egypt laravel sms sms-gateway smsmisr
Last synced: 4 days ago
JSON representation
Laravel Package that's allows you to send SMS and SMS notifications via SmsMisr from your Laravel application.
- Host: GitHub
- URL: https://github.com/abdullahghanem/laravel-smsmisr
- Owner: AbdullahGhanem
- Created: 2019-04-16T10:36:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-29T19:44:02.000Z (over 1 year ago)
- Last Synced: 2024-09-25T21:48:01.299Z (8 days ago)
- Topics: egypt, laravel, sms, sms-gateway, smsmisr
- Language: PHP
- Homepage:
- Size: 47.9 KB
- Stars: 18
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Laravel SMS Misr (EGYPT)
[](https://packagist.org/packages/ghanem/laravel-smsmisr) [](https://packagist.org/packages/ghanem/laravel-smsmisr) [](https://packagist.org/packages/ghanem/laravel-smsmisr) [](https://packagist.org/packages/ghanem/laravel-smsmisr)
Laravel Package that's allows you to send SMS and SMS notifications via [SmsMisr](https://www.smsmisr.com/) from your Laravel application.
## Summary
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Notifications](#notifications)
- [Licence](#licence)
## Requirements
- PHP >= 8
- Laravel 8+
- account in Sms Misr (username and password)
## Installation
- Installation via composer :
```bash
composer require ghanem/laravel-smsmisr
```
### Laravel 5.5+
If you're using Laravel 5.5 or above, the package will automatically register the `Smsmisr` provider and facade.
### Laravel 5.4 and below
Add `Ghanem\LaravelSmsmisr\SmsmisrServiceProvider` to the `providers` array in your `config/app.php`:
```php
'providers' => [
// Other service providers...
Ghanem\LaravelSmsmisr\SmsmisrServiceProvider::class,
],
```
Or add an alias in your `config/app.php`:
```php
'aliases' => [
...
'Smsmisr' => Ghanem\LaravelSmsmisr\Smsmisr::class,
],
```
- Publish the config & views by running **smsmisr** :
```bash
php artisan vendor:publish --provider="Ghanem\LaravelSmsmisr\SmsmisrServiceProvider"
```
- Then update `config/smsmisr.php` with your credentials. Alternatively, you can update your `.env` file with the following:
```dotenv
SMSMISR_USERNAME=my_username
SMSMISR_PASSWORD=my_password
SMSMISR_SENDER=my_sender
```
## Usage
If you want to use the facade interface, you can `use` the facade class when needed:
```php
use use Ghanem\LaravelSmsmisr\Facades\Smsmisr;
...
public function myMethod() {
Smsmisr::send("hello world", "201010101010");
}
```
if you need use golbal:
```php
// Global
app('smsmisr')->send("hello world", "201010101010");
```
## Notifications
You can use the channel in your via() method inside the notification:
```php
namespace App\Notifications;
use Ghanem\LaravelSmsmisr\SmsmisrChannel;
use Ghanem\LaravelSmsmisr\SmsmisrMessage;
use Illuminate\Notifications\Notification;
class ExampleNotification extends Notification
{
public function via($notifiable)
{
return [SmsmisrChannel::class];
}
public function toSmsmisr($notifiable)
{
return new SmsmisrMessage(
'Your message here',
$notifiable->phone
);
}
}
```
### API
**Ghanem\LaravelSmsmisr\SmsmisrMessage**
```
(new SmsmisrMessage(string $message, string $to))
->to(string $to)
->from(string $from)
->unicode(bool $unicode = true)
```
## Licence
MIT
## Sponsor
[💚️ Become a Sponsor](https://github.com/sponsors/AbdullahGhanem)