Skip to main content

Cloudonix Account Setup

This guide walks you through creating a Cloudonix account and obtaining the credentials needed to integrate with OPBX.

Prerequisites​

Before starting, ensure you have:

Creating a Cloudonix Account​

Step 1: Sign Up​

  1. Navigate to the Cloudonix Portal
  2. Click Sign Up or Get Started
  3. Enter your email address and create a password
  4. Complete any verification steps (email confirmation)

Step 2: Verify Email​

Check your inbox for a verification email from Cloudonix and click the confirmation link.

Step 3: Initial Setup​

After logging in for the first time:

  1. Complete your profile information
  2. Accept terms of service
  3. You may be prompted to create your first domain

Finding Your Domain UUID​

Your Domain UUID is the unique identifier for your Cloudonix account. You'll need this to configure OPBX.

Via the Cloudonix Portal​

  1. Log in to the Cloudonix Portal
  2. Navigate to Settings or Domain Settings
  3. Look for Domain UUID or Tenant ID
  4. Copy the UUID value (format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Via API (Alternative)​

If you have API access, you can retrieve your domain information:

curl -X GET "https://api.cloudonix.io/api/domains/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

The response will include your domain_uuid.

Generating API Keys​

OPBX requires two types of API keys for the integration:

Domain API Key (Required)​

This key authenticates OPBX when making API calls to Cloudonix.

  1. In the Cloudonix Portal, go to Settings → API Keys
  2. Click Create API Key or Generate Key
  3. Give it a descriptive name (e.g., "OPBX Integration")
  4. Select appropriate permissions:
    • domain:read - Read domain information
    • voice:read - Read voice applications
    • voice:write - Create/update voice applications
    • subscriber:read - Read subscribers
    • subscriber:write - Create/update subscribers
    • cdr:read - Read call records
  5. Copy the generated key immediately (it will not be shown again)
Store Your Key Safely

API keys cannot be retrieved after creation. Store it in a secure location.

This key is used to authenticate webhooks that Cloudonix sends to OPBX. It provides an additional layer of security.

  1. In the Cloudonix Portal, go to Settings → API Keys
  2. Look for Requests API Key or Webhook Authentication
  3. Generate a new key if one doesn't exist
  4. Copy the key

Understanding Cloudonix Packages/Tiers​

Cloudonix offers different packages that affect available features:

PackageFeaturesLimitations
Free TierBasic voice, limited minutesLimited concurrent calls, limited features
BusinessFull voice features, more minutesHigher limits
EnterpriseCustom quotas, dedicated supportCustom pricing

To check your current package:

  1. In the Cloudonix Portal, go to Billing or Subscription
  2. View your current plan details

Package Impact on OPBX​

Some OPBX features may be limited based on your Cloudonix package:

  • IVR Menus: Voice selection options may be limited on Free Tier
  • Recording: Storage limits apply
  • Concurrent Calls: Number of simultaneous calls restricted

Check the Cloudonix pricing page for current feature comparisons.

Required Permissions​

Ensure your Cloudonix account has the following permissions for OPBX to work correctly:

API Permissions​

  • domain:read - Required
  • voiceapplication:read - Required
  • voiceapplication:write - Required
  • subscriber:read - Required
  • subscriber:write - Required
  • cdr:read - Required (for call logs)

Webhook Permissions​

Your voice application needs permission to send webhooks to OPBX.

Verification Checklist​

Before proceeding to OPBX configuration, verify you have:

  • Cloudonix account created and verified
  • Domain UUID copied and stored safely
  • Domain API Key generated and stored safely
  • (Optional) Requests API Key generated and stored safely
  • Cloudonix package/tier confirmed
  • Required API permissions enabled

Next Steps​

Now that you have your Cloudonix credentials, proceed to OPBX Configuration to enter these values in the OPBX Settings page.

Related Documentation: