SMS Gateway Setup
SMS gateway setup in EquiBillBook allows you to configure an SMS service provider to send text message notifications. This guide explains how to set up and configure SMS gateway integration effectively.
What is SMS Gateway Setup?
SMS gateway setup involves configuring an SMS service provider (gateway) that EquiBillBook uses to send text messages. The gateway acts as an intermediary between EquiBillBook and mobile networks, enabling the delivery of SMS notifications to mobile phones.
Accessing SMS Gateway Setup
To access SMS gateway setup:
- Navigate to Settings → Notification Settings → SMS Gateway Setup
- View current SMS gateway configuration
- Configure or update SMS gateway settings
- Test SMS delivery
Supported SMS Gateways
EquiBillBook supports various SMS gateway providers:
- Twilio: Popular cloud communications platform
- MessageBird: Global SMS messaging service
- Nexmo/Vonage: Cloud communications API
- TextLocal: SMS gateway for India
- MSG91: SMS service provider
- Plivo: Cloud communications platform
- Custom Gateway: Configure your own SMS gateway
Twilio SMS Gateway Setup
To configure Twilio:
- Create Twilio account at twilio.com
- Get Account SID and Auth Token from Twilio dashboard
- In EquiBillBook, select Twilio as SMS gateway
- Enter Account SID
- Enter Auth Token
- Enter Twilio phone number (sender number)
- Test SMS delivery
- Save configuration
MessageBird SMS Gateway Setup
To configure MessageBird:
- Create MessageBird account
- Get API key from MessageBird dashboard
- In EquiBillBook, select MessageBird as SMS gateway
- Enter API key
- Enter sender name or number
- Test SMS delivery
- Save configuration
TextLocal SMS Gateway Setup
To configure TextLocal (India):
- Create TextLocal account
- Get API key from TextLocal dashboard
- In EquiBillBook, select TextLocal as SMS gateway
- Enter API key
- Enter sender name (6 characters max)
- Test SMS delivery
- Save configuration
MSG91 SMS Gateway Setup
To configure MSG91:
- Create MSG91 account
- Get Auth Key from MSG91 dashboard
- In EquiBillBook, select MSG91 as SMS gateway
- Enter Auth Key
- Enter sender ID
- Test SMS delivery
- Save configuration
Custom SMS Gateway Setup
To configure custom SMS gateway:
- Get API documentation from your SMS provider
- In EquiBillBook, select Custom Gateway
- Enter API endpoint URL
- Enter API key/token
- Configure request format (GET/POST, parameters)
- Configure response format
- Test SMS delivery
- Save configuration
SMS Gateway Configuration Settings
Common configuration settings:
- Gateway Provider: Select SMS gateway provider
- API Key/Token: Authentication key from provider
- API Secret: Secret key (if required)
- Sender ID/Number: Sender name or phone number
- API URL: Gateway API endpoint URL
- Country Code: Default country code for phone numbers
- Test Mode: Enable test mode for testing
SMS Gateway API Configuration
Configure API settings:
- Request Method: GET or POST
- Request Headers: Custom headers if required
- Request Parameters: Parameter names and format
- Response Format: JSON, XML, or plain text
- Success Response: How success is indicated
- Error Handling: How errors are handled
SMS Gateway Testing
Test SMS gateway configuration:
- Go to SMS Gateway Setup
- Click Test SMS button
- Enter test phone number (with country code)
- Enter test message
- Send test SMS
- Verify SMS is received
- Check for any error messages
- Fix issues if test fails
SMS Gateway Credentials
Important notes about credentials:
- Keep Secure: Protect API keys and tokens
- Don't Share: Never share gateway credentials
- Regular Updates: Update credentials if compromised
- Access Control: Limit access to gateway settings
- Backup: Keep backup of credentials securely
SMS Gateway Costs
Understand SMS gateway costs:
- Per SMS Cost: Each SMS may incur a cost
- Pricing Models: Pay-per-SMS, monthly plans, credits
- International SMS: Higher costs for international numbers
- Long Messages: Messages split into multiple SMS cost more
- Monthly Limits: Some plans have monthly limits
- Cost Monitoring: Monitor SMS usage and costs
SMS Delivery Settings
Configure SMS delivery options:
- Retry Failed SMS: Automatically retry failed deliveries
- Retry Attempts: Number of retry attempts (default: 2)
- Retry Interval: Time between retry attempts
- Delivery Reports: Track SMS delivery status
- Delivery Receipts: Receive delivery confirmations
SMS Gateway Logs
Monitor SMS gateway activity:
- View SMS sending logs
- Check delivery status
- Review failed SMS attempts
- Monitor API errors
- Track SMS costs
- Analyze delivery rates
Troubleshooting SMS Gateway
Common issues and solutions:
- Connection Failed: Check API URL and credentials
- Authentication Failed: Verify API key/token is correct
- SMS Not Sending: Check sender ID/number format
- Invalid Phone Number: Ensure phone numbers include country code
- Rate Limits: Some gateways have rate limits
- Insufficient Credits: Check account balance/credits
- API Errors: Review API error messages
SMS Gateway Best Practices
- Choose Reliable Provider: Select reputable SMS gateway
- Test Thoroughly: Test configuration before deploying
- Monitor Costs: Track SMS usage and costs
- Keep Credentials Secure: Protect API keys
- Monitor Delivery: Track delivery rates
- Handle Errors: Implement proper error handling
- Backup Gateway: Consider backup gateway for reliability
SMS Gateway Backup
Configure backup SMS gateway:
- Set up secondary SMS gateway
- Automatically switch to backup if primary fails
- Ensure backup has sufficient credits
- Test backup configuration
SMS Compliance
Important compliance considerations:
- Opt-in Required: Get consent before sending SMS
- Opt-out Mechanism: Provide easy opt-out (reply STOP)
- Regulations: Comply with SMS marketing regulations (TCPA, GDPR)
- Content Guidelines: Follow content guidelines
- Spam Prevention: Avoid spammy messages
Properly configured SMS gateway ensures reliable delivery of SMS notifications. Choose a reputable SMS provider, configure settings correctly, and test thoroughly before deploying.