An open API service indexing awesome lists of open source software.

https://github.com/moceanapi/magento-sms


https://github.com/moceanapi/magento-sms

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# MoceanAPI Magento SMS Extension

## Contents
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Frequently Asked Questions](#faq)

## Features
- Automatically send SMS to admin on new orders
- Automatically send SMS customers when order status changed

## Installation

1. Navigate to your `Magento` root directory

2. Download `MoceanAPI Magento SMS Extension using command below`

`composer require mocean/magento-sms`

3. Enable the extension and clear static view files using below command

`php bin/magento module:enable Mocean_MagentoSms --clear-static-content`

4. Register the extension using below command

`php bin/magento setup:upgrade`

5. Clean the cache using below command

`php bin/magento cache:clean`

6. Configure the extension in `Admin Panel` at `Admin Panel => Stores => Configuration => MoceanAPI`

![image](https://user-images.githubusercontent.com/24620178/186089612-cc492b03-1de1-4a31-b920-d23ff1cb3c77.png)

## Configuration

1. Mocean API Key

You can get Mocean API key from [MoceanAPI Dashboard](https://dashboard.moceanapi.com)

2. Mocean API Secret

You can get Mocean API key from [MoceanAPI Dashboard](https://dashboard.moceanapi.com)

3. Sender Name

Your business name

4. Admin phone number

Your phone number to get notified on new orders

5. Debug

If set to yes, will log API Calls

### SMS Settings

1. Send SMS to Admin on new order

Select yes and you will be able to customise the SMS template to send.

2. Send SMS to your customer when their order status changed to SHIPPED

Select yes and you will be able to customise the SMS template to send to your customer when their order status changed to shipped

![image](https://user-images.githubusercontent.com/24620178/186100994-1055581c-08c1-480d-9568-f51616695632.png)

## FAQ
1. Can I get Test Credits ?

You can get 20 FREE credits and credits are valid for 14 days. Subject to approval.

2. Can I send international messages?

Yes. We are an international SMS provider. You can send out SMS both locally and internationally based on our price list.

3. What is the maximum characters per SMS I can put into the message?

160 characters for a normal text message, 70 characters for a Unicode text message (Arabic, Chinese, and etc)

4. Is there a limit to how many numbers I can send at one time?

There is no limit on numbers to be sent in one go.

5. What format does my phone number need to be in?

Mobile phone numbers need to be entered in international formatting with the country code and without spaces, plus signs or leading zeros.

**Did not find what you're looking for ?**

Raise a support ticket with our Support Team at support@moceanapi.com.

## Feature Request / Get Help
Raise a support ticket with our Support Team at support@moceanapi.com.