Skip to main content

Clickatell Integration

Enable SMS-based WiFi authentication with one-time passwords and phone verification on your captive portal using Clickatell's global messaging platform.

Overview​

The Clickatell integration provides:

  • SMS OTP authentication for captive portal
  • Phone verification for guests
  • SMS notifications and alerts
  • Global SMS delivery coverage

Prerequisites​

  • IronWifi account with captive portal
  • Clickatell account (clickatell.com)
  • Clickatell API credentials

Clickatell Setup​

Create Account​

  1. Sign up at clickatell.com
  2. Complete account verification
  3. Add credits or set up billing

Create SMS Integration​

  1. In Clickatell portal, go to SMS > Integrations
  2. Click Create new integration
  3. Select REST API
  4. Configure:
    • Name: IronWifi
    • Features: Enable One API
  5. Note your API Key

Get Credentials​

You'll need:

  • API Key: From integration settings
  • From Number (optional): Sender ID or number

IronWifi Configuration​

Step 1: Add Clickatell Provider​

  1. Log in to IronWifi Console
  2. Navigate to Networks > Captive Portals
  3. Select your captive portal
  4. Go to Authentication Providers
  5. Click Add Provider > Clickatell (SMS)

Step 2: Configure API​

Enter Clickatell credentials:

  • API Key: Your Clickatell API key
  • From: Sender ID or phone number (optional)

Step 3: SMS Settings​

Message Template:

Your WiFi access code is: {{code}}
Valid for {{expiry}} minutes.

Configuration:

  • Code Length: 4-8 digits
  • Code Expiry: Minutes until code expires
  • Max Attempts: Verification attempts allowed

Authentication Flow​

SMS Login Process​

  1. Guest connects to WiFi
  2. Captive portal displays phone input
  3. Guest enters mobile number
  4. Clickatell sends SMS with OTP
  5. Guest enters code on portal
  6. Code verified, access granted

User Experience​

[Phone Number Input]
+1 (___) ___-____
[Send Code]

↓ SMS Sent ↓

[Enter Code]
______
[Verify]

Configuration Options​

Sender ID​

Configure sender identification:

  • Alphanumeric: Company name (e.g., "GuestWiFi")
  • Numeric: Phone number
  • Shortcode: If available in region

Note: Sender ID support varies by country.

Message Customization​

Available variables:

VariableDescription
{{code}}One-time password
{{expiry}}Expiry time in minutes
{{network}}Network name
{{location}}WiFi location

Rate Limiting​

Configure abuse prevention:

  • SMS per number per hour: 3
  • SMS per IP per hour: 10
  • Cooldown period: 60 seconds between requests

Country Configuration​

Allowed Countries​

Restrict SMS to specific countries:

  1. In provider settings, find Country Restrictions
  2. Enter allowed country codes:
    • US - United States
    • CA - Canada
    • GB - United Kingdom
  3. Requests from other countries are rejected

International Formatting​

Ensure numbers are in E.164 format:

  • US: +14155551234
  • UK: +447911123456
  • Format validation prevents errors

Two-Factor Authentication​

Add SMS as 2FA​

  1. Configure primary authentication (social, email, etc.)
  2. Enable Two-Factor Authentication
  3. Select Clickatell SMS as 2FA method
  4. Configure 2FA settings

2FA Flow​

  1. User completes primary login
  2. Prompted for phone number
  3. SMS code sent
  4. Code verified
  5. Full access granted

Notifications​

Welcome SMS​

Send after successful authentication:

Welcome to {{network}}!
You have {{duration}} of WiFi access.

Expiry Warning​

Notify before access expires:

Your WiFi access expires in 10 minutes.

Troubleshooting​

SMS Not Received​

  1. Verify phone number format (E.164)
  2. Check Clickatell account has credits
  3. Review Clickatell message logs
  4. Check country is supported
  5. Verify carrier isn't blocking

Invalid Code Errors​

  1. Check code hasn't expired
  2. Verify correct code entered
  3. Ensure max attempts not exceeded
  4. Request new code

API Errors​

  1. Verify API key is correct
  2. Check account status (active, funded)
  3. Review Clickatell API logs
  4. Test API directly

Monitoring​

Clickatell Dashboard​

Monitor in Clickatell:

  • Message delivery status
  • Delivery reports
  • Error rates
  • Credit usage

IronWifi Logs​

Review in IronWifi:

  • Authentication attempts
  • Success/failure rates
  • Phone numbers used

Costs​

Clickatell Pricing​

  • Per-message pricing varies by country
  • Typically $0.01 - $0.10 per SMS
  • Volume discounts available
  • Prepaid or postpaid billing

Cost Optimization​

  1. Implement rate limiting
  2. Use country restrictions
  3. Validate numbers before sending
  4. Monitor for abuse

Security​

Best Practices​

  1. Rate limiting - Prevent SMS bombing
  2. Country restrictions - Limit to service area
  3. Number validation - Reject invalid numbers
  4. Short code expiry - 5 minutes recommended
  5. Attempt limits - Block after failures