PHPackages kamran377/yii2-sms-twilio - 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. kamran377/yii2-sms-twilio ActiveYii2-extension[Mail & Notifications](/categories/mail) kamran377/yii2-sms-twilio ========================= A Twilio SMS plugin for Yii2 based off my base package, Yii2 SMS, to make sending SMS messages as easy as emails! v1.1.1(3y ago)0119MITPHPPHP >=8.0.0 Since Aug 8Pushed 3y ago1 watchersCompare [ Source](https://github.com/kamran377/yii2-sms-twilio)[ Packagist](https://packagist.org/packages/kamran377/yii2-sms-twilio)[ Docs](https://github.com/kamran377/yii2-sms-twilio)[ RSS](/packages/kamran377-yii2-sms-twilio/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (2)Dependencies (3)Versions (3)Used By (0) Yii2 SMS Twilio =============== [](#yii2-sms-twilio) A Twilio SMS plugin for Yii2 based off my base package, [Yii2 SMS](https://github.com/kamran377/yii2-sms), to make sending SMS messages as easy as emails! Installation ------------ [](#installation) The preferred way to install this extension is through [composer](http://getcomposer.org/download/) Either run ``` composer require --prefer-dist kamran377/yii2-sms-twilio ``` or add ``` "kamran377/yii2-sms-twilio": "~1.0" ``` to the require section of your application's `composer.json` file. Then add a new `sms` component to your `main-local.php` (advanced) or `web.php` (basic) like so: ``` 'sms' => [ 'class' => 'kamran377\sms\twilio\Sms', // Advanced app use '@common/sms', basic use '@app/sms' 'viewPath' => '@common/sms', // Optional: defaults to '@app/sms' // send all sms to a file by default. You have to set // 'useFileTransport' to false and configure the messageConfig['from'], // 'sid', and 'token' to send real messages 'useFileTransport' => true, 'messageConfig' => [ 'from' => '+15552221234', // Your Twilio number (full or shortcode) ], // Find your Account Sid and Auth Token at https://twilio.com/console 'sid' => 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'token' => 'your_auth_token', // Tell Twilio where to POST information about your message. // @see https://www.twilio.com/docs/sms/send-messages#monitor-the-status-of-your-message //'statusCallback' => 'https://example.com/path/to/callback', // optional ], ``` > Note: This package does not provide a route for the `statusCallback`. You will need to create your own route to handle this. It isn't necessary to send SMS messages with Twilio, and is used for deeper tracking of each message's status. Usage ----- [](#usage) You can send SMS messages two ways. One uses a view file, just like how the mailer does, by passing it in the `compose()` call. Only difference is, you don't specify html/text array keys. Just pass the string, since text messages don't use html. ### With a view file [](#with-a-view-file) In your controller/model use it like so: ``` Yii::$app->sms->compose('test-message', ['name' => 'Wade']) //->setFrom('12345') // if not set in config, or to override ->setTo('+15558881234') ->send(); ``` You will need a view file located where your `viewPath` points to. By default, it is `@app/sms`. You can see in the configuration above that we overrode it to `@common/sms`. This is similar to the location Yii2 Advanced uses for the email views, the "common" directory. View File: `common/sms/test-message.php` (advanced) or `/sms/test-message.php` (basic) ``` Hello This is a test! Thanks! ``` ### Without a view file [](#without-a-view-file) When sending a large amount of text messages quickly, you may want to skip the view file for performance reasons, or you just may find it overkill for your usage. ``` $name = "Wade"; Yii::$app->sms->compose() //->setFrom('12345') // optional if set in main config ->setTo('+15558881234') ->setMessage("Hey {$name} this is a test!") ->send(); ``` `setMessage()` is a nicename function, or alias, for `setTextBody()`. Since SMS messages only deal with text and not html, I felt this was cleaner. However, `setTextBody()` will work just the same if your familiar with the way the mailer handles things. Either is fine. Determining a successful send ----------------------------- [](#determining-a-successful-send) A boolean is returned, so it is simple: ``` $result = Yii::$app->sms->compose() ->setTo('+15558881234') ->setMessage("Hey {$name} this is a test!") ->send(); if ( $result === true ) { echo 'SMS was sent!'; } else { 'Error sending SMS!'; } ``` How do I send an image? ----------------------- [](#how-do-i-send-an-image) After your `compose()` call, use `->setMediaUrl($urlToImage)` Do I have to call `setFrom()`? ------------------------------ [](#do-i-have-to-call-setfrom) You only have to use `setFrom()` if you did not specify a `from` number in the configuration, within the `messageConfig` array. If you want to override the `from` address in your main configuration, then you can call `setFrom()` specifically. If you only send from 1 number, just configure it and don't call it directly so you don't have to change it in a bunch of places later. *Tip: If you have multuple numbers, use the Yii2 params array for an all-in-one easy spot to modify the numbers later.* Where can I find error logs? ---------------------------- [](#where-can-i-find-error-logs) When an Exception is hit during sending, they will be recorded under `@runtime/sms` and named according to the type of exception. TODO: ----- [](#todo) - Update README - Update documentation/commenting - Create Twilio logger component - Add support for more Twilio features (messagingServiceSid, channel address, etc) Donate ------ [](#donate) Please consider donating if you find my code useful. [![PayPal Donate](https://camo.githubusercontent.com/e2443d71f23a4aa00e51d77345089027a415fb75b081b593b54e4605fa529b01/68747470733a2f2f692e6962622e636f2f59634d35356d742f70617970616c646f6e6174652e706e67 "Donate")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BEAUQFRMDPHT8&source=url) ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community7 Small or concentrated contributor base Maturity53 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 Every ~0 days Total 2 Last Release 1374d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/be3f1bbb04fa9a313b1cdb91a436d42172d250f7bda806192d3fa904429f69b0?d=identicon)[kamran377](/maintainers/kamran377) --- Top Contributors [![kamran377](https://avatars.githubusercontent.com/u/7840072?v=4)](https://github.com/kamran377 "kamran377 (4 commits)") --- Tags smstwilioyii2text messageyii2 smsyii2 twilio ### Embed Badge ![Health badge](/badges/kamran377-yii2-sms-twilio/health.svg) ``` [![Health](https://phpackages.com/badges/kamran377-yii2-sms-twilio/health.svg)](https://phpackages.com/packages/kamran377-yii2-sms-twilio) ``` ### Alternatives [laravel-notification-channels/twilio Provides Twilio notification channel for Laravel 2587.7M12](/packages/laravel-notification-channels-twilio)[tuyakhov/yii2-notifications The extension provides support for sending notifications across a variety of delivery channels, including mail, SMS, Slack etc. Notifications may also be stored in a database so they may be displayed in your web interface. 6735.5k2](/packages/tuyakhov-yii2-notifications) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)