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

https://github.com/boxlinknet/kwtsms-magento

SMS notifications and OTP for Adobe Commerce (Magento 2) via kwtSMS gateway
https://github.com/boxlinknet/kwtsms-magento

adobe-commerce arabic kuwait kwtsms magento magento2 magento2-module otp sms sms-gateway

Last synced: 28 days ago
JSON representation

SMS notifications and OTP for Adobe Commerce (Magento 2) via kwtSMS gateway

Awesome Lists containing this project

README

          

# kwtSMS for Magento 2

[![CodeQL](https://github.com/boxlinknet/kwtsms-magento/actions/workflows/codeql.yml/badge.svg)](https://github.com/boxlinknet/kwtsms-magento/actions/workflows/codeql.yml)
[![GitGuardian](https://github.com/boxlinknet/kwtsms-magento/actions/workflows/gitguardian.yml/badge.svg)](https://github.com/boxlinknet/kwtsms-magento/actions/workflows/gitguardian.yml)
[![Magento](https://img.shields.io/badge/Magento-2.4.7+-orange.svg)](https://magento.com)
[![PHP](https://img.shields.io/badge/PHP-8.2%20|%208.3-blue.svg)](https://php.net)
[![License](https://img.shields.io/badge/License-OSL--3.0-green.svg)](LICENSE)

SMS notifications and OTP verification for Adobe Commerce (Magento 2) via the [kwtSMS](https://www.kwtsms.com) gateway.

## Features

- **Order SMS notifications:** New order, status change, shipment, invoice, refund, cancellation
- **Customer SMS:** Welcome message on registration
- **Admin alerts:** New order, new customer, low stock
- **Bilingual templates:** English and Arabic with placeholder support
- **Full SMS logging:** Searchable admin grid with export
- **Dashboard:** SMS analytics, balance, connection status
- **Test mode:** Send to API queue without delivering (credits recoverable)
- **Phone validation:** 90+ country rules with Arabic numeral conversion
- **Daily sync:** Auto-refresh balance, sender IDs, and coverage via cron

## Requirements

- Magento 2.4.7+
- PHP 8.2 or 8.3
- Active [kwtSMS](https://www.kwtsms.com) account with API access

## Installation

### Via Composer (Marketplace)

```bash
composer require kwtsms/module-sms-integration
bin/magento module:enable KwtSms_SmsIntegration
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

### Manual Installation

1. Copy the module to `app/code/KwtSms/SmsIntegration/`
2. Run:
```bash
bin/magento module:enable KwtSms_SmsIntegration
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```

## Configuration

1. Go to **Stores > Configuration > kwtSMS > Gateway Settings**
2. Enter your API username and password
3. Click **Test Connection**
4. Select your Sender ID
5. Enable the module

## kwtSMS Account

1. Register at [kwtsms.com](https://www.kwtsms.com)
2. Request API access from your account menu
3. Find your API username and password in your account API page

**Note:** API username is NOT your phone number.

## Development

### Docker Setup

```bash
docker compose up -d
docker compose exec php bash /var/www/html/docker/install-magento.sh
```

- Storefront: http://localhost:8085
- Admin: http://localhost:8085/admin
- phpMyAdmin: http://localhost:8083

## Security

Report security vulnerabilities to: support@kwtsms.com

See [SECURITY.md](SECURITY.md) for details.

## License

OSL-3.0