TuCloudAPI addqueue - Revision history

Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

2026-08-03T14:30:55Z

TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

← Older revision		Revision as of 14:30, 3 August 2026
Line 12:		Line 12:
	! Parameter !! Type !! Required !! Default !! Meaning		! Parameter !! Type !! Required !! Default !! Meaning
	\|-		\|-
	\| <code>pbx</code> \|\| string \|\| Yes \|\| — \|\| ~~TuCloud PBX~~ NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.		\| <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>title</code> \|\| string \|\| Yes \|\| — \|\| Queue display title (required, max 30).		\| <code>title</code> \|\| string \|\| Yes \|\| — \|\| Queue display title (required, max 30).

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

2026-08-03T14:13:56Z

TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

← Older revision		Revision as of 14:13, 3 August 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage ~~tucloud~~ (PBX) ~~services~~. Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

	== Description ==		== Description ==
	Create a call queue. title required. The realtime name (<pbxname>~~_<id>~~) is ~~server-generated (not~~ client-editable). music = a tucloud_pbx_music id (0 = none) resolved to the MOH class. joinempty/leavewhenempty are 0/1. Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).		Create a call queue. title required (free-form, repeatable across PBXs). exten = the queue's direct-dial number: user-entered, EXACTLY 3 digits, must be free (invalid_exten / exten_taken); blank = auto next-free. The globally-unique realtime name is composed by a DB trigger as root_<pbxname>_exten (e.g. 0_tucall_901) — the app never sets it and it is never client-editable. music = a tucloud_pbx_music id (0 = none) resolved to the MOH class. joinempty/leavewhenempty are 0/1. Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).

	== Call ==		== Call ==
Line 15:		Line 15:
	\|-		\|-
	\| <code>title</code> \|\| string \|\| Yes \|\| — \|\| Queue display title (required, max 30).		\| <code>title</code> \|\| string \|\| Yes \|\| — \|\| Queue display title (required, max 30).
			\|-
			\| <code>exten</code> \|\| string \|\| No \|\| — \|\| Queue direct-dial number: exactly 3 digits, free; blank = auto next-free.
	\|-		\|-
	\| <code>strategy</code> \|\| string \|\| No \|\| <code>ringall</code> \|\| ringall / leastrecent / fewestcalls / roundrobin / random.		\| <code>strategy</code> \|\| string \|\| No \|\| <code>ringall</code> \|\| ringall / leastrecent / fewestcalls / roundrobin / random.

Maintenance script: API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig

2026-08-02T04:37:54Z

API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig

New page

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

== Description ==
Create a call queue. title required. The realtime name (<pbxname>_<id>) is server-generated (not client-editable). music = a tucloud_pbx_music id (0 = none) resolved to the MOH class. joinempty/leavewhenempty are 0/1. Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).

== Call ==
GET https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>title</code> || string || Yes || — || Queue display title (required, max 30).
|-
| <code>strategy</code> || string || No || <code>ringall</code> || ringall / leastrecent / fewestcalls / roundrobin / random.
|-
| <code>timeout</code> || integer || No || <code>15</code> || Ring timeout per member (seconds).
|-
| <code>retry</code> || integer || No || <code>5</code> || Retry delay (seconds).
|-
| <code>wrapuptime</code> || integer || No || <code>0</code> || Wrap-up time after a call (seconds).
|-
| <code>maxlen</code> || integer || No || <code>0</code> || Max callers waiting (0 = unlimited).
|-
| <code>joinempty</code> || integer || No || <code>1</code> || 1 = allow join when no agents, 0 = no.
|-
| <code>leavewhenempty</code> || integer || No || <code>0</code> || 1 = drop callers when queue empties, 0 = no.
|-
| <code>music</code> || integer || No || <code>0</code> || Music-on-hold: tucloud_pbx_music id (0 = default).
|-
| <code>weight</code> || integer || No || <code>0</code> || Queue weight/priority.
|-
| <code>servicelevel</code> || integer || No || <code>0</code> || Service-level target (seconds).
|-
| <code>desvio</code> || string || No || — || Timeout-forward destination (digits/*/#).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&ukey=KEY&pbx=tucall&title=Soporte&strategy=leastrecent</nowiki>

== Response ==
{ok, queue:{...}}.

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