kavenegar-laravel

Kavenegar RESTful API Document

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

Requirements

Laravel 4 or 5.

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 this way :

composer require kavenegar/laravel

Laravel 5 and 6

Add the Kavenegar\Laravel\ServiceProvider provider to the providers array in config/app.php:

'providers' => [
  ...
  Kavenegar\Laravel\ServiceProvider::class,
],

Then add the facade to your aliases array:

'aliases' => [
  ...
  'Kavenegar' => Kavenegar\Laravel\Facade::class,
],

Finally, publish the config file with php artisan vendor:publish   Or alternatively for laravel 5 you can do: php artisan vendor:publish --provider="Kavenegar\Laravel\ServiceProviderLaravel5".   And for laravel 6: php artisan vendor:publish --provider="Kavenegar\Laravel\ServiceProviderLaravel6".
  And you'll find it at config/kavenegar.php.

Laravel 4

Add the Kavenegar\Laravel\ServiceProvider provider to the providers array in app/config.php:

'providers' => [
  ...
  'Kavenegar\Laravel\ServiceProvider',
],

Then add the facade to your aliases array:

'aliases' => [
  ...
  'Kavenegar' => 'Kavenegar\Laravel\Facade',
],

Finally, publish the config file with php artisan config:publish kavenegar/laravel. You'll find the config file at app/config/packages/kavenegar/laravel/config.php.

Usage

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

try{
    $sender = "10004346";
    $message = "خدمات پیام کوتاه کاوه نگار";
    $receptor = array("09123456789","09367891011");
    $result = Kavenegar::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(ApiException $e){
    // در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
    echo $e->errorMessage();
}
catch(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 [email protected]