Configure SMS
Configure SMS
Set up SMS gateway integration for sending text message notifications to students, parents, and staff.
Time required: 20 minutes
Module: sms, openeducat_sms_enterprise
User role: System Administrator
Prerequisites
- System Administrator role
- SMS gateway provider account
- API credentials from provider
- Sender ID approved (if required)
Steps
Step 1: Access SMS Configuration
- Go to Settings -> General Settings
- Navigate to SMS section
- Click SMS Gateway Configuration
Step 2: Select SMS Provider
Choose from available providers:
| Provider | Coverage | Features |
|---|---|---|
| Twilio | Global | Two-way, MMS |
| Vonage (Nexmo) | Global | Delivery reports |
| MSG91 | India | Templates, DLT |
| TextLocal | UK, India | Bulk SMS |
| Plivo | Global | Voice + SMS |
Step 3: Enter API Credentials
For Twilio example:
| Field | Required | Description | Example |
|---|---|---|---|
| Account SID | Yes | Account identifier | ACxxxxxx |
| Auth Token | Yes | Authentication token | xxxxxxxx |
| From Number | Yes | Sender number | +1555123xxxx |
Step 4: Configure Sender Settings
| Setting | Description | Example |
|---|---|---|
| Sender ID | Alphanumeric name | ”ABC SCHOOL” |
| Sender Number | Phone number | +1555123xxxx |
| Default Country | Country code | US (+1) |
Step 5: Set Message Settings
| Setting | Description | Recommended |
|---|---|---|
| Character Encoding | Message encoding | GSM-7/UCS-2 |
| Max Length | Single SMS limit | 160 chars |
| Long SMS | Split or reject | Split |
| Unicode Support | Non-Latin characters | Enabled |
Step 6: Configure Delivery Settings
| Setting | Description |
|---|---|
| Delivery Reports | Enable status tracking |
| Retry Failed | Retry failed sends |
| Retry Attempts | Number of retries |
| Retry Delay | Wait between retries |
Step 7: Set Up Webhooks (Optional)
For delivery status updates:
- Get webhook URL from Odoo
- Add to provider dashboard
- Configure events:
- Delivered
- Failed
- Undelivered
Step 8: Test Configuration
- Click Test Connection
- Send test SMS to your number
- Verify message received
Step 9: Activate Gateway
- Enable Active checkbox
- Click Save
- Gateway is now operational
Provider-Specific Setup
Twilio
| Setting | Value |
|---|---|
| API Base URL | api.twilio.com |
| Account SID | From Twilio console |
| Auth Token | From Twilio console |
| From | Twilio phone number |
MSG91 (India)
| Setting | Value |
|---|---|
| Auth Key | From MSG91 dashboard |
| Sender ID | 6-char approved ID |
| Route | Transactional/Promotional |
| DLT Template | Registered template ID |
Vonage (Nexmo)
| Setting | Value |
|---|---|
| API Key | From Vonage dashboard |
| API Secret | Secret key |
| From | Virtual number or name |
DLT Compliance (India)
For Indian SMS:
| Requirement | Description |
|---|---|
| DLT Registration | Register with telecom |
| Entity ID | Business identifier |
| Template ID | Pre-approved templates |
| Sender ID | Approved 6-char ID |
Field Reference
SMS Gateway
| Technical Field | UI Label | Type | Notes |
|---|---|---|---|
name | Name | Char | Gateway name |
provider | Provider | Selection | Gateway provider |
account_sid | Account SID | Char | Account identifier |
auth_token | Auth Token | Char | Authentication |
from_number | From | Char | Sender number |
active | Active | Boolean | Enable gateway |
Troubleshooting
Connection failed
- Verify API credentials are correct
- Check account is active with provider
- Confirm IP is whitelisted (if required)
SMS not delivering
- Validate recipient number format
- Check sender ID is approved
- Verify SMS content isn’t blocked
- Check balance with provider
Character encoding issues
Use GSM-7 for basic characters; enable UCS-2 for Unicode/special characters.
Related: Set Up SMS Notifications | Configure Email