README

This is a official sms.ir laravel package

Installation

You can install the package via composer:

composer require cryptommer/smsir

publish provider (if you don't use laravel skip this)

php artisan vendor:publish --provider="Cryptommer\Smsir\SmsirServiceProvider"

Add this to env file (if you don't use laravel skip this)

SMSIR_API_KEY=
SMSIR_LINE_NUMBER=

Usage

add this line to the beginning of any class that you want to use smsir functions

For Laravel

use Cryptommer\Smsir\Smsir;

Notification

add this function to your model

public function routeNotificationForSmsir() {
    return $this->phone_number
}

modify these lines in notification class

public function via() {
    return [\Cryptommer\Smsir\Notifications\SmsirChannel::class] //  or 'smsir'
}

add this function to notification class

public function toSmsir(object $notifiable) {
    /**
    * template_id string 
    * parameters array of key and value that key equal to the key in template id
    */
    return new \Cryptommer\Smsir\Notifications\SmsirMessage()
        ->template_id($template_id)
        ->parameters($parameters)
}

Pure PHP

require __DIR__ . '/vendor/autoload.php';
use Cryptommer\Smsir\Classes\Smsir;

$smsir = new Smsir($line_number, $api_key)

Sending Message

Sending messages to mobile numbers

Document

Report Messages

Get report of sent messages and received messages

Document

Setting

Get account credit and line numbers

Document

Responses

Response Models

Document

View Routes (for laravel users)

Sending sms

http://localhost:8000/smsir/send/bulk

Get Report of today sent sms

http://localhost:8000/smsir/report/sent/today

Get Report of today received sms

http://localhost:8000/smsir/report/sent/today

Translations

Delivery Status

__(`smsir.DeliveryStatus.$delivery_status`);

Request Status

__(`smsir.SendStatus.$status`);

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• به سفارش شرکت ایده پردازان
• Pouya Biglari

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.