zymawy/sms2net

This Simple Package 📦 Can Help You Interacting With Net2SMS API

0.65 2018-12-25 14:53 UTC

Requires

• php: >=7.1
• guzzlehttp/guzzle: ^6.3
• laravel/framework: 5.*

MIT

• hamza zymawy

• sms
• laravel
• sms2net
• Deewan Alrasaile

README

| This Simple Package 📦 Can Help You Interacting With Net2SMS API. | So You Can Send Check Balance, Get All Messages You Saved. And Many More.

Installtions

You Need To Require The Package In Order It To Work.

λ composer require zymawy/sms2net

Then Register The Service Provider To config/app.php Inside providers array

'providers' => [
/*
* Package Service Providers...
*/
Zymawy\Sms2Net\Sms2NetServiceProvider::class,
..Rest of Services
]

In The Same File Place The Facade Inside alias array.

/*
 Class Aliases
*/
'aliases' => [
'Sms2Net' => \Zymawy\Sms2Net\Facades\Sms2NetFacade::class,
..Rest of Services
]

Update You Your .env

SMS2NET_USERNAME=
SMS2NET_PASSWORD=
SMS2NET_UNICODE=
SMS2NET_SENDER=
SMS2NET_IS_TEST=

Finally, You Need To Publish The Config File And The Lang File. So You Can Provide The Account Credentials.

λ php artisan vendor:publish --provider="Zymawy\Sms2Net\Sms2NetServiceProvider"

Available Functions

sendToMany();

This Function Just If You Want To Send A Heavy array of numbers since it take time to process. Use sendToOne Instead For Preference.

|| it take to arguments $numbers And $message

$msg =  'In The Name Of Allah The Merciful';
$numbers = [
    '009665900000000',
    '0540000000',
    '[phone]'
];
    
$response = Sms2Net::sendToMany($numbers,$msg);

On Success

{
    "msg": "تم بنجاح ارسال الرسالة",
    "code": "Ok 000",
    "count_delivered_msg": "99",
    "full_massage": "Ok 000, Message Has Been Sent, [99] ID:9999"
}

On Errors ERR: Error number

sendToOne();

This Function Just If You Want To Send A A Major Array Of Numbers. Use sendToOne Instead For heavy Array Of Numbers.

|| it take to arguments $numbers And $message

$msg =  'In The Name Of Allah Most Merciful';
$user = App\User::first();
$response = Sms2Net::sendToMany($user->phone_number,$msg);

On Success

{
   "msg": "تم بنجاح ارسال الرسالة",
   "code": "Ok 000",
   "count_delivered_msg": "99",
   "full_massage": "Ok 000, Message Has Been Sent, [99] ID:9999"
}

On Errors

ERR: Error number

geBalance()

This will return the number of credits available on this particular account. The account balance is returned as a floating point value.

$balance = Sms2Net::geBalance();
return $balance;

On Success

{
  "msg": "النقاط المتوفرة ",
  "full_massage": "Credit = 232340",
  "points": "232340"
}

getMessages()

This will return a list of all user messages in an XML format. it returned XML Format

Sms2Net::getMessages(); 

On Success

<?xml version="1.0" encoding="UTF-8"?>
<Messages>
    <MsgID>xxxx</MsgID>
        <MsgShortDesc>xxxx</MsgShortDesc>
    <MsgDesc>xxxx</ MsgDesc >
</Messages>

contactUs()

This function to email web service to contact us it returned XML Format

Sms2Net::contactUs('[e-mail]', 'A Test Message'); 

On Success

<?xml version='1.0' encoding='UTF-8'?>
<Ok>
    <Message>Your message was sent successfully. Thanks.</Message>
</Ok>

getGroups()

This will return a list of all groups for specific user in an XML format --it returned XML Format

Sms2Net::getGroups(); 

On Success

<?xml version='1.0' encoding='UTF-8'?>
<Groups>
    <GroupID>xxxx</GroupID>
    <GroupName>xxxx</GroupName>
</Groups>

getGroup()

This will return a list of all groups for specific user in an XML format --it returned XML Format

$groupID = 212312;
Sms2Net::getGroup($groupID);

On Success

<?xml version='1.0' encoding='UTF-8'?>
<Members>
    <MemberID>xxxx</MemberID>
    <MemberName>xxxx</MemberName>
    <MemberMobile>xxxx</MemberMobile>
</Members>

phoneBook()

This will return a list of all groups & members for specific user and in an XML format --it returned XML Format

Sms2Net::phoneBook();

On Success

<?xml version='1.0' encoding='UTF-8'?>
<PhoneBook>
    <Group>
        <GroupID>xxxx</GroupID>
        <GroupName>xxxx</GroupName>
        <Member>
        <MemberID>xxxx</MemberID>
        <MemberName>xxxx</MemberName>
        <MemberMobile>xxxx</MemberMobile>
        </Member>
    </Group>
</PhoneBook>

sender()

This will return a list of all Senders for specific user in an XML format --it returned XML Format

Sms2Net::sender();

On Success

<?xml version='1.0' encoding='UTF-8'?>
<Senders>
    <SenderID>xxxx</ SenderID>
    <SenderName>xxxx</ SenderName>
    <SenderStatus>xxxx</ SenderStatus>
</Senders>

Contributing

Always Welcome 💞

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contact

Twitter @RttCy

License

Laravel-Sms2net is open-sourced software licensed under the MIT license.

© 2018 Hamza Zymawy, All rights reserved.