README

Kavenegar RESTful API 文档

如果您需要关于 API 文档的更多信息，请访问 RESTful 文档

安装

首先，您需要在此处在 Kavenegar 上创建一个账户

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

使用以下方式

composer require masihjay-z/kavenegar

或添加

"kavenegar/php": "*"

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

$ composer update

使用方法

好吧，有一个用 PHP 发送短信的示例。

require __DIR__ . '/vendor/autoload.php';

try{
	$api = new \Kavenegar\KavenegarApi( "API Key" );
	$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
        }
    ]
}
*/

您还可以使用 KavengarChannel 进行您的通知

创建您的通知： php artisan make:notification InvoicePaid

从 KavenegarBaseNotification 扩展您的通知

class InvoicePaid extends KavenegarBaseNotification
{

}

重写 toKavenegar 函数

class InvoicePaid extends KavenegarBaseNotification
{

   public function __construct(Invoice $invoice)
   {
       $this->invoice = $invoice;
   }

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage("فاکتور شما به شماره $invoice->id پرداخت شد."))->from('10004346');
    }
}

您应该在您的模型中添加 Notifiable 特性和 routeNotificationForKavenegar 方法

class User extends Authenticatable
{
    use Notifiable;
    
    public function routeNotificationForKavenegar($driver, $notification = null)
    {
        return $this->mobile;
    }

}

注意：如果您在可通知模型中没有添加 routeNotificationForKavenegar，那么您应该在您的通知中设置您的接收者

class InvoicePaid extends KavenegarBaseNotification
{

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage('فاکتور شما به شماره ۱۲۳۴ پرداخت شد.'))->from('10004346')->to('092100000');
    }
}

为了发送验证查找消息，您应该使用 verifyLookup 方法来设置方法名称和令牌

class InvoicePaid extends KavenegarBaseNotification
{

    public function toKavenegar($notifiable)
    {
        return (new KavenegarMessage())
            ->verifyLookup('verify_first',['token1','token2']);
    }
}

贡献

欢迎提交错误修复、文档和改进！请通过 support@kavenegar.com 联系我们

指南

介绍 Kavenegar 服务

کاوه نگار یک وب سرویس ارسال و دریافت پیامک و تماس صوتی است که به راحتی میتوانید از آن استفاده نمایید.

ساخت حساب کاربری

اگر در وب سرویس کاوه نگار عضو نیستید میتوانید از لینک عضویت ثبت نام و اکانت آزمایشی برای تست API دریافت نمایید.

مستندات

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

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

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

اطالعات بیشتر

更多详情，请访问Kavenegar短信服务介绍页面。

如果您在使用Kavenegar服务套件时遇到问题或有建议，请通过Pull Request或发送邮件至support@kavenegar.com与我们联系。

http://kavenegar.com

masihjay-z / kavenegar

维护者

详细信息