mocean/yii-mocean

Mocean API for Yii Framework

v2.0.0 2019-06-25 03:55 UTC

This package is auto-updated.

Last update: 2020-08-03 05:54:56 UTC


README

Latest Stable Version Build Status StyleCI License Total Downloads

Yii Mocean API Integration

Installation

To install the library, run this command in terminal:

composer require mocean/yii-mocean

Set configuration in config file

'components' => [
    'mocean' => [
        'class' => 'YiiMocean\MoceanServiceProvider',
        'defaults' => 'main',
        'accounts' => [ //define your account here
            'main' => [
                'api_key' => 'mainAccountApiKey',
                'api_secret' => 'mainAccountApiSecret'
            ],
            'secondary' => [ //if you have more then one account
                'api_key' => 'secondaryAccountApiKey',
                'api_secret' => 'secondaryAccountApiSecret'
            ]
        ],
    ],
]

Usage

Send a text message

//will be using the account defined in defaults
//see below if you have multiple accounts
Yii::$app->mocean->message()->send([
    'mocean-to' => '60123456789',
    'mocean-from' => 'MOCEAN',
    'mocean-text' => 'Hello World'
])

If you have multiple account defined in config

Yii::$app->mocean->using('secondary')->message()->send(...);
Yii::$app->mocean->using('third')->message()->send(...);

License

Laravel Mocean is licensed under the MIT License