TuCloudAPI getpbxconfig
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
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). email is the MASTER EMAIL (the administrator's magic-link and password login; "" when the PBX has none: NULL, empty and blanks alike), read-only here: it changes only through requestpbxemail. email_change is null or {email, expires_in} while a change waits for its link; email_pending is that address, or "".
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&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. |
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,email,email_change,email_pending}, editable:[password,nota,admin_ext_id]}.
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