PHPackages kheme/laravel-supertext-nigeria - 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. [HTTP & Networking](/categories/http) 4. / 5. kheme/laravel-supertext-nigeria AbandonedPackage[HTTP & Networking](/categories/http) kheme/laravel-supertext-nigeria =============================== A Laravel package for SuperText Nigeria's SMS API v1.0.0(5y ago)436MITPHPPHP >=5.3.0 Since Sep 19Pushed 5y ago1 watchersCompare [ Source](https://github.com/kheme/laravel-supertext-nigeria)[ Packagist](https://packagist.org/packages/kheme/laravel-supertext-nigeria)[ Docs](https://github.com/kheme/laravel-supertext-nigeria)[ RSS](/packages/kheme-laravel-supertext-nigeria/feed)WikiDiscussions master Synced yesterday READMEChangelog (1)DependenciesVersions (3)Used By (0) Laravel Package for SuperText Nigeria SMS Gateway --------------------------------------------------- [](#----laravel-package-for-supertext-nigeria-sms-gateway) [ ![Latest Stable Version](https://camo.githubusercontent.com/2f67907748907bf7c95764d580db1d220bb36e3d3e0cc51e65b358ed5bbe0071/68747470733a2f2f706f7365722e707567782e6f72672f6b68656d652f6c61726176656c2d7375706572746578742d6e6967657269612f762f737461626c65) ](https://packagist.org/packages/kheme/laravel-supertext-nigeria) [ ![Latest Unstable Version](https://camo.githubusercontent.com/c1a5190d879c321817355d2c0d6ba125c8e7c16565800e5bf923ce45a3193936/68747470733a2f2f706f7365722e707567782e6f72672f6b68656d652f6c61726176656c2d7375706572746578742d6e6967657269612f762f756e737461626c65) ](https://packagist.org/packages/kheme/laravel-supertext-nigeria) [ ![Total Downloads](https://camo.githubusercontent.com/b35a49348eaca26e0cb4b2d97989e50b2608cac0d978ef59ed3d1cba2ba556ce/68747470733a2f2f706f7365722e707567782e6f72672f6b68656d652f6c61726176656c2d7375706572746578742d6e6967657269612f646f776e6c6f616473) ](https://packagist.org/packages/kheme/laravel-supertext-nigeria) [ ![License](https://camo.githubusercontent.com/ad558bb2f89cec87230158462c64b283dea1a63bb1fd731c988e5e51c8158dfd/68747470733a2f2f706f7365722e707567782e6f72672f6b68656d652f6c61726176656c2d7375706572746578742d6e6967657269612f6c6963656e7365) ](https://packagist.org/packages/kheme/laravel-supertext-nigeria) Depreciation ============ [](#depreciation) This project is currently depreciated and archived because a framework agnostic PHP version is now available here: [PHP Wrapper for SuperText Nigeria SMS Gateway](https://github.com/kheme/php-supertext-nigeria) Introduction ------------ [](#introduction) This is a simple Laravel wrapper for [SuperText Nigeria](https://www.supertextng.com)'s SMS API gateway. Installation ------------ [](#installation) Using Composer: ``` composer require kheme/laravel-supertext-nigeria ``` #### Installing on Laravel 5.5 or above [](#installing-on-laravel-55-or-above) If you are using Laravel 5.5 or above, the package will automatically register the `supertext` provider and facade. #### Installing on Laravel 5.4 and below [](#installing-on-laravel-54-and-below) For Laravel 5.4 or below, add `Kheme\SuperTextNg\SuperTextNgServiceProvider` to the list of `providers` in your `config/app.php`: ``` 'providers' => [ // Other service providers... Kheme\SuperTextNg\SuperTextNgServiceProvider::class, ], ``` If you want to use the facade interface, you can `use` the facade class when needed: ``` use Kheme\SuperTextNg\Facade\SMS; ``` Or add to the list of aliases in your `config/app.php` as follows: ``` 'aliases' => [ ... 'SuperTextNg' => Kheme\SuperTextNg\Facade\SMS::class, ], ``` ### Installing on Lumen [](#installing-on-lumen) Laravel SuperTextNg works with Lumen too! You will need to do a little work by hand to get it up and running. First, install the package using composer: ``` composer require kheme/laravel-supertext-nigeria ``` Next, we have to tell Lumen that our library exists. Update `bootstrap/app.php` and register `SuperTextNgServiceProvider` as follows: ``` $app->register(Kheme\SuperTextNg\SuperTextNgServiceProvider::class); ``` At this point, set `SUPERTEXTNG_USERNAME`, `SUPERTEXTNG_PASSWORD`, `SUPERTEXTNG_SENDER` and `SUPERTEXTNG_IGNORE_DND` in your `.env` file and it should work for you. ### Configuration [](#configuration) Run `artisan vendor:publish` to copy the distribution configuration file to your app's config directory. ``` php artisan vendor:publish --provider="Kheme\SuperTextNG\SuperTextNgServiceProvider" ``` #### Configuration on Lumen [](#configuration-on-lumen) Unfortunately, Lumen doesn't support publishing files, so you will have to create the config file yourself by creating a config directory (if it doesn't exist) and copying the config file out of the package into your project. From your project's root folder, run the following command in the terminal: ``` mkdir config cp vendor/kheme/laravel-supertext-nigeria/config/supertextng.php config/supertextng.php ``` Update `config/supertextng.php` with your SuperText Nigeria credentials and settings. Alternatively, you can update your `.env` file with the respective values to the following: ``` SUPERTEXTNG_USERNAME=(your supertextng.com username) SUPERTEXTNG_PASSWORD=(your supertextng.com password) SUPERTEXTNG_SENDER=(you SMS sender ID) SUPERTEXTNG_IGNORE_DND=('yes' or 'no' indicating whether to send to do-not-disturb numbers) ``` Finally, add `$app->configure('supertextng');` to your `bootstrap/app.php` somewhere before registering the service provider above. ### Usage [](#usage) Don't forget to import the fascade before use: ``` use Kheme\SuperTextNg\Facades\SMS; ``` Sending to a single recipient ----------------------------- [](#sending-to-a-single-recipient) ``` SMS::from('Kheme') ->to('2348153332428') ->message('Using the facade to send a message.') ->send(); ``` On success, this should return `true`, otherwise, an exception will be thrown. Sending to multiple recipients ------------------------------ [](#sending-to-multiple-recipients) You can send an SMS to multiple recipients by including multiple `to()` in your call: ``` SMS::from('Kheme') ->to('2348153332428') ->to('2348056511193') ->message('Using the facade to send a message.') ->send(); ``` Or, by supplying an array of phone numbers to a single `to()`: ``` SMS::from('Kheme') ->to( [ '2348153332428', '2348056512393', ] ), ->message('Using the facade to send a message.') ->send(); ``` Send to DND enabled numbers --------------------------- [](#send-to-dnd-enabled-numbers) To send SMS to numbers that have Do Not Disturb (DND) enabled, include `ignoreDND()` to your call: ``` SMS::from('Kheme') ->to('2348153332428') ->message('Using the facade to send a message.') ->ignoreDND() ->send(); ``` Return unit balance after sending --------------------------------- [](#return-unit-balance-after-sending) If you would like to return your account balance after sending, include `returnBalance()` to your call: ``` SMS::from('Kheme') ->to('2348153332428') ->message('Using the facade to send a message.') ->returnBalance() ->send(); ``` Return amount of units used for sending --------------------------------------- [](#return-amount-of-units-used-for-sending) If you would like to return the total amount of units used after sending, include `returnUnitsUsed()` to your call: ``` SMS::from('Kheme') ->to('2348153332428') ->message('Using the facade to send a message.') ->returnUnitsUsed() ->send(); ``` Combining options ----------------- [](#combining-options) The above method options, exluding the `balance()` below, can be combined like in the following example: ``` SMS::from('Kheme') ->to('2348153332428') ->message('Using the facade to send a message.') ->returnBalance() ->returnUnitsUsed() ->ignoreDND() ->send(); ``` Checking account balance ------------------------ [](#checking-account-balance) To check your SuperText Nigeria credit balance, simply call `balance()`: ``` return SMS::balance(); ``` ### Errors [](#errors) In the case of an error, a call will return an error as follows: *The numbers on the left are the corresponding error code from SuperText Nigeria, but will not be included in the error response* - **100**: *One or more required url parameter is missing or misspelt* - **101**: *Username is blank* - **102**: *Password is blank* - **103**: *Destination is blank* - **104**: *Message is blank* - **105**: *Sender is blank* - **200**: *Wrong username or password* - **201**: *Account has not been activated* - **202**: *Inactive account* - **300**: *Insufficient credit* - **400**: *Failed delivery (no credit deducted)* ### Health Score 24 — LowBetter than 32% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity50 Maturing project, gaining track record 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. ### Release Activity Cadence Unknown Total 1 Last Release 2061d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/68ea4a1552f2217337119312b998af0f50b9c50a23a73eaa6bcab33a30891195?d=identicon)[kheme](/maintainers/kheme) --- Top Contributors [![kheme](https://avatars.githubusercontent.com/u/895416?v=4)](https://github.com/kheme "kheme (64 commits)") --- Tags laravellumensmssms-gatewaysupertext-nigerialaravelsmslaravel-smssms-gatewaylaravel sms senderlaravel sms gatewaykhemesupertextng ### Embed Badge ![Health badge](/badges/kheme-laravel-supertext-nigeria/health.svg) ``` [![Health](https://phpackages.com/badges/kheme-laravel-supertext-nigeria/health.svg)](https://phpackages.com/packages/kheme-laravel-supertext-nigeria) ``` ### Alternatives [tzsk/sms A robust and unified SMS gateway integration package for Laravel, supporting multiple providers. 320244.3k6](/packages/tzsk-sms) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)