README

This is unofficial component for use "Mobizon" API (https://mobizon.net.ua). It allows send single messages and check account balance.

INSTALLATION

Run command

    composer require black-lamp/blcms-sms-mobizone

or add

    "black-lamp/blcms-sms-mobizone": "*",

Configure component in your app

Example:

    'components' => [
        'sms' => [
                    'class' => bl\cms\sms\SmsMobizoneComponent::className(),
        
                    'apiToken' => '00000000000000000000000000000000000000000',
                    'recipientPhoneNumber' => '380965550000',
                    'smsText' => 'Default message',
                    'alphaName' => 'Name'
            ],
        ]

For get API token you must register account at https://mobizon.net.ua. After this turn on API access on "API settings" panel section (https://mobizon.net.ua/panel) and get your token.

Recipien phone number must be in international format without plus. Example: "380965550000".

Alpha name is your signature in SMS that will be used instead sender phone number. For use this property you must create alpha-name in your account (https://mobizon.net.ua/panel) on "My signatures" panel section. This property can be empty.

USING

For sending one SMS:

    $messageId = Yii::$app->sms->setSmsText('Some text')->send();

Also you ca use this set methods:

Yii::$app->sms->setApiToken(string $token);
Yii::$app->sms->setRecipientPhoneNumber(string $recipientPhoneNumber);
Yii::$app->sms->setSmsText(string $smsText);
Yii::$app->sms->setAlphaName(string $alphaName);

For get user account balance:

    $balance = Yii::$app->sms->getBalance();