README

سلام به روی ماهتون. این یه پکیج لاراوله برای ارسال پیامک از طریق سامانه پیام کوتاه قاصدک.

نصب

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

composer require fibdesign/sms

برای اینکه بتونید تنظیمات شخصی خودتون رو انجام بدین، فایل کانفیگ پکیج رو بیایم انتقال بدیم به پوشه کانفیگ پروژه

php artisan vendor:publish

بعد از وارد کردن این کامند، پروایدر زیر رو انتخاب کنید:

 - Fibdesign\Sms\Providers\SmsProvider

یادتون نره که مقادیر رو توی env هم بزارید

SMS_API_KEY=apikey
SMS_SENDER=تلفن ارسال کننده در سامانه

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

METHOD	SYNTAX	REQURIED	DESCRIPTION	EXAMPLE
to()	`array` of strings	بلی	لیستی از تلفن های همراه که میخوای بهشون پیام بدی	$smsService->to(["0915348484"])
testers()	`array` of strings	خیر	لیستی از تلفن های اضافه. برای مثال وقتی میخوای تلفن خودت توی همه پیام ها باشه، میتونی شماره خودت رو اینجا اضافه کنی.	$smsService->testers(["0915348484"])
template()	`string`	خیر	مقداری که از قبل توی داشبورد توی سامانه تعریف کردی	$smsService->template('phoneVerification')
as()	`string`	خیر	مقادیر قابل قبول: `single`, `group`, `credit`, `receive` و `template`. مقدار پیشفرض: `single`.	$smsService->as('single')
message()	`string`	بلی	متن پیام.	$smsService->message("Hi from Ghasedak")
dispatch()	void	بلی	برای اینکه عمل ارسال انجام بشه، این رو حتما در آخر فراخوانی کنید	$smsService->dispatch()

ارسال پیام تکی

$smsService->to(["0915221484"])
    ->message("تست پیام")
    ->dispatch();

ارسال پیام گروهی

$smsService->to(["0915221484","0915221484"])
    ->message("تست پیام")
    ->as("group")
    ->dispatch();

ارسال پیام با استفاده از قالب

$smsService->to(["0915221484","0915221484"])
    ->message("تست پیام")
    ->template("phoneVerification")
    ->as("template")
    ->dispatch();

دریافت مقدار باقی مانده کیف پول

$smsService
    ->as("credit")
    ->dispatch();

توی پیام هاتون حتما کلمه لغو 11 رو قرار بدید وگرنه به مشکل میخورید!