TuCloudAPI getpbxconfig: 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. | ||
|} | |} | ||
== 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
Get this PBX's settings (single record ? no id needed, tenant from the binding). Returns the read-only identity/provisioning fields plus the editable ones; password is NEVER returned. `editable` lists the field names the caller may write ([] for a read-only ukey).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&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. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&ukey=KEY&pbx=tucall
Response
{ok, config:{_id,pbxname,root,accountcode_id,nota,admin_ext_id,maxext,inlimit,domain,teamshost,teamsport,teamsprefix,create_date,firstlogin_date}, editable:[password,nota,admin_ext_id]}.
Back to TuCloudAPI