README

Türkçe

Laravel CODEC FAST SMS

This package provides easy and painless integration of Codec Messaging Platform API into your Laravel projects.

Requirements

Laravel >= 5.3
PHP >= 5.6.4

Installation

To get started, you should add the hayrican/laravel-codec-fastsms Composer dependency to your project:

composer require hayrican/laravel-codec-fastsms

Service Provider (Laravel Older 5.5)

If you are using later version of Laravel 5.5, you can skip this step.

Register provider on your config/app.php file.

'providers' => [
    ...,
    HayriCan\CodecFastSms\CodecFastSmsServiceProvider::class,
]

Configuration

You should publish vendor for configuration file which has API Credentials and other configs.

$ php artisan vendor:publish --provider="HayriCan\CodecFastSms\CodecFastSmsServiceProvider"

Codec Credentials

Navigate to config/codecfastsms.php and enter your Codec API credentials in this file.

[
  'username'=> "CODEC_USERNAME",
  'password'=> "CODEC_PASSWORD",
  'sender'=> "CODEC_SENDER",
]

Route Configuration

Default router prefix is api and middleware is api. In this section you can change prefix and middleware.

[
  'route_prefix'=> 'api',

  'middleware'=> ['api'],
]

Save SMS Requests

Default value of record comes false and it means you sms requests are not going to save on database. If you want to save you requests on database, you can make this field true as shown below

[
  'record'=> true
]

After changed the record value to true on config/codecfastsms.php file, you should migrate the migration.

$ php artisan migrate

And sms_records_table will appear on your database.

Package Usage

1.HTTP Request

You can send sms via a POST request to /codec-fastsms

Eg.1. Send a message to a number

Eg.2. Send a message to multiple numbers

Eg.3. Send multiple messages to multiple numbers

Post Required Parameters:

Key	Value	Description
phone	5XXXXXXXXX	Phone number(s) to send multiple numbers you should put ~ between numbers. eg. 5XXXXXXXXX~5YYYYYYYYY
messageContent	Message Text	Message content(s) if you want to send different messages to different numbers you should put ~ between message contents. eg. MessageContent1~MessageContent2. NOTE: If you use this property, you should have equal number of phone and messageContent

Post Optional Parameters:

Key	Value	Description
msgSpecialId	Message_Title	This field use for searching on the Codec system records
headerCode	Header_Code	You can use this field for tracking messages from Codec Customer Service
optionalParameters	OPTIONAL_PARAM	Optional parameters

2.Artisan Console

Eg.1. Send a message to a number

$ php artisan fastsms:send --phone='5XXXXXXXXX' --messageContent='Message Text'

Eg.2. Send a message to multiple numbers

$ php artisan fastsms:send --phone='5XXXXXXXXX~5YYYYYYYYY~5ZZZZZZZZZ' --messageContent='Message Text'

Eg.3. Send multiple messages to multiple numbers

$ php artisan fastsms:send --phone='5XXXXXXXXX~5YYYYYYYYY~5ZZZZZZZZZ' --messageContent='Message Text~Message Text2~Message Text3'

Command Required Parameters:

Key	Value	Description
--phone	5XXXXXXXXX	Phone number(s) to send multiple numbers you should put ~ between numbers. eg. 5XXXXXXXXX~5YYYYYYYYY
--messageContent	Message Text	Message content(s) if you want to send different messages to different numbers you should put ~ between message contents. eg. MessageContent1~MessageContent2. NOTE: If you use this property, you should have equal number of phone and messageContent

Command Optional Parameters:

Key	Value	Description
--msgSpecialId	Message_Title	This field use for searching on the Codec system records
--headerCode	Header_Code	You can use this field for tracking messages from Codec Customer Service
--optionalParameters	OPTIONAL_PARAM	Optional parameters

Author

Hayri Can BARÇIN
Email: Contact Me

License

This project is licensed under the MIT License - see the License File for details