TuCloudAPI getdashboard
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
Landing-page dashboard: per-tenant object counts + a cheap health metric, in one call. A normal pbx-bound read (no admin gate); returns only tenant-scoped counts (no ACL/security internals). active_calls is not included (no realtime source on this pool).
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getdashboard&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 verifies the ukey owns this PBX and scopes every count to it. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getdashboard&ukey=KEY&pbx=tucall
Response
{ok, counts:{extensions,clis,routes,groups,queues,locutions,music,schedules,calendar,contacts,blacklist,outgoing,phonebooks,tasks}, health:{online_extensions,total_extensions}}.
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