user guide · 2020. 7. 8. · api provider: admin can select msg91 sms gateway. msg91 sid: admin...

Order SMS Notification (M2) Magento Extension by PIXLOGIX

USER GUIDE

Copyright 2015 - 2020 © Pixlogix.com

All rights reserved

[email protected]

https://www.pixlogix.com/

2 Go to: Table of Contents Copyright 2015 – 2020

© Pixlogix.com

© Pixlogix.com

Table of Contents 1. Installation Process .............................................................................................................3

2. OrderSMS Notification Configuration .................................................................................4

2.1 General Settings ...........................................................................................................4

2.2 API Settings (SMS Gateways) .......................................................................................5

2.2.1 Msg91 SMS Gateway ............................................................................................6

2.2.2 Bulk SMS Gateway ................................................................................................8

2.2.3 Twilio SMS Gateway .............................................................................................9

2.3 Order Placement Notification Settings .......................................................................11

2.4 Order Shipment Notification Settings ........................................................................12

2.5 Order Invoice Notification Settings ............................................................................13

2.6 Order Cancel Notification Settings .............................................................................14

2.7 Order Creditmemo Notification Settings ....................................................................15

3. Order Placement Notification to Customer .......................................................................16

4. Order Shipment Notification to Customer ........................................................................17

5. Order Invoice Notification to Customer ............................................................................18

6. Order Cancel Notification to Customer .............................................................................19

7. Order Credit Memo Notification to Customer ...................................................................20

8. Phone Number Verification ...............................................................................................21

8.1 General Setting ...........................................................................................................21

8.2 API Settings (OTP Gateways) ......................................................................................22

8.2.1 Twilio OTP Gateway ...........................................................................................23

8.2.2 Msg91 OTP Gateway ..........................................................................................25

9. OTP Notification to Customer ...........................................................................................27

10. License ...............................................................................................................................28

11. Help & Support ..................................................................................................................29

http://www.pixlogix.com/http://www.pixlogix.com/


© Pixlogix.com

© Pixlogix.com

1. Installation Process

To install the extension, you need to follow below steps

Backup your web directory and store database

Enable all cache from admin (System > Tools > Cache Management) before upload

extension.

Extract extension zip package and copy all folders/files.

Upload (app) folder to your store root folder by FTP.

After uploading (app) folder navigate to your store root folder in the SSH console of your

server:

o cd path_to_the_store_root_folder (cd public_html)

o Run the following command:

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy

php bin/magento cache:flush

Flush the store cache; Logout to complete installation process and login.



© Pixlogix.com

© Pixlogix.com

2. OrderSMS Notification Configuration

2.1 General Settings

Enable Notification: To enable or disable order SMS notification extension.



© Pixlogix.com

© Pixlogix.com

2.2 API Settings (SMS Gateways)

API Provider: Admin can select API Provider (SMS gateways) from here.



© Pixlogix.com

© Pixlogix.com

2.2.1 Msg91 SMS Gateway

API Provider: Admin can select Msg91 sms gateway.

Msg91 SID: Admin can add sms sender id at list 6 character or digit. (I.e. your company name, INVITE, INFORM, 123456, etc.)

Msg91 Authkey: Admin can get authentication key from below URL. https://control.msg91.com/user/index.php#api

Msg91 URL: User can get API URL below URL.

https://docs.msg91.com/collection/msg91-api-integration/5/send-sms/T26A6X72

http://www.pixlogix.com/http://www.pixlogix.com/https://control.msg91.com/user/index.php#apihttps://docs.msg91.com/collection/msg91-api-integration/5/send-sms/T26A6X72


© Pixlogix.com

© Pixlogix.com

You can get authentication key from https://control.msg91.com/user/index.php#api

URL.

http://www.pixlogix.com/http://www.pixlogix.com/https://control.msg91.com/user/index.php#api


© Pixlogix.com

© Pixlogix.com

2.2.2 Bulk SMS Gateway

API Provider: Admin can select Bulk-SMS gateway.

Sender Id: Admin can add sms sender id at list 6 character or digit. (I.e. your company

name, INVITE, INFORM, 123456, etc.)

Bulk SMS Username: User can signup or login to https://www.bulksmsgateway.in/ and

get username.

Bulk SMS Password: User can signup or login to https://www.bulksmsgateway.in/ and

get password.

http://www.pixlogix.com/http://www.pixlogix.com/https://www.bulksmsgateway.in/https://www.bulksmsgateway.in/


© Pixlogix.com

© Pixlogix.com

2.2.3 Twilio SMS Gateway

API Provider: Admin can select Twilio sms gateway.

Twilio SID: User can get Twilio SID (Account SID) from below URL.

https://www.twilio.com/console

Twilio Auth Token: User can get Twilio auth token from below URL.


Twilio Phone Number: User can get Twilio phone number from below URL.


http://www.pixlogix.com/http://www.pixlogix.com/https://www.twilio.com/consolehttps://www.twilio.com/consolehttps://www.twilio.com/console


© Pixlogix.com

© Pixlogix.com

You can get Auth Token and Phone Number from below URL. https://www.twilio.com/console

http://www.pixlogix.com/http://www.pixlogix.com/https://www.twilio.com/console


© Pixlogix.com

© Pixlogix.com

2.3 Order Placement Notification Settings

Order Placement Notification: To enable or disable order placement notification.

SMS Text for Customers: Admin can set or change this text for customer SMS

notification.



© Pixlogix.com

© Pixlogix.com

2.4 Order Shipment Notification Settings

Order Shipment Notification: To enable or disable order shipment notification.


notification.



© Pixlogix.com

© Pixlogix.com

2.5 Order Invoice Notification Settings

Order Invoice Notification: To enable or disable order invoice notification.


notification.



© Pixlogix.com

© Pixlogix.com

2.6 Order Cancel Notification Settings

Order Cancel Notification: To enable or disable order cancel notification.


notification.



© Pixlogix.com

© Pixlogix.com

2.7 Order Creditmemo Notification Settings

Order Creditmemo Notification: To enable or disable order creditmemo notification.


notification.



© Pixlogix.com

© Pixlogix.com

3. Order Placement Notification to Customer

Customer will receive SMS after successfully placed order.



© Pixlogix.com

© Pixlogix.com

4. Order Shipment Notification to Customer

Customer will receive SMS after order shipped.



© Pixlogix.com

© Pixlogix.com

5. Order Invoice Notification to Customer

Customer will receive SMS after invoice generated.



© Pixlogix.com

© Pixlogix.com

6. Order Cancel Notification to Customer

Customer will receive SMS after order cancellation.



© Pixlogix.com

© Pixlogix.com

7. Order Credit Memo Notification to Customer

Customer will receive SMS after credit memo generated.



© Pixlogix.com

© Pixlogix.com

8. Phone Number Verification

8.1 General Setting

OTP Notification: To enable or disable Phone Number Verification.



© Pixlogix.com

© Pixlogix.com

8.2 API Settings (OTP Gateways)

API Provider: Admin can select API Provider (OTP gateways) from here.



© Pixlogix.com

© Pixlogix.com

8.2.1 Twilio OTP Gateway

Authy Key: Admin can get API/Authy Key from below path.

Twilio -> Authy -> SMS Authentication -> Settings.

OTP Length: Admin can add OTP length value between 4 to 8. By default length is 4.



© Pixlogix.com

© Pixlogix.com

You can get API (Authy) Key from https://www.twilio.com/console/authy/applications

URL and click on SMS Authentication after click on Settings tab.

http://www.pixlogix.com/http://www.pixlogix.com/https://www.twilio.com/console/authy/applications


© Pixlogix.com

© Pixlogix.com

8.2.2 Msg91 OTP Gateway

SenderId: Admin can add otp sender id at list 6 character or digit. (I.e. your company name, INVITE, INFORM, 123456 etc.). Receiver will see this as sender’s ID (default:

OTPSMS).

API Key: Admin can get authentication key from below URL.

https://control.msg91.com/user/index.php#api

OTP Length: Admin can add OTP length value between 4 to 9. By default length is 4.



© Pixlogix.com

© Pixlogix.com

You can get authentication key from below URL.

https://control.msg91.com/user/index.php#api



© Pixlogix.com

© Pixlogix.com

10. License

What is allowed with single regular license?

You can use it on one website for yourself or for your client.

You will need to purchase another regular license for another domain or clients.

You can setup extension on your staging server for testing/development purposes (that

setup shouldn't be available to the public).

You can customize extension, you can modify it with other works as per your need.

Extension updates will be available free for single website.

What is not allowed?

It is not allowed to create multiple websites with single regular license. You will need to

purchase multiple regular licenses for multiple websites.

It is not allowed to copy our extension code to misuse or for other extension creation or

for selling purpose.



© Pixlogix.com

© Pixlogix.com

11. Help & Support

Please read "User Guide" carefully, it will help you to resolve most of potential problems with

incorrect configuration of the extension in Magento. If you don't find the answer to your

questions, please watch our video from below url.

Video - Extension Installation & Form Configuration guideline

Coming soon..! (Under Creation)

Magento Support Policy

Magento configuration, installation, maintenance, customization etc. is beyond the scope of our

support. We can provide you paid support on extension setup, customization & Magento custom

requirement. If you found bug within extension, please contact us at below email.

[email protected]

Developed by

PIXLOGIX INFOTECH PVT. LTD. is a multi-disciplinary, award-winning web design, development and user

experience company with special focus on website usability and responsive design. The PIXLOGIX team

consists of a highly experienced team of specialists with an outstanding record of providing high quality

deliverables both on a timely basis and at very affordable cost.

PIXLOGIX is a Global provider of web programming and IT services with clients based in the USA, UK,

Australia, Finland, Spain, Netherlands and many more. Our communication skills are excellent and are

pleased to participate in providing quotations per Requests for Quotation or proposals. We guarantee

your satisfaction!

www.pixlogix.com

Thank you!


1. Installation Process2. OrderSMS Notification Configuration2.1 General Settings2.2 API Settings (SMS Gateways)2.2.1 Msg91 SMS Gateway2.2.2 Bulk SMS Gateway2.2.3 Twilio SMS Gateway2.3 Order Placement Notification Settings2.4 Order Shipment Notification Settings2.5 Order Invoice Notification Settings2.6 Order Cancel Notification Settings2.7 Order Creditmemo Notification Settings

3. Order Placement Notification to Customer4. Order Shipment Notification to Customer5. Order Invoice Notification to Customer6. Order Cancel Notification to Customer7. Order Credit Memo Notification to Customer8. Phone Number Verification8.1 General Setting8.2 API Settings (OTP Gateways)8.2.1 Twilio OTP Gateway8.2.2 Msg91 OTP Gateway

9. OTP Notification to Customer10. License11. Help & Support

user guide · 2020. 7. 8. · api provider: admin can select msg91 sms gateway. msg91 sid: admin...

Documents