TuCloudAPI addgroup
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Create a ring group. gr (group number, dialed as *6<gr>) auto-assigns to max+1 when 0. Members are stored as extension IDs in exten1..5 (the SIP dial strings are trigger-built — never sent). Unique (pbx,gr) -> conflict. Server derives root. Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addgroup&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. |
name |
string | Yes | — | Display name (required, max 32). |
gr |
integer | No | 0 |
Group number 1-99 (0 = auto max+1). |
exten1 |
string | No | — | Comma-separated extension _id list for this ring slot (members ring simultaneously; slots ring in order 1..5). Each id is validated in-tenant. |
exten2 |
string | No | — | Ring slot 2 members (see exten1). |
exten3 |
string | No | — | Ring slot 3 members. |
exten4 |
string | No | — | Ring slot 4 members. |
exten5 |
string | No | — | Ring slot 5 members. |
ringing1 |
integer | No | 0 |
Slot 1 ring seconds. |
ringing2 |
integer | No | 0 |
Slot 2 ring seconds. |
ringing3 |
integer | No | 0 |
Slot 3 ring seconds. |
ringing4 |
integer | No | 0 |
Slot 4 ring seconds. |
ringing5 |
integer | No | 0 |
Slot 5 ring seconds. |
music |
integer | No | 0 |
Music-on-hold id (0 = none). |
tom |
integer | No | 0 |
0 = ringback tone while ringing, 1 = music. |
fwd |
integer | No | 0 |
External forward: 0=off,1=uncond,2=busy,3=noanswer,4=both. |
fwdnum |
string | No | — | External forward destination (ext num, *6YY, or PSTN). |
fwd_internal |
integer | No | 0 |
Internal forward mode 0-4. |
fwdnum_internal |
string | No | — | Internal forward destination. |
fwd_cli_id |
integer | No | 0 |
Admin: caller-id (cli _id) for PSTN forward (0 = none). |
fwdshowcaller |
integer | No | 1 |
Admin: 1 = preserve caller CLI, 0 = rewrite. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addgroup&ukey=KEY&pbx=tucall&name=Ventas&exten1=90671,90672&ringing1=25
Response
{ok, group:{...}} or {ok:false,conflict}.
Back to TuCloudAPI