Jump to content

TuCloudAPI getgrouplookups: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig
 
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''
''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''


== Description ==
== Description ==
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.
|}
|}
== Example ==
== Example ==

Latest revision as of 14:31, 3 August 2026

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

Description

Tenant-scoped pickers: extensions (members), music (MOH), and CLIs (for the admin forward caller-id).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getgrouplookups&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.

Example

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

Response

{ok, extensions:[{_id,num,label}], music:[{_id,label}], clis:[{_id,label}]}.


Back to TuCloudAPI