# SMS Configuration and Gateway Setup This article covers the configuration of the SMS gateway and message templates used across the system — including channelling, clinic, and other modules that send patient notifications. ## Navigation SMS configuration is found in the system administration settings: **Administration → SMS Configuration** (or equivalent path in your installation) Contact your system administrator if this option is not visible in your menu. --- ## SMS Gateway HMIS supports integration with external SMS gateway providers. The gateway receives the message and phone number from HMIS and delivers the SMS to the patient's mobile network. ### Choosing the gateway type HMIS supports three kinds of gateway. Turn on the one your provider uses in **Administration → Manage Institutions → Preferences → Application Options**: - **SMS Sent Using E -SMS Supported SMS Gateway** - **SMS Sent Using Basic Authentication Supported SMS Gateway** - A gateway that takes a simple JSON request (options starting **SMS Gateway with Simple JSON**) ### Gateway settings Each gateway type has its own options on the same page. Search for the type's name, for example **SMS Gateway with Basic Authentication**, and fill in: | Option | What to enter | |---|---| | **... - URL** | The provider's API address | | **... - Username**, **... - Password** | The account the provider gave you | | **... - User Alias** | The sender name or number shown to patients | | **... parameter** options (Basic Authentication only) | The names the provider uses for the username, password, alias, phone number and message fields | Click **List Application Options**, find each option, enter its **Value** and click **Save**. Then click **Reload Config** so the new values are used. ### Testing the Gateway 1. Go to **Administration → Manage Lab Services → SMS Messaging** tab → **Check SMS**. 2. Enter the gateway **Username**, **Password**, **Alias** and their parameter names, a **Number** and a **Message**. 3. Click **Send Message** and check that the phone receives it. --- ## Message Templates Templates define the content of automated SMS messages. Each template has: | Field | Description | |---|---| | Event Type | The trigger event (e.g., Booking Confirmed, Reminder, Cancellation) | | Template Text | The message body with placeholders | | Active | Whether this template is currently in use | | Language | Language of the message | ### Placeholders Use placeholders in the template text to insert patient-specific data: | Placeholder | Replaced With | |---|---| | `{patientName}` | Patient's full name | | `{doctorName}` | Consultant's name with title | | `{speciality}` | Clinical speciality | | `{sessionDate}` | Appointment date (formatted) | | `{sessionTime}` | Appointment start time | | `{tokenNo}` | Patient's token/serial number | | `{hospitalName}` | Institution name | | `{bookingRef}` | Booking reference or bill number | Example template: > "Dear {patientName}, your appointment with {doctorName} ({speciality}) is on {sessionDate} at {sessionTime}. Token: {tokenNo}. {hospitalName}." --- ## SMS Trigger Configuration Enable or disable SMS for each event type: | Event | Default | Configurable | |---|---|---| | Booking Confirmed | Enabled | Yes | | Appointment Reminder | Configurable lead time | Yes | | Session Cancelled | Enabled | Yes | | Booking Cancelled | Enabled | Yes | | Booking Rescheduled | Enabled | Yes | | Doctor Holiday | Disabled | Yes | Set the **Reminder Lead Time** (e.g., 24 hours, 48 hours) to control when reminder messages are dispatched. --- ## SMS Reports View the log of all sent messages and their delivery status: **Administration → SMS Reports** (or the SMS reports section in your configuration) ### SMS Report Data | Column | Content | |---|---| | Date/Time Sent | When the message was dispatched | | Patient | Recipient patient name | | Phone | Destination number | | Event Type | What triggered the message | | Message | Full message content | | Status | Pending / Delivered / Failed / Rejected | | Gateway Response | Raw response from the gateway (for troubleshooting) | ### Filtering SMS Reports Filter by: - Date range - Event type (booking, reminder, cancellation, etc.) - Delivery status (failed only, for troubleshooting) - Patient name or phone number ### Failed Messages If a message shows **Failed** or **Rejected**: - Check the patient's phone number is correct and in the right format (country code required if international) - Verify gateway credentials and quota - Check the gateway provider's own dashboard for outage or quota alerts --- ## SMS Credits / Quota Most gateway providers operate on a credit or subscription model. Monitor your remaining credits from the gateway provider's own portal. Configure an alert threshold so staff are notified before credits run out. --- ## Multi-Language SMS If your hospital serves patients in multiple languages, configure separate templates per language. The system selects the correct template based on the patient's registered language preference, if configured. --- ## Related Articles - [SMS Notifications in Channelling](SMS-Notifications-Channelling) - [Clinic Appointments](Clinic-Appointments) - [Channelling Overview](Channelling-Overview)