Admin Configuration
This guide provides step-by-step instructions for configuring the SMS Gateway plugin.
Step 1 — Navigate to SMS Gateway
Landlord: Admin → SMS Gateway → /admin-home/sms-gateway/
Tenant: Admin → SMS Gateway → /admin-home/tenant/sms-gateway/
The page shows a grid of all 23 providers. Each card shows:
- Provider logo + website URL
- Active badge (green) when the provider is the current active one
- Settings icon (
⚙️configured /🔧unconfigured) - Toggle switch (dimmed/disabled if not yet configured)
Step 2 — Configure a Provider
Click the settings icon (gear or wrench) on any provider card. A modal opens with that provider's credential fields.
Fill in the required fields (they differ per provider — e.g., Account SID + Auth Token for Twilio, API Key + Sender ID for others).
Set the OTP Expire Time (30 seconds up to 5 minutes).
Click Save Changes. Credentials are stored as a JSON blob in sms_gateways.credentials.
Important: You cannot activate a provider without saving credentials first. If you try to toggle it on, the system automatically opens the config modal with a hint banner.
Step 3 — Activate a Provider
After saving credentials, flip the toggle on the provider card.
- The server blocks activation if credentials are empty (returns an error response).
- On success, all other providers are automatically deactivated — only one is active at a time.
- The activated card gets a green
Activebadge and green border highlight.
Step 4 — Enable OTP Login (optional)
At the top of the SMS Gateway page there is an OTP Verification toggle. Enabling it requires users to verify a one-time code sent to their phone when logging in.
A SweetAlert confirmation dialog appears before the toggle is committed. The setting can be reversed at any time.
Step 5 — Configure SMS Settings
Click the SMS Settings button (top-right of the page).
In the modal:
- Toggle which events send SMS notifications (new user, new order, new shop — shown based on context).
- Set the Receiving Phone Number — this is the admin's number for all admin-directed notifications. Must include country code (e.g.
+8801711000000).
Click Update to save.
Step 6 — Customize Message Templates (optional)
Click the Templates button (top-right of the page).
Each event has a textarea for a custom message. Leave blank to use the built-in default. Click a tag badge (e.g. @otp_code, @order_id, @site_title) to insert it at the cursor position.
| Template | Available Tags |
|---|---|
| Login OTP | @otp_code, @site_title |
| New User (User) | @site_title |
| New User (Admin) | @site_title |
| New Order (User) | @order_id, @site_title |
| New Order (Admin) | @order_id, @site_title |
| New Shop (User) | @site_title |
| New Shop (Admin) | @site_title |
Click Save Templates.
Step 7 — Send a Test SMS
Click the Test SMS button (top-right of the page).
Enter any phone number (with country code) and click Send. The active provider will attempt delivery. On failure, a clear error message is shown.