TuCloudAPI addqueue - Revision history

Maintenance script: TuCloudAPI reference (generated from func=help): field+reason, 700-703 reserved

2026-11-02T10:18:11Z

TuCloudAPI reference (generated from func=help): field+reason, 700-703 reserved

← Older revision		Revision as of 10:18, 2 November 2026
Line 4:		Line 4:

	== Description ==		== Description ==
	Create a call queue. title required (free-form, repeatable across PBXs). exten = the queue's direct-dial number: user-entered, EXACTLY 3 digits, no leading 0, not reserved (112), must be free; every refusal carries field:"exten", reason and message (invalid_exten: format \| reserved; conflict: queue \| extension \| full); 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/ringinuse are 0/1; ringinuse defaults to 0 (a busy agent is not rung; German 2026-10-31). 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, no leading 0, not reserved (112, 700-703), must be free; every refusal carries field:"exten", reason and message (invalid_exten: format \| reserved; conflict: queue \| extension \| full); 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/ringinuse are 0/1; ringinuse defaults to 0 (a busy agent is not rung; German 2026-10-31). Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).

	== Call ==		== Call ==
Line 18:		Line 18:
	\| <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, no leading 0, not 112, free; blank = auto next-free.		\| <code>exten</code> \|\| string \|\| No \|\| — \|\| Queue direct-dial number: exactly 3 digits, no leading 0, not 112 or 700-703, 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: TuCloudAPI reference (generated from func=help): checkextnum, extension numbers

2026-11-02T09:45:06Z

TuCloudAPI reference (generated from func=help): checkextnum, extension numbers

← Older revision		Revision as of 09:45, 2 November 2026
Line 4:		Line 4:

	== Description ==		== Description ==
	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/ringinuse are 0/1; ringinuse defaults to 0 (a busy agent is not rung; German 2026-10-31). 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, no leading 0, not reserved (112), must be free; every refusal carries field:"exten", reason and message (invalid_exten: format \| reserved; conflict: queue \| extension \| full); 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/ringinuse are 0/1; ringinuse defaults to 0 (a busy agent is not rung; German 2026-10-31). Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).

	== Call ==		== Call ==
Line 18:		Line 18:
	\| <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>exten</code> \|\| string \|\| No \|\| — \|\| Queue direct-dial number: exactly 3 digits, no leading 0, not 112, 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: TuCloudAPI reference (generated from func=help; ringinuse 2026-10-31)

2026-10-31T11:47:52Z

TuCloudAPI reference (generated from func=help; ringinuse 2026-10-31)

← Older revision		Revision as of 11:47, 31 October 2026
Line 4:		Line 4:

	== Description ==		== Description ==
	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).		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/ringinuse are 0/1; ringinuse defaults to 0 (a busy agent is not rung; German 2026-10-31). Requires a non-readonly ukey. Agents are managed via #36 (voip_queue_member).

	== Call ==		== Call ==
Line 33:		Line 33:
	\|-		\|-
	\| <code>leavewhenempty</code> \|\| integer \|\| No \|\| <code>0</code> \|\| 1 = drop callers when queue empties, 0 = no.		\| <code>leavewhenempty</code> \|\| integer \|\| No \|\| <code>0</code> \|\| 1 = drop callers when queue empties, 0 = no.
			\|-
			\| <code>ringinuse</code> \|\| integer \|\| No \|\| <code>0</code> \|\| 1 = ring agents who are already on a call, 0 = skip them: an agent on a call, ringing or on hold is not rung and the queue tries the next free agent (device state per SIP account; wrapuptime still applies). Default 0 by German's order 2026-10-31.
	\|-		\|-
	\| <code>music</code> \|\| integer \|\| No \|\| <code>0</code> \|\| Music-on-hold: tucloud_pbx_music id (0 = default).		\| <code>music</code> \|\| integer \|\| No \|\| <code>0</code> \|\| Music-on-hold: tucloud_pbx_music id (0 = default).

Maintenance script: TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes

2026-10-08T21:16:22Z

TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes

← Older revision		Revision as of 21:16, 8 October 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

			{{Note\|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

	== Description ==		== Description ==
Line 5:		Line 7:

	== Call ==		== Call ==
	~~GET~~ https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&ukey=YOUR_KEY		https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&ukey=YOUR_KEY&pbx=PBX_NAME
	Requires the <code>ukey</code> parameter.		GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.

	== Parameters ==		== Parameters ==
Line 38:		Line 40:
	\| <code>servicelevel</code> \|\| integer \|\| No \|\| <code>0</code> \|\| Service-level target (seconds).		\| <code>servicelevel</code> \|\| integer \|\| No \|\| <code>0</code> \|\| Service-level target (seconds).
	\|-		\|-
	\| <code>desvio</code> \|\| string \|\| No \|\| — \|\| ~~Timeout~~-forward ~~destination~~ (~~digits~~/*/#).		\| <code>desvio</code> \|\| string \|\| No \|\| — \|\| NOT IMPLEMENTED — must be empty. A non-empty value is REJECTED with invalid_param: the engine does not perform queue forward-on-timeout (tucloud_apps.c has a TODO and merely LOGS a forward it never makes), so storing a value would be a silent no-op. Empty/absent is accepted so existing rows can be cleared. Ruling by gabpbx 2026-08-17; implementation is bus task 102.
	\|}		\|}
	== Example ==		== Example ==
Line 45:		Line 47:
	== Response ==		== Response ==
	{ok, queue:{...}}.		{ok, queue:{...}}.

			== Errors ==
			Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.

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

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]]