TuCloudAPI getpbxconfig: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI reference (generated from func=help) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
{{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>.}} | |||
== Description == | == Description == | ||
Get this PBX's settings (single record | Get this PBX's settings (single record, no id needed, tenant from the binding). Returns the read-only identity/provisioning fields plus the editable ones; password is NEVER returned. `editable` lists the field names the caller may write ([] for a read-only ukey). email is the MASTER EMAIL (the administrator's magic-link and password login; "" when the PBX has none: NULL, empty and blanks alike), read-only here: it changes only through requestpbxemail. email_change is null or {email, expires_in} while a change waits for its link; email_pending is that address, or "". | ||
== Call == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&ukey=YOUR_KEY&pbx=PBX_NAME | |||
Requires the <code>ukey</code> parameter. | 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. | ||
== Parameters == | == Parameters == | ||
| Line 12: | Line 14: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <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. | ||
|} | |} | ||
== Example == | == Example == | ||
| Line 18: | Line 20: | ||
== Response == | == Response == | ||
{ok, config:{_id,pbxname,root,accountcode_id,nota,admin_ext_id,maxext,inlimit,domain,teamshost,teamsport,teamsprefix,create_date,firstlogin_date}, editable:[password,nota,admin_ext_id]}. | {ok, config:{_id,pbxname,root,accountcode_id,nota,admin_ext_id,maxext,inlimit,domain,teamshost,teamsport,teamsprefix,create_date,firstlogin_date,email,email_change,email_pending}, editable:[password,nota,admin_ext_id]}. | ||
== Errors == | |||
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. | |||
---- | ---- | ||
Back to [[TuCloudAPI]] | Back to [[TuCloudAPI]] | ||
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | [[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | ||
Latest revision as of 19:28, 3 November 2026
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
Get this PBX's settings (single record, no id needed, tenant from the binding). Returns the read-only identity/provisioning fields plus the editable ones; password is NEVER returned. `editable` lists the field names the caller may write ([] for a read-only ukey). email is the MASTER EMAIL (the administrator's magic-link and password login; "" when the PBX has none: NULL, empty and blanks alike), read-only here: it changes only through requestpbxemail. email_change is null or {email, expires_in} while a change waits for its link; email_pending is that address, or "".
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&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. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getpbxconfig&ukey=KEY&pbx=tucall
Response
{ok, config:{_id,pbxname,root,accountcode_id,nota,admin_ext_id,maxext,inlimit,domain,teamshost,teamsport,teamsprefix,create_date,firstlogin_date,email,email_change,email_pending}, editable:[password,nota,admin_ext_id]}.
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