REST API Documentation

Quick Setup Guide

1. Download the zip file using the button above.
2. In your WordPress Admin, go to Plugins > Add New > Upload Plugin, select the zip, install and activate it.
3. Navigate to WooCommerce > Settings > SMSGo.
4. Enter your SMSGo API Key (starts with sg_) and select your approved sender mask.
5. Enable and write custom SMS templates for individual order status changes.

Setup Guide using Shopify Flow

1. Install the free, official Shopify Flow app from the Shopify App Store.
2. Create a new workflow and select a trigger event (e.g., Order created or Fulfillment created).
3. Add a new Action and choose Send HTTP request.
4. Configure the HTTP Request block with the following settings:
   • HTTP Method: POST
   • URL: https://api.smsgo.lk/api/v1/sms/send
   • Headers:
     Content-Type: application/json

     X-API-Key: YOUR_API_KEY
   • Body (JSON):

     {
       "to": "{{order.billingAddress.phone}}",
       "message": "Hi {{order.billingAddress.firstName}}, your order {{order.name}} has been placed successfully! Order total is {{order.totalPriceSet.shopMoney.amount}} LKR.",
       "mask": "YOUR_MASK"
     }

5. Turn on the workflow to start dispatching automated messages.

Option B: Custom Notification Channel

Create a custom SMS channel to dispatch database-driven user notifications. Define a helper class under app/Notifications/Channels/SmsGoChannel.php:

namespace App\Notifications\Channels;

use Illuminate\Notifications\Notification;
use Illuminate\Support\Facades\Http;

class SmsGoChannel
{
    public function send($notifiable, Notification $notification)
    {
        $message = $notification->toSmsGo($notifiable);
        $to = $notifiable->routeNotificationFor('smsgo') ?? $notifiable->phone;

        if (!$to) {
            return;
        }

        Http::withHeaders([
            'X-API-Key' => config('services.smsgo.key'),
            'Content-Type' => 'application/json',
        ])->post('https://api.smsgo.lk/api/v1/sms/send', [
            'to' => $to,
            'message' => $message,
            'mask' => config('services.smsgo.mask', 'SMSGO'),
        ]);
    }
}

Step 2: Use Helper in Express Endpoint

const express = require('express');
const app = express();
app.use(express.json());

app.post('/api/send-alert', async (req, res) => {
  const { phoneNumber, alertText } = req.body;

  try {
    const result = await sendSMS(phoneNumber, alertText);
    res.json({ success: true, data: result.data });
  } catch (error) {
    res.status(500).json({ success: false, error: 'SMS dispatch failed' });
  }
});