TuCloudAPI getreports
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Call-volume statistics (Informes / Estadisticas de Llamadas) for a month — VOLUME ONLY, no prices. Aggregated in-process from the CDR metadata (restapi getcdr) for this PBX: totals + per-disposition + per-app (lastapp) + per-day + per-CLI (source number). RAW values (the view maps labels to Spanish + mm:ss). Optional day narrows to one day. Reads up to 100000 rows; truncated=true if the month has more (very large tenants). NOTE: by_direction (callfrom) is not available yet — get_cdr_records_root does not return callfrom (needs a restapi/engine change). READ-ONLY.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getreports&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server resolves this PBX's accountcode and reads only its own CDR via the restapi. |
year |
integer | Yes | — | Year (e.g. 2026). |
month |
integer | Yes | — | Month 1-12. |
day |
integer | No | — | Optional day 1-31 (blank = whole month). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getreports&ukey=KEY&pbx=tucall&year=2026&month=7
Response
{ok, year, month, totals:{calls,duration_s}, by_disposition:[{disposition,calls,duration_s}], by_app:[{app,calls,duration_s}], by_day:[{day,calls,duration_s}], by_cli:[{cli,calls,duration_s}], truncated, cli_truncated}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI