View source for 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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <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.
|-
| <code>name</code> || string || Yes || — || Display name (required, max 32).
|-
| <code>gr</code> || integer || No || <code>0</code> || Group number 1-99 (0 = auto max+1).
|-
| <code>exten1</code> || 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.
|-
| <code>exten2</code> || string || No || — || Ring slot 2 members (see exten1).
|-
| <code>exten3</code> || string || No || — || Ring slot 3 members.
|-
| <code>exten4</code> || string || No || — || Ring slot 4 members.
|-
| <code>exten5</code> || string || No || — || Ring slot 5 members.
|-
| <code>ringing1</code> || integer || No || <code>0</code> || Slot 1 ring seconds.
|-
| <code>ringing2</code> || integer || No || <code>0</code> || Slot 2 ring seconds.
|-
| <code>ringing3</code> || integer || No || <code>0</code> || Slot 3 ring seconds.
|-
| <code>ringing4</code> || integer || No || <code>0</code> || Slot 4 ring seconds.
|-
| <code>ringing5</code> || integer || No || <code>0</code> || Slot 5 ring seconds.
|-
| <code>music</code> || integer || No || <code>0</code> || Music-on-hold id (0 = none).
|-
| <code>tom</code> || integer || No || <code>0</code> || 0 = ringback tone while ringing, 1 = music.
|-
| <code>fwd</code> || integer || No || <code>0</code> || External forward: 0=off,1=uncond,2=busy,3=noanswer,4=both.
|-
| <code>fwdnum</code> || string || No || — || External forward destination (ext num, *6YY, or PSTN).
|-
| <code>fwd_internal</code> || integer || No || <code>0</code> || Internal forward mode 0-4.
|-
| <code>fwdnum_internal</code> || string || No || — || Internal forward destination.
|-
| <code>fwd_cli_id</code> || integer || No || <code>0</code> || Admin: caller-id (cli _id) for PSTN forward (0 = none).
|-
| <code>fwdshowcaller</code> || integer || No || <code>1</code> || Admin: 1 = preserve caller CLI, 0 = rewrite.
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addgroup&ukey=KEY&pbx=tucall&name=Ventas&exten1=90671,90672&ringing1=25</nowiki>

== Response ==
{ok, group:{...}} or {ok:false,conflict}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]