README

پکیح لاراول ارتباط با سیموتل

ارتباط با Simotel بوسیله لاراول

• نصب
• سازگاری با سیموتل
• Simotel Api
• Simotel Event Api
• Smart Api

نصب

با استفاده از کامپوزر و لاراول 6 به بعد این پکیج را با فرمان زیر نصب کنید:

composer require hsyir/simotel-laravel-connect

سپس به وسیله اجرای فرمان زیر فایل کانفیگ ساخته خواهد شد:

php artisan vendor:publish --provider=Hsyir\\SimotelConnect\\SimotelApiServiceProvider

سازگاری با سیموتل

Simotel Api

Simotel Api یکی از قابلیت های قدرتمند نرم افزار سیموتل است، بوسیله این Api میتوان برخی اعمال تعریف شده روی سیموتل را از راه دور و بوسیله فریمورک قدرتمند لاراول انجام داد.

اتصال به سیموتل

برای تعریف آدرس سرور سیموتل و اطلاعات ورود در فایل کانفیگ simotel.php مقادیر زیر را تغییر دهید:

"simotelApi" => [
        "apiUrl" => env("SIMOTEL_API_SERVER", "http://127.0.0.1/api/v1/"),
        "user" => env("SIMOTEL_API_USER", "user"),
        "pass" => env("SIMOTEL_API_PASS", "pass"),
    ],

نحوه استفاده

$simotelApi = new \Hsy\SimotelConnect\SimotelApi();
$result = $simotelApi->pauseInQueue($queue, $agent);

if(!$result)
    $errorMessage = $simotelApi->getMessage(); 

متد ها

boolean addToQueue($queue, $source, $agent, $penalty = 0)
boolean removeFromQueue($queue, $agent)
boolean pauseInQueue($queue, $agent)
boolean resumeInQueue($queue, $agent)

Simotel Event Api

Simotel Event Api (SEA) سرویس انتشار رویداد های سیموتل است. این پکیج امکان استفاده از این سرویس را بوسیله قابلیت های Events و Listeners در لاراول امکان پذیر می کند. برای استفاده از Event های موجود در SEA می توانید از کلاس های زیر در EventServiceProvider لاراول استفاده کنید.

"Cdr" => \Hsy\SimotelConnect\Events\SimotelEventCdr::class,  
"NewState" => \Hsy\SimotelConnect\Events\SimotelEventNewState::class,  
"ExtenAdded" => \Hsy\SimotelConnect\Events\SimotelEventExtenAdded::class,  
"ExtenRemoved" => \Hsy\SimotelConnect\Events\SimotelEventExtenRemoved::class,  
"IncomingCall" => \Hsy\SimotelConnect\Events\SimotelEventIncomingCall::class,  
"OutGoingCall" => \Hsy\SimotelConnect\Events\SimotelEventOutgoingCall::class,  
"Transfer" => \Hsy\SimotelConnect\Events\SimotelEventTransfer::class,

نمونه Listener :

namespace App\Listeners;  
  
class UpdateCallCdrData  
{        
   /**  
    * Handle the event. 
    * 
    * @param object $event  
    * @return void  
    */    	     
    public function handle($event)  
    {
      $cdrData = $event->apiData;  
      
      // 
      
    }
       
 }

پراپرتی apiData حاوی اطلاعات ارسالی از سیموتل است که به Listener ارسال می شود.

نمونه Controller :

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use Hsy\SimotelConnect\SimotelEventApi;
use Illuminate\Http\Request;

class SeaController extends Controller
{
    public function dispatchEvent(Request $request)
    {
        $simotelEventApi = new  SimotelEventApi;
        $simotelEventApi->dispatchSimotelEvent($request->all());
    }
}

Smart Api

برای استفاده از این قابلیت ویژه نرم افزار سیموتل در فریمورک لاراول ابتدا باید یک کلاس به صورت زیر ایجاد کنید. برای استفاده از دستورات آماده پکیج از Trait با نام SmartApiCommands باید استفاده نمایید.

namespace App\Classes;  
         
use Hsy\SimotelConnect\SmartApiCommands;  
  
class SmartApiMethodsRepo  
{  
    use SmartApiCommands;  
  
    // نام متد باید مساوی با نام کامپوننت SmartApi در نقشه تماس سیموتل باشد.
    public function select_queue($apiData)  
    {  
        
        $this->cmdGetData("SelectQueue", 4, 2);  
        $this->cmdExit("1");  
            
        if(true)
            return $this->okResponse();  
        //else
            return $this->errorResponse();
    }
    
 }

متدهای قابل استفاده :

cmdPlayAnnouncement($file)  
cmdPlayback($file)  
cmdExit($exit)  
cmdGetData($file,$timeout,$digitsCount)  
cmdSayDigit($number)  
cmdSayNumber($number)  
cmdSayClock($clock)  
cmdSayDate($date,$calender)  
cmdSayDuration($duration)  
cmdSetExten($exten)  
cmdSetLimitOnCall($seconds)  

جهت معرفی کلاس ایجاد شده در فایل کانفیگ simotel.php مقدار زیر را تنظیم کنید.

 "smartApi" => [  
      "methodsRepositoryClass" => \App\Classes\SmartApiMethodsRepo::class,  
    ],

نمونه Controller :

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use Hsy\SimotelConnect\SmartApi;
use Illuminate\Http\Request;

class SmartApiController extends Controller
{
    public function call(Request $request)
    {
        $smartApi = new SmartApi;
        $response = $smartApi->callApi($request->all());
        return response()->json($response);
    }
}

License