Usage Guide
Manage SMS Gateway day-to-day from SMS Gateway in the tenant portal: monitor health, register devices, send test messages, and access manager tools.
Before you start
- SMS Gateway enabled and subscription active on your plan.
- At least one Android device Online (see Installation).
Open SMS Gateway
Sign in → sidebar → SMS Gateway.
Portal tabs
| Tab | Purpose |
|---|---|
| Status | Health cards, API URL, Private Token, API username/password, login code for app, quick actions |
| Devices | Registered phones, online state, remove device |
| Messages | Outbound/inbound message list, filters, message detail |
| Manager | Export/import database, logs, advanced maintenance |
Tab names match the portal UI (Status, Devices, Messages, Manager).
Status tab — credentials
| Field | Use |
|---|---|
| API URL | Base URL for REST integration |
| Private Token | Android app registration (Cloud Server) |
| API username / password | Basic auth for some API calls; set or rotate via credentials dialog |
Use Copy buttons. Hide or show secrets with the eye icon.
Connect with QR (recommended)
Connect with QR opens a large dialog with a pairing code and short steps. On the phone, open Settings → Cloud server → Connect with QR, allow the camera, and scan the portal dialog. The app registers the device in one step. Do not share screenshots of the dialog publicly.
See Installation for the full flow.
Login code (Android)
Generate a login code from Status when you need an alternate pairing method — codes are time-limited. Open the dialog, copy the code, and enter it in the app if prompted. Prefer Connect with QR when available.
Install app dialog
Install app opens download instructions for the Android APK — useful when onboarding a new phone before scanning the pairing code.
Devices tab
- View each registered device (model, last seen, online indicator).
- Online generally means the device checked in recently and Cloud Server is enabled on the phone.
- Remove devices you decommissioned (old phones).
Messages tab
- Browse messages with state badges: Pending, Sent, Delivered, Failed, etc.
- Filter by state when troubleshooting delivery.
- Open a message row for details (recipients, body preview, timestamps).
Send test message
Use Send message (or equivalent action on Status/Messages) to queue a single SMS through a selected device — confirm end-to-end path before going live with integrations.
Webhooks and settings
From Status or action menus, open:
- Webhooks — Register URLs for message events
- Settings — Gateway configuration exposed to your account
- API credentials — Set username/password for API access
Exact dialogs depend on your workspace version; all are launched from buttons on the Status tab area.
Manager tab
Advanced operations (when shown):
- Export / import gateway data
- View service logs
- Health-related maintenance
Use during planned maintenance only.
Introductory video
Click the video icon next to SMS Gateway in the sidebar if available.
Send setup instructions
Send instructions (menu on Status) can push setup steps to WhatsApp — helpful when a field technician installs the app.
Troubleshooting
| Issue | What to try |
|---|---|
| No devices listed | Complete Installation; wait for Online |
| Test send fails | Pick an online device; check SIM credit and signal |
| Token rejected | Re-scan Connect with QR from Status, or re-copy Private Token and save in the app |
Full list: Troubleshooting.