timur560/yii2-twilio

Twilio extension for Yii2 framework

1.0 2018-03-14 16:39 UTC

Requires

• twilio/sdk: ^5.16
• yiisoft/yii2: ~2.0.0

MIT

• Reinvently

• sms
• twilio
• call
• yii2

README

Installation

Via composer:

$ composer require reinvently/yii2-twilio

Configure

Add the following config to the components section to the config/web.php, config/console.php, etc.:

...
    'twilio' => [
        'class' => 'Reinvently\Twilio\Twilio',
        'number' => 'XXXXXXXX', // phone number
        'retries' => 5, // call retries in fail cases
        'account' => [
            'sid' => 'ACXXXXXXXXXXXXXXXXXXXXXX',
            'token' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
        ],
        'twiMLApp' => [
            'sid' => 'APXXXXXXXXXXXXXXXXXXXXXX',
        ],
        'apiKey' => [
            'sid' => 'SKXXXXXXXXXXXXXXXXXXXXXX',
            'secret' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
        ],
        'configurationProfile' => [
            'sid' => 'VSXXXXXXXXXXXXXXXXXXXXXX',
        ],
    ],
...
]

Replace the necessary fields with your own twilio account data, which you can find in twilio control panel

Methods Reference (TODO)

generateCapabilityToken

generateVoiceAuthToken()

generateVideoAuthToken

generateChatAuthToken

sendSms

call

Usage

Sample useage in REST API controller:

namespace app\controllers;

use yii\rest\ActiveController;

class ApiController extends ActiveController
{
    public $modelClass = '';

    public function actionGetVoiceAuthToken() {
        return \Yii::$app->twilio->generateVoiceAuthToken();
    }
}