FreePBX Middleware API Documentation

Welcome to the API documentation for the FreePBX Middleware system. This API facilitates data ingestion from FreePBX and data consumption for PowerBI.

Authentication

This API acts as a secure middleware and requires a Bearer Token for all requests. This ensures that only authorized services (FreePBX, PowerBI) can access the data.

How to Authenticate

You must include the Authorization header in every HTTP request with your secret token.

Note: The token is generated securely by the system administrator and is not publicly available. If you lose your token, please contact the administrator to generate a new one from the server environment.

Rate Limiting & Usage Guidelines

To ensure system stability, the API enforces the following limits:

• Limit: 500 requests per 15 minutes per IP address.
• Response: If you exceed this limit, you will receive a 429 Too Many Requests response.

PowerBI Best Practices

• Pagination: Use the limit and offset parameters to fetch data in chunks (e.g., 1000 records at a time) rather than requesting the entire database at once.
• Incremental Refresh: Use created_after to fetch only new records since your last refresh. This is significantly faster and reduces load.
• Error Handling: Configure PowerBI to handle 429 errors by waiting a few minutes before retrying.

Endpoints

[
  {
    "call_id": "1769504531.76688",
    "caller_id": "0946955993",
    "timestamp": "2026-01-27 11:02:29",
    "selections": [
      {
        "sequence": 1,
        "stage": "City-Tripoli",
        "dtmf": "1",
        "timestamp": "2026-01-27 11:02:29"
      }
    ]
  }
]

[
  {
    "call_id": "1769504531.76688",
    "caller_id": "0946955993",
    "call_timestamp": "2026-01-27T11:02:29.000Z",
    "selection_sequence": 1,
    "selection_stage": "City-Tripoli",
    "selection_dtmf": "1",
    "selection_timestamp": "2026-01-27T11:02:29.000Z"
  }
]

{
  "ingestion_enabled": true,
  "consumption_enabled": true
}

{
  "ingestion_enabled": false
}

{
  "ingestion_enabled": true,
  "consumption_enabled": true
}