Jump to content

TuCloudAPI getextqr: Difference between revisions

From Wiki 7Kas
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)
 
Line 12: Line 12:
! Parameter !! Type !! Required !! Default !! Meaning
! Parameter !! Type !! Required !! Default !! Meaning
|-
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
| <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.
|-
|-
| <code>id</code> || integer || Yes || — || Extension id (_id).
| <code>id</code> || integer || Yes || — || Extension id (_id).

Latest revision as of 14:31, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

SIP provisioning QR for one extension, rendered server-side to a PNG (base64). The SIP password is embedded ONLY inside the QR bitmap — it is never returned as plaintext JSON. transport/proxy are resolved server-side from the authoritative SIP config. Send-to (TOEXT) extensions have no registrable account -> {ok:false,not_registrable}.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getextqr&ukey=YOUR_KEY

Requires the ukey parameter.

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.
id integer Yes Extension id (_id).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getextqr&ukey=KEY&pbx=tucall&id=87365

Response

{ok, png:"<base64 PNG>", sipaccounts:[{sipusername,transport,subdomain?}]} (no password in JSON).


Back to TuCloudAPI