TuCloudAPI getappsrecords: Difference between revisions

Latest revision as of 14:31, 3 August 2026

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

ℹ Requires the pbx parameter (the PBX name, e.g. tucall). The server verifies your ukey owns that PBX; otherwise it returns {"ok":false,"code":"forbidden"}.

Description

List this PBX's selectable records for an app (the record picker), via the tenant-scoped lookup function.

Call

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

Requires the ukey parameter. Always HTTP 200; 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.
`app_id`	integer	Yes	—	App id (from getapps).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getappsrecords&ukey=KEY&pbx=tucall&app_id=1

Response

{ok, records:[{value,label}]}.

Errors

Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Codes: missing_pbx, unknown_pbx, forbidden, invalid_param, not_found, db_error, server_busy.

Back to TuCloudAPI

@@ Line 14: / Line 14: @@
 ! 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>app_id</code> || integer || Yes || — || App id (from getapps).