TuCloudAPI getextpassword
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
Plaintext SIP password for ONE extension (the portal's «Clave SIP» eye toggle). Separate from getextension ON PURPOSE: that endpoint is legitimately readable by a limited user for their own extension, so carrying the secret there would expose every extension's password to every user in the tenant. GATING IS NOT PERFORMED HERE AND CANNOT BE: this layer only sees (ukey, pbx) because the portal proxy injects one shared tenant ukey per PBX, so it cannot distinguish an admin from a limited user. Admin-gating lives in the calling proxy (same requires_admin flag as getextqr). Tenant scoping IS enforced: the extension must belong to (ukey, pbx). Send-to (TOEXT) extensions have no registrable account -> {ok:false,not_registrable}. Note this is the same secret getextqr already returns — that one only draws it into a QR bitmap, which any camera decodes, so this changes the format of an exposure, not its reach.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getextpassword&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). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getextpassword&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