https://wiki.7kas.com/index.php?action=history&feed=atom&title=TuCloudAPI_setextpasswordTuCloudAPI setextpassword - Revision history2026-11-07T01:23:47ZRevision history for this page on the wikiMediaWiki 1.43.9https://wiki.7kas.com/index.php?title=TuCloudAPI_setextpassword&diff=1198&oldid=prevMaintenance script: TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes2026-10-08T21:17:01Z<p>TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes</p>
<p><b>New page</b></p><div>''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''<br />
<br />
{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}<br />
<br />
== Description ==<br />
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.<br />
<br />
== Call ==<br />
https://tucloudapi.7kas.com:9087/tucloud?func=setextpassword&ukey=YOUR_KEY&pbx=PBX_NAME<br />
GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.<br />
<br />
== Parameters ==<br />
{| class="wikitable sortable"<br />
! Parameter !! Type !! Required !! Default !! Meaning<br />
|-<br />
| <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.<br />
|-<br />
| <code>id</code> || integer || Yes || — || Extension id (_id).<br />
|-<br />
| <code>password</code> || string || No || — || New SIP password (max 32). Blank = generate one server-side.<br />
|}<br />
== Example ==<br />
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=setextpassword&ukey=KEY&pbx=tucall&id=87365</nowiki><br />
<br />
== Response ==<br />
{ok, password:"..."} or {ok:false,not_found} / {ok:false,not_registrable}.<br />
<br />
== Errors ==<br />
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.<br />
<br />
----<br />
Back to [[TuCloudAPI]]<br />
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]</div>Maintenance script