kavenegar/yii2

yii2 kavenegar integration

v1.0.1 2016-10-22 18:19 UTC

Requires

• kavenegar/php: *

MIT

• Kavenegar API Team

• api
• sms
• extension
• yii2
• kavenegar

README

Kavenegar RESTful API Document

If you need to future information about API document Please visit RESTful Document

Installation

First of all, You need to make an account on Kavenegar from Here

After that you just need to pick API-KEY up from My Account section.

Install it these ways :

composer require kavenegar/yii2

or add

"kavenegar/yii2": "*"

And run following command to download extension using composer:

$ composer update

Configuration

Add the following in your config:

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

Usage Well, There is an example to Send SMS by yii2 below.

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 [e-mail]

راهنمای فارسی

راهنما

در صورتی که مایل هستید راهنمای فارسی کیت توسعه کاوه نگار را مطالعه کنید به صفحه کد ارسال پیامک مراجعه کنید.

مستندات

برای مطالعه مستندات کار با وب سرویس اس ام اس کاوه نگار به صفحه مستنداتمراجعه کنید

معرفی وب سرویس کاوه نگار

برای مشاهده ویژگی های وب سرویس پیامک کاوه نگار به صفحه وب سرویسمراجعه نمائید.

ایجاد حساب کاربری

و بالاخره اگر در استفاده از سرویس کاوه نگار مشکلی داشتید یا پیشنهاد همکاری بود لطفا حتما به ما اطلاع دهید.

[e-mail]