https://wiki.7kas.com/index.php?action=history&feed=atom&title=TuCloudAPI_requestpbxemailTuCloudAPI requestpbxemail - Revision history2026-11-07T03:14:14ZRevision history for this page on the wikiMediaWiki 1.43.9https://wiki.7kas.com/index.php?title=TuCloudAPI_requestpbxemail&diff=1276&oldid=prevMaintenance script: TuCloudAPI reference (generated from func=help): PBX master email2026-11-03T11:06:40Z<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 />
Ask to change this PBX's MASTER EMAIL (tucloud_pbx.email: the administrator's magic-link and password login). The new address is checked (normalized trim + lower-case; refusals with field email and reason required | format | too_long | same | taken | rate_limited, 3 per PBX per hour) and a magic link is mailed to it; the change is applied by the SERVER when that link is opened, within 5 minutes, whether or not the caller is still asking, and the OLD address then gets an informational notice. One pending change per PBX: a new request supersedes the previous one. Follow it with getpbxemailchange. Session: the PBX administrator only (kind pbx); ukey: the own-account binding, non-readonly. The email is never written any other way.<br />
<br />
== Call ==<br />
https://tucloudapi.7kas.com:9087/tucloud?func=requestpbxemail&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>email</code> || string || Yes || — || The new master email (max 128).<br />
|}<br />
== Example ==<br />
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=requestpbxemail&ukey=KEY&pbx=tucall&email=admin@example.com</nowiki><br />
<br />
== Response ==<br />
{ok:true, status:"pending", email, expires_in} | {ok:false, code, field:"email", reason, 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