Jump to content

TuCloudAPI getgroups

From Wiki 7Kas
Revision as of 04:38, 2 August 2026 by Maintenance script (talk | contribs) (API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.

Description

List the PBX ring/hunt groups with a member count. Tenant from (ukey, pbx).

Call

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

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
q string No Optional name/number search (contains).

Example

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

Response

{ok, rows:[{_id,gr,name,member_count,music,tom,fwd,fwd_internal}]}.


Back to TuCloudAPI