PHPackages cammac/sms - 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. cammac/sms ActiveLibrary[Mail & Notifications](/categories/mail) cammac/sms ========== this package made for Laravel to send/receive (polling/pushing) text messages. Currently supports smsgw.net, mobily.ws, CalLFire, EZTexting, Email Gateways, FlowRoute, LabsMobile, Mozeo, Nexmo, Plivo, Twilio, and Zenvia 1.0.1(7y ago)17932MITPHP Since Jun 27Pushed 7y ago2 watchersCompare [ Source](https://github.com/efrontsa/sms)[ Packagist](https://packagist.org/packages/cammac/sms)[ RSS](/packages/cammac-sms/feed)WikiDiscussions master Synced yesterday READMEChangelog (1)Dependencies (7)Versions (3)Used By (0) Extent Simple SMS ================= [](#extent-simple-sms) Introduction ------------ [](#introduction) [Simple SMS](https://github.com/SimpleSoftwareIO/simple-sms) is an easy to use package for [Laravel](http://laravel.com/) that adds the capability to send and receive SMS/MMS messages to mobile phones from your web app. It currently supports a free way to send SMS messages through E-Mail gateways provided by the wireless carriers. The package also supports 9 paid services, [Call Fire,](https://www.callfire.com/) [EZTexting,](https://www.eztexting.com) [FlowRoute,](https://www.flowroute.com/) [LabsMobile,](http://www.labsmobile.com) [Mozeo,](https://www.mozeo.com/) [Nexmo,](https://www.nexmo.com/) [Plivo,](https://www.plivo.com/) [Twilio,](https://www.twilio.com) [Zenvia,](http://www.zenvia.com.br/) [SMSgw,](http://www.smsgw.net/) [Mobily.ws.](http://www.mobily.ws) - [Introduction](#docs-introduction) - [Requirements](#docs-requirements) - [Configuration](#docs-configuration) - [SMSgw Driver](#docs-smsGW-driver) - [Mobily.ws Driver](#docs-mobily.ws-driver) - [Call Fire Driver](#docs-call-fire-driver) - [E-mail Driver](#docs-e-mail-driver) - [EZTexting Driver](#docs-ez-texting-driver) - [FlowRoute Driver](#docs-flow-route-driver) - [LabsMobile Driver](#docs-labsmobile-driver) - [Log Driver](#docs-log-driver) - [Mozeo Driver](#docs-mozeo-driver) - [Nexmo Driver](#docs-nexmo-driver) - [Plivo Driver](#docs-plivo-driver) - [Twilio Driver](#docs-twilio-driver) - [Zenvia Driver](#docs-zenvia-driver) - [JustSend Driver](#docs-justsend-driver) - [Driver Support](#docs-driver-support) - [Usage](#docs-usage) - [Outgoing Message Enclosure](#docs-outgoing-enclosure) - [Incoming Message](#docs-incoming-message) Requirements ------------ [](#requirements) #### Laravel 5 [](#laravel-5) - PHP: >= 7.x - Guzzle >= 6.0 Configuration ------------- [](#configuration) #### Composer [](#composer) ``` $ composer require cammac/sms ``` #### Service Provider [](#service-provider) if your Laravel below 5.5 you need to add PostMarkServiceProvider in `config/app.php` in `providers` list ``` \Cammac\LaravelSms\LaravelSmsServiceProvider::class, ``` #### Aliases [](#aliases) if your Laravel below 5.5 you need to add PostMarkServiceProvider in `config/app.php` in `aliases` list Add ``` 'SMS' => SimpleSoftwareIO\SMS\Facades\SMS::class, ``` in your `config/app.php` configuration file within the `aliases` array. #### API Settings [](#api-settings) You must run the following command to save your configuration files to your local app: ``` $ php artisan vendor:publish ``` This will copy the configuration files to your `config` folder. #### Driver Configuration [](#driver-configuration) ###### SMSgw Driver [](#smsgw-driver) This driver sends messages through the [smsgw.net](https://smsgw.net/) service. It is a very quick and reliable service provider. Fill in the `config` file with the correct settings to use this driver. You can find these settings under your SMSgw account ``` return [ 'driver' => 'smsgw', 'from' => 'Company A', 'smsgw' => [ 'username' => 'Your username', 'password' => 'Your Password' ], ]; ``` ###### Mobily.ws Driver [](#mobilyws-driver) This driver sends and receives all messages through the [Mobily.ws](https://www.Mobily.ws/) service. Fill in the `config` file with the correct settings to use this driver. ``` return [ 'driver' => 'mobilyws', 'from' => 'Company A', 'mobilyws' => [ 'username' => 'Your username', 'password' => 'Your Password' ], ]; ``` ###### Call Fire Driver [](#call-fire-driver) This driver sends and receives all messages through the [Call Fire](https://www.callfire.com/) service. It is a very quick and reliable service provider that includes many features such as drip campaigns and voice services. Fill in the `config` file with the correct settings to use this driver. You can find these settings under your CallFire account and then selecting [API Access.](https://www.callfire.com/ui/manage/access) ``` return [ 'driver' => 'callfire', 'from' => 'Not Use For Call Fire', 'callfire' => [ 'app_login' => 'Your App Login', 'app_password' => 'Your App Password' ], ]; ``` ###### E-mail Driver [](#e-mail-driver) The E-Mail driver sends all messages through the configured e-mail driver for Laravel. This driver uses the wireless carrier's e-mail gateways to send SMS messages to mobile phones. The biggest benefit to using the e-mail driver is that it is completely free to use. The only setting for this driver is the `from` setting. Simply enter an email address that you would like to send messages from. ``` return [ 'driver' => 'email', 'from' => 'example@example.com', ]; ``` > If messages are not being sent, ensure that you are able to send E-Mail through Laravel first. The following are currently supported by using the e-mail gateway driver. CountryCarrierCarrier PrefixSMS SupportedMMS SupportedUSAAT&TattYesYesUSAAir Fire MobileairfiremobileYesNoUSAAlaska CommunicatesalaskacommunicatesYesYesUSAAmeritechameritechYesNoUSABoost MobilemoostmobileYesYesUSAClear TalkcleartalkYesNoUSACricketcricketYesNoUSAMetro PCSmetropcsYesYesUSANexTechnextechYesNoUSAProject FiprojectfiYesYesCanadaRogers WirelessrogerswirelessYesYesUSAUnicelunicelYesYesUSAVerizon WirelessverizonwirelessYesYesUSAVirgin MobilevirginmobileYesYesUSAT-MobiletmobileYesYesUSASprintsprintYesYesUSAUS CellularuscellularYesYes> You must know the wireless provider for the mobile phone to use this driver. > Careful! Not all wireless carriers support e-mail gateways around the world. > Some carriers slightly modify messages by adding the `from` and `to` address to the SMS message. ###### EZTexting [](#eztexting) This driver sends all messages through the [EZTexting](https://www.eztexting.com) service. EZTexting has many different options that have proven to be reliable and fast. Fill in the `config` file with the correct settings to enable EZTexting. ``` return [ 'driver' => 'eztexting', 'from' => 'Not Use For EZTexting', 'eztexting' => [ 'username' => 'Your Username', 'password' => 'Your Password' ], ]; ``` To enable `receive()` for this service, you must visit the [EZTexting settings page.](https://app.eztexting.com/keywords/index/format/apist) Enable the `Forwarding API` and `Keyword API` for the messages that you would like forwarded to your web application. > Note: All messages from EZTexting come from the same short number (313131) ###### FlowRoute [](#flowroute) This driver sends all messages through the [FlowRoute](https://www.flowroute.com/) service. Fill in the `config` file with the correct settings to enable EZTexting. ``` return [ 'driver' => 'flowroute', 'from' => 'Not Use For EZTexting', 'flowroute' => [ 'access_key' => 'Your Access Key', 'secret_key' => 'Your Secret Key' ], ]; ``` To enable `receive()` for this service, you must visit the [FlowRoute settings page.](https://developer.flowroute.com/docs/lookup-a-set-of-messages) Enable the `Forwarding API` and `Keyword API` for the messages that you would like forwarded to your web application. ###### LabsMobile Driver [](#labsmobile-driver) This driver sends all messages through the [LabsMobile](http://www.labsmobile.com/) service. These settings can be found on your [API Settings](https://www.labsmobile.com/es/login) page. ``` return [ 'driver' => 'labsmobile', 'from' => 'Sender', 'labsmobile' => [ 'username' => 'Your Username', 'password' => 'Your Password', ] ]; ``` ###### Log Driver [](#log-driver) The log driver is just a simple testing driver. This will log that a SMS message was sent in your `storage/logs` folder. ``` return [ 'driver' => 'log', ]; ``` ###### Mozeo Driver [](#mozeo-driver) This driver sends all messages through the [Mozeo](https://www.mozeo.com/) service. These settings can be found on your [API Settings](https://www.mozeo.com/mozeo/customer/platformdetails.php) page. ``` return [ 'driver' => 'mozeo', 'from' => 'Not Used With Mozeo', 'mozeo' => [ 'companyKey' => 'Your Company Key', 'username' => 'Your Username', 'password' => 'Your Password' ] ]; ``` > Note: All messages from Mozeo come from the same short number (24587) ###### Nexmo Driver [](#nexmo-driver) This driver sends messages through the [Nexmo](https://www.nexmo.com/product/messaging/) messaging service. It is very reliable and capable of sending messages to mobile phones worldwide. Check out the [guide on choosing the correct encoding for your messages](https://help.nexmo.com/hc/en-us/articles/204076866-How-Long-is-a-Single-SMS-body-). ``` return [ 'driver' => 'nexmo', 'from' => 'Company Name', 'nexmo' => [ 'api_key' => 'Your Nexmo API Key', 'api_secret' => 'Your Nexmo API Secret', 'encoding' => 'unicode', // Can be `unicode` or `gsm` ] ]; ``` To enable `receive()` messages you must set up the [request URL.](https://docs.nexmo.com/index.php/sms-api/handle-inbound-message) ###### Plivo Driver [](#plivo-driver) This driver sends messages through the [Plivo](https://www.plivo.com/) messaging service. ``` return [ 'driver' => 'plivo', 'from' => 'Company Name', 'plivo' => [ 'auth_id' => 'Your Auth ID.', 'auth_token' => 'Your Auth Token.' ] ]; ``` To enable `receive()` messages you must set up the [request URL.](https://manage.plivo.com/endpoint/) ###### Twilio Driver [](#twilio-driver) This driver sends messages through the [Twilio](https://www.twilio.com/sms) messaging service. It is very reliable and capable of sending messages to mobile phones worldwide. ``` return [ 'driver' => 'twilio', 'from' => '+15555555555', //Your Twilio Number in E.164 Format. 'twilio' => [ 'account_sid' => 'Your SID', 'auth_token' => 'Your Token', 'verify' => true, //Used to check if messages are really coming from Twilio. ] ]; ``` ###### Zenvia Driver [](#zenvia-driver) This driver sends messages through the \[Zenvia\]( messaging service which is a popular service in Brazil. ``` return [ 'driver' => 'zenvia', 'from' => 'Your Number', 'zenvia' => [ 'account_key' => 'Your Account Key.', 'passcode' => 'Your Passcode.' 'call_back_option' => 'The URL you wish to have receive messages sent to.' ] ]; ``` ###### JustSend Driver [](#justsend-driver) This driver sends messages through the [JustSend](https://justsend.pl/) messaging service which is only avaliable in Poland. ``` return [ 'driver' => 'justsend', 'from' => 'From text', 'justsend' => [ 'api_key' => 'Your API Key.' ] ]; ``` `from` can be one of the following: - `ECO` - cheapest type (about 0.03 PLN per SMS). SMS will be send from random short-code number. - One of: `INFO`, `INFORMACJA`, `KONKURS`, `NOWOSC`, `OFERTA`, `OKAZJA`, `PROMOCJA`, `SMS` - about 0.06 PLN per SMS. - Any other text (can not be only number) - about 0.07 PLN per SMS. Driver Support -------------- [](#driver-support) Not all drivers support every method due to the differences in each individual API. The following table outlines what is supported for each driver. | Driver | Send | Queue | CheckMessages | GetMessage | Receive | | --- | --- | --- | --- | --- | --- | --- | | Call Fire | Yes | Yes | Yes | Yes | No | | E-Mail | Yes | Yes | No | No | No | | EZTexting | Yes | Yes | Yes | Yes | Yes | | FlowRoute | Yes | Yes | Yes | Yes | Yes | | LabsMobile | Yes | Yes | No | No | No | | Log | Yes | Yes | No | No | No | | Mozeo | Yes | Yes | No | No | No | | Nexmo | Yes | Yes | Yes | Yes | Yes | | Plivo | Yes | Yes | Yes | Yes | Yes | | Twilio | Yes | Yes | Yes | Yes | Yes | | Zenvia | Yes | Yes | Yes | Yes | Yes | | JustSend | Yes | Yes | No | No | No | Usage ----- [](#usage) #### Basic Usage [](#basic-usage) Simple SMS operates in much of the same way as the Laravel Mail service provider. If you are familiar with this then SMS should feel like home. The most basic way to send a SMS is to use the following: ``` //Service Providers Example SMS::send('Your SMS Message', null, function($sms) { $sms->to('+15555555555'); }); //Service Providers Using A Laravel View //$data is the information that will be passed onto the view file. SMS::send('laravel::viewFile', $data, function($sms) { $sms->to('+15555555555'); }); //Email Driver Example SMS::send('Your SMS Message', null, function($sms) { $sms->to('+15555555555', 'att'); }); ``` The first parameter is the view file that you would like to use. The second is the data that you wish to pass to the view. The final parameter is a callback that will set all of the options on the `message` closure. #### Send [](#send) The `send` method sends the SMS through the configured driver using a Laravel view file. ``` SMS::send($view, Array $data, function($sms) { $sms->to('+15555555555'); } SMS::send('laravel::view', $data, function($sms) { $sms->to('+15555555555'); }); ``` It is possible to send a simple message without creating views by passing a string instead of a view. ``` SMS::send($message, [], function($sms) { $sms->to('+15555555555'); } SMS::send('This is my message', [], function($sms) { $sms->to('+15555555555'); }); ``` #### Driver [](#driver) The `driver` method will switch the provider during runtime. ``` //Will send through default provider set in the config file. SMS::queue('Your SMS Message', $data, function($sms) { $sms->to('+15555555555'); }); SMS::driver('twilio'); //Will send through Twilio SMS::queue('Your SMS Message', $data, function($sms) { $sms->to('+15555555555'); }); ``` #### Queue [](#queue) The `queue` method queues a message to be sent later instead of sending the message instantly. This allows for faster respond times for the consumer by offloading uncustomary processing time. Like `Laravel's Mail` system, queue also has `queueOn,` `later,` and `laterOn` methods. ``` SMS::queue('Your SMS Message', $data, function($sms) { $sms->to('+15555555555'); }); ``` > The `queue` method will fallback to the `send` method if a queue service is not configured within `Laravel.` #### Receive [](#receive) Simple SMS supports push SMS messages. You must first configure this with your service provider by following the configuration settings above. ``` Route::post('sms/receive', function() { SMS::receive(); } ``` The receive method will return a `IncomingMessage` instance. You may request any data off of this instance like: ``` Route::post('sms/receive', function() { $incoming = SMS::receive(); //Get the sender's number. $incoming->from(); //Get the message sent. $incoming->message(); //Get the to unique ID of the message $incoming->id(); //Get the phone number the message was sent to $incoming->to(); //Get the raw message $incoming->raw(); } ``` The `raw` method returns all of the data that a driver supports. This can be useful to get information that only certain service providers provide. ``` Route::post('sms/receive', function() { $incoming = SMS::receive(); //Twilio message status echo $incoming->raw()['status']; } ``` The above would return the status of the message on the Twilio driver. > Data used from the `raw` method will not work on other service providers. Each provider has different values that are sent out with each request. #### Check Messages [](#check-messages) This method will retrieve an array of messages from the service provider. Each message within the array will be an `IncomingMessage` object. ``` $messages = SMS::checkMessages(); foreach ($messages as $message) { //Will display the message of each retrieve message. echo $message->message(); } ``` The `checkMessages` method supports has an `options` variable to pass some settings onto each service provider. See each service providers API to see which `options` may be passed. More information about each service provider can be found at their API docs. - [Call Fire](https://www.callfire.com/api-documentation/rest/version/1.1#!/text/QueryTexts_get_1) - [EZTexting](https://www.eztexting.com/developers/sms-api-documentation/rest) - [FlowRoute](https://developer.flowroute.com/) - [LabsMobile](http://www.labsmobile.com/en/api-sms) - [Mozeo](https://www.mozeo.com/mozeo/customer/Mozeo_API_OutboundSMS.pdf) - [Nexmo](https://docs.nexmo.com/index.php/developer-api/search-message) - [Plivo](https://www.plivo.com/docs/) - [Twilio](https://www.twilio.com/docs/api/rest/message#list-get) - [Zenvia](http://www.zenvia.com.br/desenvolvedores/) #### Get Message [](#get-message) You are able to retrieve a message by it's ID with a simply call. This will return an IncomingMessage object. ``` $message = SMS::getMessage('aMessageId'); //Prints who the message came from. echo $message->from(); ``` Outgoing Message ---------------- [](#outgoing-message) #### To [](#to) The `to` method adds a phone number that will have a message sent to it. ``` //Service Provider Example SMS::send('Your SMS Message', $data, function($sms) { $sms->to('+15555555555'); $sms->to('+14444444444'); }); ``` > The carrier is required for the email driver so that the correct email gateway can be used. See the table above for a list of accepted carriers. #### From [](#from) The `from` method will set the address from which the message is being sent. ``` SMS::send('Your SMS Message', $data, function($sms) { $sms->from('+15555555555'); }); ``` #### attachImage [](#attachimage) The `attachImage` method will add an image to the message. This will also convert the message to a MMS because SMS does not support image attachments. ``` //Service Provider Driver SMS::send('Your SMS Message', $data, function($sms) { $sms->attachImage('/url/to/image.jpg'); }); ``` > Currently only supported with the E-Mail and Twilio Driver. Incoming Message ---------------- [](#incoming-message) All incoming messages generate a `IncomingMessage` object. This makes it easy to retrieve information from them in a uniformed way across multiple service providers. #### Raw [](#raw) The `raw` method returns the raw data provided by a service provider. ``` $incoming = SMS::getMessage('messageId'); echo $incoming->raw()['status']; ``` > Each service provider has different information in which they supply in their requests. See their documentations API for information on what you can get from a `raw` request. #### From [](#from-1) This method returns the phone number in which a message came from. ``` $incoming = SMS::getMessage('messageId'); echo $incoming->from(); ``` #### To [](#to-1) The `to` method returns the phone number that a message was sent to. ``` $incoming = SMS::getMessage('messageId'); echo $incoming->to(); ``` ### Health Score 31 — LowBetter than 66% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity19 Limited adoption so far Community9 Small or concentrated contributor base Maturity64 Established project with proven stability 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 Every ~14 days Total 2 Last Release 2910d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/545ac5f8546ec191c3b59dba187745f010f346788c48518282844b8036fda9df?d=identicon)[efrontsa](/maintainers/efrontsa) --- Top Contributors [![algethamy](https://avatars.githubusercontent.com/u/9952761?v=4)](https://github.com/algethamy "algethamy (3 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/cammac-sms/health.svg) ``` [![Health](https://phpackages.com/badges/cammac-sms/health.svg)](https://phpackages.com/packages/cammac-sms) ``` ### Alternatives [propaganistas/laravel-disposable-email Disposable email validator 6012.9M7](/packages/propaganistas-laravel-disposable-email)[psalm/plugin-laravel Psalm plugin for Laravel 3355.3M337](/packages/psalm-plugin-laravel)[illuminate/mail The Illuminate Mail package. 5910.6M479](/packages/illuminate-mail)[illuminate/notifications The Illuminate Notifications package. 513.1M1.1k](/packages/illuminate-notifications)[erag/laravel-disposable-email A Laravel package to detect and block disposable email addresses. 254168.5k](/packages/erag-laravel-disposable-email) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)