TuCloudAPI getgroup
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Get one group. Each slot's members are resolved to {_id,num,name} arrays (members1..5). 404-style not_found if not in the caller's PBX.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getgroup&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 | — | Group id (_id). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getgroup&ukey=KEY&pbx=tucall&id=927
Response
{ok, group:{_id,gr,name,members1..5:[{_id,num,name}],ringing1..5,music,music_name,tom,fwd,fwdnum,fwd_internal,fwdnum_internal,fwd_cli_id,fwd_cli_label,fwdshowcaller}}.
Back to TuCloudAPI