TuCloudAPI requestpbxemail
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
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.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=requestpbxemail&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. |
email |
string | Yes | — | The new master email (max 128). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=requestpbxemail&ukey=KEY&pbx=tucall&email=admin@example.com
Response
{ok:true, status:"pending", email, expires_in} | {ok:false, code, field:"email", reason, message}.
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