TuCloudAPI updatepbxconfig: Difference between revisions
Appearance
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. | ||
|- | |- | ||
| <code>password</code> || string || No || — || New super-user Clave (blank = keep). Plaintext, 8-32, [a-zA-Z0-9.!$*#-_]. | | <code>password</code> || string || No || — || New super-user Clave (blank = keep). Plaintext, 8-32, [a-zA-Z0-9.!$*#-_]. | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Update this PBX's settings (strict set). password is the PBX super-user Clave: PLAINTEXT (never md5), min 8 / max 32, charset [a-zA-Z0-9 . ! $ * # - _]; blank/omitted = keep the existing one. nota max 256. admin_ext_id = a tucloud_pbx_ext id in THIS pbx (0/blank = none; bad_ext if not in-tenant). Identity/provisioning fields are read-only and cannot be set here. Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=updatepbxconfig&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. |
password |
string | No | — | New super-user Clave (blank = keep). Plaintext, 8-32, [a-zA-Z0-9.!$*#-_]. |
nota |
string | No | — | Free note (max 256). |
admin_ext_id |
integer | No | 0 |
Designated admin extension id (0 = none; must be in this PBX). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=updatepbxconfig&ukey=KEY&pbx=tucall¬a=Centralita&admin_ext_id=1234
Response
{ok, config:{...}} or {ok:false,code:invalid_param|bad_ext|forbidden}.
Back to TuCloudAPI