README

Kavenegar RESTful API 文档

如需获取 API 文档的更多信息，请访问 RESTful 文档

安装

首先，您需要在 Kavenegar 上创建一个账户，请从 此处 进行注册

之后，您只需从 我的账户 部分获取 API-KEY。

按照以下方式安装：

composer require kavenegar/yii2

或者添加：

"kavenegar/yii2": "*"

然后运行以下命令使用 composer 下载扩展：

$ composer update

配置

在您的配置文件中添加以下内容

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

用法 以下是一个使用 yii2 发送短信的示例。

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
        }
    ]
}
*/

对 SDK 的贡献，包括错误修复、文档和增强功能都受欢迎！请通过以下邮箱告诉我们： support@kavenegar.com

波斯语指南

指南

如果您想阅读 Kavenegar 开发套件的波斯语指南，请访问 发送短信代码 页面。

文档

要阅读 Kavenegar SMS Web 服务的工作文档，请访问 文档 页面。

Kavenegar Web 服务介绍

要查看 Kavenegar SMS Web 服务的功能，请访问 Web 服务页面。

创建账户

最后，如果您在使用 Kavenegar 服务时遇到问题或想提出合作建议，请务必告知我们。

support@kavenegar.com