https://wiki.7kas.com/index.php?action=history&feed=atom&title=TuCloudAPI_getpbxemailchangeTuCloudAPI getpbxemailchange - Revision history2026-11-07T01:24:16ZRevision history for this page on the wikiMediaWiki 1.43.9https://wiki.7kas.com/index.php?title=TuCloudAPI_getpbxemailchange&diff=1275&oldid=prevMaintenance script: TuCloudAPI reference (generated from func=help): PBX master email2026-11-03T11:06:30Z<p>TuCloudAPI reference (generated from func=help): PBX master email</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 />
Status of this PBX's latest master-email change, from tucloudapi's own state (never magiclogin): none | pending (email, expires_in) | done (email, notice: sent|failed|skipped, the informational mail to the old address) | expired | failed (reason taken|error) | cancelled, each with its Spanish message. A final status is shown for 10 minutes. Poll it every 2 s while a dialog is open.<br />
<br />
== Call ==<br />
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxemailchange&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 />
== Example ==<br />
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getpbxemailchange&ukey=KEY&pbx=tucall</nowiki><br />
<br />
== Response ==<br />
{ok, status, email?, expires_in?, reason?, notice?, message?}.<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