TuCloudAPI getdashboard: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || 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 == | == Example == | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
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
GET https://tucloudapi.7kas.com:9087/tucloud?func=getdashboard&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 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}}.
Back to TuCloudAPI