TuCloudAPI getgroup
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.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
https://tucloudapi.7kas.com:9087/tucloud?func=getgroup&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the 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. |
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,translator_langs,translator_lang,translator_mode}}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI