2amigos/yii2-twilio-component

A Yii2 Application Component to ease the use of twilio SDK

Installs: 10 728

Dependents: 0

Suggesters: 0

Stars: 4

Watchers: 2

Forks: 0

Open Issues: 2

Type:yii2-extension

1.0.0 2017-10-27 16:16 UTC

README

Latest Version Software License Total Downloads

Twilio is an awesome service that allows to include programmable SMS, Voice, Video, and Chat services in your apps. For Server side only Voice and SMS services are available.

This component is a simple wrapper to ease Yii2 framework developers the job to send SMS and start Voice calls with Twilio.

Install

Via Composer

$ composer require 2amigos/yii2-twilio-component

Usage

Sign up for a Twilio Account

To use the Twilio REST API, you need an account. Signing up for a free Twilio account is easy. Once you've signed up, head over to your Console and grab your Account SID and your Auth Token.

Purchase an SMS Capable Phone Number

Sending SMS messages requires an SMS capable phone number. You can browse the available phone numbers in the Console. Be sure that the phone number you buy is SMS capable. When you search, you can check the box to filter available numbers to those that are SMS capable.

Once you have the Twilio phone number you are ready to configure your application component.

Configuring the Component

You have to take the Account SID, the Auth Token and the purchased phone number and configure the component:

// On your application config file 
// ... 
'components' => [
    'twilio' => [
        'class' => '\dosamigos\twilio\TwilioComponent',
        'sid' => 'ACCOUNT_SID',
        'token' => 'AUTH_TOKEN',
        'phoneNumber' => 'PURCHASED_PHONE_NUMBER'
    ]
]

Sending an SMS

Now that the application component has been set, you can do the following to send SMS:


$message = Yii::$app->twilio->sms('VALID_PHONE_NUMBER_TO_SEND_SMS', 'Hello World!');

// It returns a \Twilio\Rest\Api\V2010\Account\MessageInstance
echo $message->sid;

In case you wish to use another purchased phone number, you can override the one configured as follows:


$message = Yii::$app->twilio->sms('VALID_PHONE_NUMBER_TO_SEND_SMS', 'Hello World!', [
 'from' => 'ANOTHER_PURCHASED_TWILIO_PHONE_NUMBER'
]);

// It returns a \Twilio\Rest\Api\V2010\Account\MessageInstance
echo $message->sid;

Using code fixer

We have added a PHP code fixer to standardize our code. It includes Symfony, PSR2 and some contributors rules.

./vendor/bin/php-cs-fixer fix ./src --config .php_cs

Why there are no tests?

The component is too simple to include tests as its a wrapper to Twilio's client library and the library has already all the required tests to check the functionality.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The BSD License (BSD). Please see License File for more information.

687474703a2f2f7777772e67726176617461722e636f6d2f6176617461722f35353336333339346437323934356666376564333132353536656330343165302e706e67
Custom Software | Web & Mobile Development
www.2amigos.us