PHPackages hanymigame/smspush-notification - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. hanymigame/smspush-notification ActiveLibrary[Mail & Notifications](/categories/mail) hanymigame/smspush-notification =============================== Laravel Package to send sms and push notifications to Android and IOS devices. (GCM,FCM,APN,SMS) 07PHP Since Jan 4Pushed 3y ago1 watchersCompare [ Source](https://github.com/HanymiGame/SmsPushNotification)[ Packagist](https://packagist.org/packages/hanymigame/smspush-notification)[ RSS](/packages/hanymigame-smspush-notification/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (1)Used By (0) Repack () edit Apn, Gcm, add Sms channel #### Push Service Providers Available: [](#push-service-providers-available) - GCM - FCM - APN - SMS Installation ------------ [](#installation) ### Laravel 5.8/6 and higher [](#laravel-586-and-higher) type in console: ``` composer require hanymigame/smspush-notification ``` The package will automatically register its service provider. Publish the package's configuration file to the application's own config directory ``` php artisan vendor:publish --provider="HG\SmsPushNotification\Providers\SmsPushNotificationServiceProvider" --tag="config" ``` > Go to [laravel facade sample](https://github.com/HanymiGame/SmsPushNotification#laravel-alias-facade) directly. ### Configuration [](#configuration) After publishing the configuration, you can find the Push service config in config/smspushnotification.php The default configuration parameters for **GCM** and **FCM** are : - priority => normal - dry\_run => false - apiKey => Your ApiKey You can dynamically update those values or adding new ones calling the method setConfig like so: ``` $push->setConfig([ 'priority' => 'high', 'dry_run' => true, 'time_to_live' => 3 ]); ``` The default configuration parameters for **APN** are: - `certificate => __DIR__ . '/iosCertificates/yourCertificate.pem'` - `passPhrase => 'MyPassPhrase'` - `passFile => __DIR__ . '/iosCertificates/yourKey.pem' //Optional` - `dry_run => false` (Make sure to set `dry_run` to `true` if you're using development \*.pem certificate, and `false` for production) Also you can update those values and add more dynamically ``` $push->setConfig([ 'passPhrase' => 'NewPass', 'custom' => 'MycustomValue', 'dry_run' => true ]); ``` Even you may update the url of the Push Service dynamically like follows: ``` $push->setUrl('http://newSmsPushServiceUrl.com'); ``` > Not update the url unless it's really necessary. You can specify the number of client-side attempts to APN before giving up. The default amount is 3 attempts. You can override this value by specifying `connection_attempts` in `setConfig()` assoc-array. Keep in mind the default number of requested attempts is 3. If you prefer to retry indefinitely, set `connection_attempts` to zero. ``` $push->setConfig([ 'passPhrase' => 'NewPass', 'custom' => 'MycustomValue', 'connection_attempts' => 0, 'dry_run' => true ]); ``` Usage ----- [](#usage) ``` $push = new PushNotification; ``` By default it will use GCM as Push Service provider. For APN Service: ``` $push = new PushNotification('apn'); ``` For FCM Service: ``` $push = new PushNotification('fcm'); ``` Now you may use any method that you need. Please see the API List. API List -------- [](#api-list) - [setService](https://github.com/HanymiGame/SmsPushNotification#setservice) - [setMessage](https://github.com/HanymiGame/SmsPushNotification#setmessage) - [setDevicesToken](https://github.com/HanymiGame/SmsPushNotification#setdevicestoken) - [send](https://github.com/HanymiGame/SmsPushNotification#send) - [getFeedback](https://github.com/HanymiGame/SmsPushNotification#getfeedback) - [getUnregisteredDeviceTokens](https://github.com/HanymiGame/SmsPushNotification#getunregistereddevicetokens) - [setConfig](https://github.com/HanymiGame/SmsPushNotification#setconfig) - [setUrl](https://github.com/HanymiGame/SmsPushNotification#seturl) ### Only for Gcm and Fcm [](#only-for-gcm-and-fcm) - [setApiKey](https://github.com/HanymiGame/SmsPushNotification#setapikey) ### Only for Fcm [](#only-for-fcm) - [sendByTopic](https://github.com/HanymiGame/SmsPushNotification#sendbytopic) > Go to [Usage samples](https://github.com/HanymiGame/SmsPushNotification#usage-samples) directly. #### setService [](#setservice) `setService` method sets the push service to be used, which you pass the name through parameter as a string. **Syntax** ``` object setService($name) ``` #### setMessage [](#setmessage) `setMessage` method sets the message parameters, which you pass the values through parameter as an array. **Syntax** ``` object setMessage(array $data) ``` #### setApiKey [](#setapikey) > Only for gcm and fcm `setApiKey` method sets the API Key of your App, which you pass the key through parameter as a string. **Syntax** ``` object setApiKey($api_key) ``` #### setDevicesToken [](#setdevicestoken) `setDevicesToken` method sets the devices' tokens, which you pass the token through parameter as array or string if it was only one. **Syntax** ``` object setDevicesToken($deviceTokens) ``` #### send [](#send) `send` method sends the notification. **Syntax** ``` object send() ``` #### getFeedback [](#getfeedback) `getFeedback` method gets the notification response, which you may use it chaining it to `send` method or call it whenever after sending a notification. **Syntax** ``` object getFeedback() ``` #### getUnregisteredDeviceTokens [](#getunregistereddevicetokens) `getUnregisteredDeviceTokens` method gets the devices' tokens that couldn't receive the notification because they aren't registered to the Push service provider. You may use it chaining it to `send` method or call it whenever after sending a notification. **Syntax** ``` array getUnregisteredDeviceTokens() ``` #### setConfig [](#setconfig) `setConfig` method sets the Push service configuration, which you pass the name through parameter as an array. **Syntax** ``` object setConfig(array $config) ``` #### setUrl [](#seturl) `setUrl` method sets the Push service url, which you pass the name through parameter as a string. **Syntax** ``` object setUrl($url) ``` > Not update the url unless it's really necessary. #### sendByTopic [](#sendbytopic) > Only for fcm `sendBytopic` method sends a message by topic. It also accepts the topic condition. more details [here](https://firebase.google.com/docs/cloud-messaging/android/topic-messaging) > If isCondition is true, $topic will be treated as an expression **Syntax** ``` object sendByTopic($topic,$isCondition) ``` ### Usage samples [](#usage-samples) > You can chain the methods. Sms sample: ``` $push->setMessage(['This is the SMS message']) ->setDevicesToken(['79998887766','75554443322'...]); ``` GCM sample: ``` $push->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ], 'data' => [ 'extraPayLoad1' => 'value1', 'extraPayLoad2' => 'value2' ] ]) ->setApiKey('Server-API-Key') ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]); ``` APN sample: ``` $push->setMessage([ 'aps' => [ 'alert' => [ 'title' => 'This is the title', 'body' => 'This is the body' ], 'sound' => 'default', 'badge' => 1 ], 'extraPayLoad' => [ 'custom' => 'My custom data', ] ]) ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]); ``` or do it separately ``` $push->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ], 'data' => [ 'extraPayLoad1' => 'value1', 'extraPayLoad2' => 'value2' ] ]); $push->setApiKey('Server-API-Key'); $push->setDevicesToken(['deviceToken1' ,'deviceToken2', 'deviceToken3' ]); ``` If you want send the notification to only 1 device, you may pass the value as string. ``` $push->setDevicesToken('deviceToken'); ``` ### Send the Notification [](#send-the-notification) Method send() can be also chained to the above methods. ``` $push->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ], 'data' => [ 'extraPayLoad1' => 'value1', 'extraPayLoad2' => 'value2' ] ]) ->setApiKey('Server-API-Key') ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]) ->send(); ``` ### Send the Notification by Topic (**FCM** only) [](#send-the-notification-by-topic-fcm-only) ``` $push = new SmsPushNotification('fcm'); $response = $push->setMessage(['message'=>'Hello World']) ->setApiKey('YOUR-API-KEY') ->setConfig(['dry_run' => false]) ->sendByTopic('dogs'); ``` or with a condition: ``` $push = new SmsPushNotification('fcm'); $response = $push->setMessage(['message'=>'Hello World']) ->setApiKey('YOUR-API-KEY') ->setConfig(['dry_run' => false]) ->sendByTopic("'dogs' in topics || 'cats' in topics",true); ``` ### Understanding Gcm and Fcm Message Payload [](#understanding-gcm-and-fcm-message-payload) #### Notification Message [](#notification-message) Add a `notification` key when setting the message in `setMessage` method. like follows: ``` $push->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ] ); ``` You may add some extra payload adding a `data` key when setting the message in `setMessage` method. ``` $push->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ], 'data' => [ 'extraPayLoad1' => 'value1', 'extraPayLoad2' => 'value2' ] ]); ``` #### Data Message [](#data-message) By default, this package sends the notification as Data Message. So no need to add a `data` key. ``` $push->setMessage([ 'title'=>'This is the title', 'body'=>'This is the message', 'myCustomVAlue' => 'value' ]); ``` The above example is like you were sending the following: ``` $push->setMessage([ 'data' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'myCustomVAlue' => 'value' ] ]); ``` For more details, have a look at [gcm/fcm notification paypload support](https://firebase.google.com/docs/cloud-messaging/http-server-ref#notification-payload-support) and [the concept options](https://firebase.google.com/docs/cloud-messaging/concept-options) ### Getting the Notification Response [](#getting-the-notification-response) If you want to get the push service response, you can call the method `getFeedback`: ``` $push->getFeedback(); ``` Or again, chain it to the above methods: ``` $push->setMessage(['body'=>'This is the message','title'=>'This is the title']) ->setApiKey('Server-API-Key') ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]) ->send() ->getFeedback(); ``` It will return an object with the response. ### APN Server Feedback and package Feedback [](#apn-server-feedback-and-package-feedback) Any time you send a notification, it will check if APN server has any feedback for your certificate. If so, the responses are merged to our feedback like below: ``` class stdClass#21 (4) { public $success => int(0) public $failure => int(1) public $tokenFailList => array(1) { [0] => string(64) "c55741656e6c3185f3474291aebb5cf878b8719288e52bf4c497292b320312c5" } public $apnsFeedback => array(1) { [0] => class stdClass#16 (3) { public $timestamp => int(1478272639) public $length => int(32) public $devtoken => string(64) "c55741656e6c3185f3474291aebb5cf878b8719288e52bf4c497292b320312c5" } } } ``` ### Get Unregistered Devices tokens [](#get-unregistered-devices-tokens) After sending a notification, you may retrieve the list of unregistered tokens ``` $push->getUnregisteredDeviceTokens(); ``` This method returns an array of unregistered tokens from the Push service provider. If there isn't any unregistered token, it will return an empty array. ### Laravel Alias Facade [](#laravel-alias-facade) After register the Alias Facade for this Package, you can use it like follows: ``` SmsPushNotification::setService('fcm') ->setMessage([ 'notification' => [ 'title'=>'This is the title', 'body'=>'This is the message', 'sound' => 'default' ], 'data' => [ 'extraPayLoad1' => 'value1', 'extraPayLoad2' => 'value2' ] ]) ->setApiKey('Server-API-Key') ->setDevicesToken(['deviceToken1','deviceToken2','deviceToken3'...]) ->send() ->getFeedback(); ``` It would return the Push Feedback of the Notification sent. ### Notification channels [](#notification-channels) #### Formatting Push Notifications [](#formatting-push-notifications) If a notification supports being sent as an push message, you should define `toApn` and/or `toFcm`/`toGcm` methods on the notification class. This method will receive a `$notifiable` entity and should return a `HG\SmsPushNotification\Messages\SmsPushMessage` instance: ``` public function toApn($notifiable) { return new SmsPushMessage('Hello world'); } ``` #### Customizing The Title and Body [](#customizing-the-title-and-body) ``` public function toApn($notifiable) { return (new SmsPushMessage) ->title('Hello world') ->body('...'); } ``` #### Customizing The Notification Sound [](#customizing-the-notification-sound) ``` public function toApn($notifiable) { return (new SmsPushMessage) ->body('Hello world') ->sound('default'); } ``` #### Customizing The Badge Number [](#customizing-the-badge-number) ``` public function toApn($notifiable) { return (new SmsPushMessage) ->body('Hello world') ->sound('default') ->badge(7); } ``` #### Passing Service Config [](#passing-service-config) ``` public function toApn($notifiable) { return (new SmsPushMessage) ->body('Hello world') ->config(['dry_run' => false]); } ``` #### Add it to the notification channels [](#add-it-to-the-notification-channels) ``` public function via($notifiable) { return [ApnChannel::class]; } ``` > Don't forget the use statement at the top of the class #### Routing Push Notifications [](#routing-push-notifications) Just define `routeNotificationForApn` and/or `routeNotificationForFcm`/`routeNotificationForGcm` methods on the entity ``` /** * Route notifications for the Apn channel. * * @return string|array */ public function routeNotificationForApn() { return $this->ios_push_token; } ``` ### Health Score 14 — LowBetter than 1% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community7 Small or concentrated contributor base Maturity24 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/bbc09ffde4500dbbe52e1267570c26b3827ad9d1c62f6f880d7a321a366a5262?d=identicon)[HanymiGame](/maintainers/HanymiGame) --- Top Contributors [![HanymiGame](https://avatars.githubusercontent.com/u/118646369?v=4)](https://github.com/HanymiGame "HanymiGame (4 commits)") ### Embed Badge ![Health badge](/badges/hanymigame-smspush-notification/health.svg) ``` [![Health](https://phpackages.com/badges/hanymigame-smspush-notification/health.svg)](https://phpackages.com/packages/hanymigame-smspush-notification) ``` ### Alternatives [maize-tech/laravel-email-domain-rule Laravel Email Domain Rule 612.0k](/packages/maize-tech-laravel-email-domain-rule)[sarfraznawaz2005/noty Laravel package to incorporate noty flash notifications into laravel. 324.5k](/packages/sarfraznawaz2005-noty) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)