White-Label Reseller API (V2)

List All Customers

Retrieve a paginated list of all your active customers/tenants.

Response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "company_name": "Acme Corp",
      "domain": "acme.epbx.bd"
    }
  ]
}

Create Customer

Create a new Tenant (Customer) in the system and automatically provision their PBX environment.

Parameters

Request Body Example

{
    "company_name": "Example Corp",
    "email": "admin@example.com",
    "package_id": 1
}

Suspend/Unsuspend Customer

Change the operational status of a customer's PBX tenant. Suspended tenants cannot make or receive calls.

Parameters (JSON)

Submit KYC

Upload KYC documents and information for a customer. Use multipart/form-data for this request.

Form Data (multipart/form-data)

NID Number: 1234567890 (Text)
NID Front: nid_front.jpg (File)
Trade License: trade_license.pdf (File)
Address: 123 Main St (Text)

List Extensions

Retrieve all PBX extensions associated with a specific customer.

Create Extension

Provision a new SIP extension for the customer. SIP and WebRTC softphone profiles are configured automatically behind the scenes.

Parameters

Request Body Example

{
    "extension": "105",
    "password": "SecurePassword123",
    "is_webrtc": true
}

Response (if is_webrtc = true)

{
  "status": "success",
  "data": {
    "extension": "105",
    "password": "SecurePassword123",
    "webrtc": {
      "username": "105_webrtc",
      "password": "SecurePassword123",
      "domain": "pbx.yourdomain.com",
      "wss_server": "wss://pbx.yourdomain.com:8089/ws"
    }
  }
}

Update Extension

Update the SIP password of an existing extension.

Parameters (JSON)

Delete Extension

Permanently remove an extension from a customer's PBX. This action unregisters the device immediately.

Request Custom Number

Submit an order for a custom DID Number or SIP Trunk based on the selected provider. You can specify your preferred digits (e.g., the last 6 digits of the phone number). Once approved by the administrator, the trunk will be automatically assigned to the customer.

Parameters

Request Body Example

{
    "preferred_digits": "096",
    "provider_id": 1,
    "requested_channels": 2,
    "notes": "Need this number for outbound call center."
}

Create IVR (Auto Attendant)

Programmatically configure Interactive Voice Response (IVR) menus for the customer. Upload custom greeting audio and define key-press routing logic.

Parameters

Request Body Example

{
    "name": "Main Menu",
    "greeting_audio": "(binary file data)",
    "routes": [
        {"digit": "1", "destination_type": "extension", "destination_id": "101"},
        {"digit": "2", "destination_type": "queue", "destination_id": "200"}
    ]
}

Create Inbound Route

Define how incoming calls to a specific DID number should be routed within the customer's PBX.

Parameters

Create Outbound Route

Configure dialing rules and match patterns to determine which SIP Trunk should be used for outgoing calls.

Parameters

Create Time Schedule (Business Hours)

Set up business hours to route calls dynamically. For example, route to IVR during working hours, and Voicemail after hours.

Parameters

Configure SIP Trunk

Add a third-party SIP Trunk directly to the customer's PBX profile. The system will automatically construct the registration string and connect to the provider instantly.

Parameters

Call Data Records (CDR)

Retrieve paginated call history and billing records for a specific customer. Essential for custom billing dashboards.

Query Parameters

Click-to-Call (Originate)

Trigger a call from your CRM. The system will first ring the agent's extension, and upon answering, it will dial the customer's phone number.

Parameters (JSON)

Wallet Balance

Retrieve your current Reseller Wallet balance programmatically.

Wallet Top-up

Transfer funds from your Reseller Wallet to a customer, or deduct funds from a customer. This automatically creates ledger entries.

Parameters

Request Body Example

{
    "amount": 500.00,
    "action": "add" // Use "add" to top-up, "deduct" to remove funds
}

Ping (Health Check)

Verify your API Token validity and White Label permissions.