Jump to content

TuCloudAPI getreports

From Wiki 7Kas
Revision as of 14:31, 3 August 2026 by Maintenance script (talk | contribs) (TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

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

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getreports&ukey=YOUR_KEY

Requires the ukey parameter.

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}.


Back to TuCloudAPI