SH SMS Notifier

The Smart SMS Notifier plugin automatically sends SMS notifications for all email-triggered events in Botble CMS. It provides a robust gateway system, country-based routing, and a dynamic template engine.

Features

• Automatic Email-to-SMS: Automatically detect when an email is sent using Botble's EmailHandler and send a corresponding SMS.
• Multi-Gateway Support: Built-in support for Twilio, Nexmo (Vonage), Fast2SMS, and a flexible Custom API gateway.
• Country-based Routing: Route SMS through different gateways based on the recipient's phone number prefix (e.g., +880, +91).
• Dynamic Templates: Edit SMS templates directly from the admin panel with support for variables like {{customer_name}}, {{order_id}}, etc.
• SMS Logs: Track every SMS sent, including status and gateway responses.
• Queue Support: Offload SMS sending to Laravel queues for better performance.

How to Use

1. Initial Setup

1. Navigate to Smart SMS Notifier > Settings.
2. Enable the plugin using the Enable Smart SMS Notifier toggle.
3. (Optional) Enable Use Queue.
4. Set your Default Gateway.

2. Configuring Gateways

1. Click Edit on your preferred gateway.
2. Enter API credentials.
3. Use Test SMS.

3. Custom Gateway Integration

If your provider is not built-in, you can add it dynamically:

1. Go to Custom Gateways List.
2. Add gateway names.
3. Configure using {phone} and {message}.

4. SMS Templates

1. Go to SMS Templates.
2. Customize messages.
3. Use variables.
4. Enable/disable templates.

5. Country-based Routing

1. Go to Country Routing.
2. Add routing rules.
3. Example: +880 → local gateway.

6. Monitoring Logs

1. Visit SMS Logs.
2. View details using Eye Icon.

Developer Integration (v3.0.x)

Smart SMS Notifier is designed for easy integration.

1. Create a Template

Add a .stpl file:
platform/plugins/your-plugin/resources/sms-templates/ticket_created.stpl

Hi {{customer_name}}, your ticket #{{ticket_id}} has been created.

2. Dispatch SMS from Code

use Platform\Plugins\SmartSmsNotifier\Facades\SmsHandler;
SmsHandler::setModule('your-plugin')
    ->setVariableValues([
        'customer_name' => $user->name,
        'ticket_id' => $ticket->id,
    ])
    ->sendUsingTemplate('ticket_created', $phone);

Gateway Development Guide

Follow these steps to add a new SMS provider.

1. Create the Gateway Class

class YourProviderGateway implements SmsGatewayInterface
{
    public function send(string $phone, string $message): array
    {
        try {
            $response = Http::post('https://api.yourprovider.com/send', [
                'to' => $phone,
                'msg' => $message,
            ]);

            return [
                'success' => $response->successful(),
                'message' => $response->successful() ? 'Sent' : 'Failed',
                'response' => $response.json(),
            ];
        } catch (\Exception $e) {
            return ['success' => false];
        }
    }
}

2. Register in SmsService

'yourprovider' => new YourProviderGateway()

Built with ❤️ for Botble CMS.