hmoradian/fhsms

A simple API extension for send text message By FHCo Sms

dev-master 2023-04-29 11:21 UTC

This package is auto-updated.

Last update: 2024-04-29 13:34:10 UTC


README

FhSms API for send text messages v0.1.1

اين پکيج امکان اتصال FhSms API به فريم ورک هايي که جهت نصب پکيج ها از composer و از استاندارد PSR-4 جهت autoload نمودن کلاس ها استفاده مي نمايند همانند (Laravel,Yii,symfony) را فراهم مي سازد.
جهت کسب اطلاعات بيشتر و مشاوره با شماره تلفن همراه 09132101417 (حسين مراديان) تماس بگيريد. منتظر پيشنهادات سازنده شما هستيم.

محتوا

نصب و پيکره بندي

با استفاده از composer قادر به نصب اين سرويس مي باشيد:

composer require hmoradian/fhsms

نحوه استفاده

مطابق کد زير تنظيمات شناسه، رمزعبور و شماره تماس ارسال کننده را وارد نمائيد:

$user_name = '*******';
$password = '*******';
$phone_number = '*******';;
$sms = new \Hmoradian\FhSms\Sms($user_name, $password, $phone_number);

متدها

1- متد ارسال پيامک (يک پيام به چند شماره)

sendSms($reciver_numbers, $text_message)

مثال :
echo $sms->sendSms('0936*******','Test Message');
...
echo $sms->sendSms(['0936*******', '091********'],'Test Message');

2- متد ارسال پيامک (چند پيام به چند شماره)

sendSms2(array $reciver_numbers, array $text_messages)

مثال :
echo $sms->sendSms2(['0936*******', '091********'],['Test Message 1', 'Test Message 2']);

3- متد دريافت اطلاعات حساب

getData()

مثال :
echo $sms->getData();

4- متد دريافت وضعيت پيام ارسالي

getStatus($unique_id)

مثال :
echo $sms->getStatus('536221499');

5- متد پيام هاي دريافت شده

getMessages()

مثال :
echo $sms->getMessages();

Laravel

پيکره بندي در لاراول

بعد از نصب پکيج ، فايل env. را مطابق زير ويرايش نموده و کليدهاي زير را در آن با مقادير مربوط به حساب کاربري خود در سامانه پيامک ما وارد نماييد (مقدار کليد سوم شماره تلفن فرستنده است):
// .env
...
FHSMS_BASE_URL=*******
FHSMS_USERNAME=*******
FHSMS_PASSWORD=*******
FHSMS_PHONE_NUMBER=*******
...
البته مي توانيد فايل پيکربندي موجود در پکيج را هم ويرايش و يا در فولدر پيکربندي پروژه پابليش کرده و مقادير را مستقيما و بدون ورود در فايل env. جايگزين نماييد
// config/fhsms.php
...
    'services' => [
        'base_url' => env('FHSMS_BASE_URL'),
        'user_name' => env('FHSMS_USERNAME'),
        'password' => env('FHSMS_PASSWORD'),
        'phone_number' => env('FHSMS_PHONE_NUMBER'),
    ],
...
چنانچه از نسخه هاي پايين تر از 5.5 استفاده مي نمائيد providers و aliases زير را به فايل config/app.php اضافه نمائيد:
// config/app.php
...
'providers':
Hmoradian\FhSms\FhSmsServiceProvider::class,
...
'aliases':
'FhSms' => Hmoradian\FhSms\Facades\FhSms::class,
...

نحوه استفاده در لاراول

هم اکنون مي توانيد با استفاده از Facade اين پکيج (FhSms) به متدهاي پکيج دسترسي داشته باشيد :
echo  FhSms::sendSms('0936*******','Test Message');
   ...   
   
echo  FhSms::sendSms2(['0936*******'],['Welcome ...']);
   ...
   
$result = FhSms::getStatus('536221499');
if($result['result']['statusId'] === 4){
   ///
}else{
  ///
}
   ...   
   
echo  FhSms::getData();
   ...

استفاده در سيستم اعلانات لاراول

توليدکننده

لايسنس

لايسنس اين پکيج (MIT) مي باشد . جهت اطلاعات در مورد اين لايسنس به License File مراجعه نماييد.