Extension Synchronization

OPBX extensions are synchronized to Cloudonix as "subscribers." This synchronization enables Cloudonix to route calls to your extensions. This document explains how the synchronization works and how to manage it.

How Extensions Map to Subscribers

Each OPBX extension is represented as a Cloudonix subscriber:

OPBX	Cloudonix	Description
Extension Number	MSISDN	Phone number or extension identifier
User Name	Display Name	Subscriber's display name
Status	Active/Inactive	Whether extension can receive calls
Voicemail	Voicemail Box	Voicemail configuration

Synchronization Behavior

• Extension Created in OPBX: Automatically creates subscriber in Cloudonix
• Extension Updated in OPBX: Updates subscriber in Cloudonix
• Extension Deleted in OPBX: Deactivates subscriber in Cloudonix

Viewing Sync Status

The Extensions page shows sync status for each extension:

Status Indicators

Icon	Status	Meaning
✅ Green check	Synced	Extension exists in both OPBX and Cloudonix
⚠️ Warning	Local Only	Extension in OPBX but not in Cloudonix
❌ Error	Cloudonix Only	Subscriber in Cloudonix but not in OPBX

Sync Comparison

To see a detailed comparison:

1. Navigate to Extensions
2. Click Sync Status or Compare button
3. View:
   • Local Only: Extensions needing to sync to Cloudonix
   • Cloudonix Only: Subscribers in Cloudonix without OPBX extensions
   • Synced: Extensions matching in both systems

Manual Synchronization

Full Sync

To synchronize all extensions:

1. Go to Extensions page

2. Click Sync All or Synchronize

3. OPBX will:

   • Create missing subscribers in Cloudonix
   • Update existing subscribers
   • Mark orphaned Cloudonix subscribers

4. View results:

   • Extensions created
   • Extensions updated
   • Any errors

Single Extension Sync

To sync a specific extension:

1. Find the extension in the list
2. Click the Sync button (or three-dot menu)
3. Wait for confirmation

Automatic Synchronization

Extensions are automatically synced in these scenarios:

On Extension Create

When you create a new extension in OPBX, it's immediately created in Cloudonix.

On Extension Update

Changes to extension details (name, status) are pushed to Cloudonix.

On Settings Save

When Cloudonix settings are saved/updated, OPBX attempts to sync all extensions.

Troubleshooting Sync Issues

Local Only Extensions

Problem: Extension exists in OPBX but not in Cloudonix

Solutions:

1. Click Sync on the specific extension
2. Check Cloudonix API key permissions
3. Verify network connectivity

Cloudonix Only Subscribers

Problem: Subscriber exists in Cloudonix but not in OPBX

Solutions:

1. This may happen if subscribers were created directly in Cloudonix
2. OPBX can import them using Sync → Import from Cloudonix
3. Or delete them in Cloudonix Portal

Sync Failures

Common Causes:

• Invalid API credentials
• Network timeout
• Cloudonix API rate limiting
• Subscriber limit reached (package restriction)

Solutions:

1. Re-validate Cloudonix credentials in Settings
2. Check the sync error message
3. Try again in a few minutes
4. Contact support if persistent

Understanding Sync Comparison Results

When you run a comparison, you'll see:

Needs Sync: 3 extensions

To Cloudonix (Created): 2
  - Extension 101 (John Doe)
  - Extension 102 (Jane Smith)

To Cloudonix (Updated): 1
  - Extension 200 (Bob Wilson) - status changed

From Cloudonix (Imported): 0

Synced: 45

Categories Explained

Category	Description	Action
To Cloudonix (Created)	New extensions not yet in Cloudonix	Click Sync to create
To Cloudonix (Updated)	Extensions with pending changes	Click Sync to update
From Cloudonix (Imported)	Cloudonix-only subscribers	Option to import
Synced	Matching in both systems	No action needed

Sync Statuses Reference

Extension Table Columns

Column	Description
Cloudonix ID	Unique subscriber ID in Cloudonix
Cloudonix UUID	Technical UUID in Cloudonix
Synced	Boolean: sync status
Last Synced	Timestamp of last sync

Best Practices

1. Initial Sync: After pairing Cloudonix, run a full sync to create all subscribers
2. Regular Checks: Periodically check sync status for any drift
3. Package Limits: Monitor your Cloudonix package for subscriber limits
4. Clean Up: Remove unused extensions to avoid orphaned subscribers

API Integration

The sync process uses the Cloudonix Subscriber API:

# List subscribers
GET /api/domains/{domain_uuid}/subscribers

# Create subscriber
POST /api/domains/{domain_uuid}/subscribers

# Update subscriber  
PUT /api/domains/{domain_uuid}/subscribers/{subscriber_id}

# Delete subscriber
DELETE /api/domains/{domain_uuid}/subscribers/{subscriber_id}

OPBX handles all these operations automatically - you don't need to use the API directly.

Next Steps

After understanding synchronization:

1. Webhook Configuration - Learn about call events
2. Create Extensions - Start adding extensions
3. Troubleshooting - Common issues and solutions

---

Related Documentation:

• Cloudonix Subscribers API
• Webhook Events
• Troubleshooting