kavenegar/yii2

yii2 kavenegar integration

kavenegar-yii2

Kavenegar RESTful API Document

If you need to future information about API document Please visit RESTful Document, _(*1)

Installation

First of all, You need to make an account on Kavenegar from Here , _(*2)

After that you just need to pick API-KEY up from My Account section. , _(*3)

Install it these ways :, _(*4)

composer require kavenegar/yii2

or add, _(*5)

"kavenegar/yii2": "*"

And run following command to download extension using composer:, _(*6)

$ composer update

Configuration

Add the following in your config:, _(*7)

return [
    'components' => [
        'Kavenegar' => [
            'class' => 'Kavenegar\Yii2\Kavenegar',
            'apikey' => '',
        ],
    ],
];

Usage Well, There is an example to Send SMS by yii2 below., _(*8)

try{
    $api = Yii::$app->Kavenegar->KavenegarApi();
    $sender = "10004346";
    $message = "خدمات پیام کوتاه کاوه نگار";
    $receptor = array("09123456789","09367891011");
    $result = $api->Send($sender,$receptor,$message);
    if($result){
        foreach($result as $r){
            echo "messageid = $r->messageid";
            echo "message = $r->message";
            echo "status = $r->status";
            echo "statustext = $r->statustext";
            echo "sender = $r->sender";
            echo "receptor = $r->receptor";
            echo "date = $r->date";
            echo "cost = $r->cost";
        }       
    }
}
catch(\Kavenegar\Exceptions\ApiException $e){
    // در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
    // در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
    echo $e->errorMessage();
}

/*
sample output
{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid":8792343,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09123456789",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":8792344,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09367891011",
            "date":1356619709,
            "cost":120
        }
    ]
}
*/

Contribution

Bug fixes, docs, and enhancements welcome! Please let us know support@kavenegar.com, _(*9)

, _(*15)