TuCloudAPI setextpassword
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
Rotate ONE extension's SIP password. Writes a single column (tucloud_pbx_ext.password); the database trigger propagates it to the SIP peer, so there is no second write and no window in which the two disagree. Blank/absent password = server-generated (10 chars), same as at create. Requires a non-readonly ukey. Send-to (TOEXT) extensions have no registrable account -> {ok:false,not_registrable}. NOT LIVE ON THE DEVICE THE INSTANT THIS RETURNS: the call engine holds the previous credential in its caches until they turn over, and this endpoint does not (and must not) invalidate them. Do NOT tell the user their phone is updated — tell them the password has been changed and the device must re-register with it.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=setextpassword&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. |
id |
integer | Yes | — | Extension id (_id). |
password |
string | No | — | New SIP password (max 32). Blank = generate one server-side. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=setextpassword&ukey=KEY&pbx=tucall&id=87365
Response
{ok, password:"..."} or {ok:false,not_found} / {ok:false,not_registrable}.
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