Jump to content

TuCloudAPI updatequeue: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig
 
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help
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 ==
Edit a queue's config. title editable; the realtime name is read-only (server-owned). 404 if not in the caller's PBX. Requires a non-readonly ukey.
Edit a queue's config. title + config editable; the realtime name is read-only (trigger-owned) and exten is IMMUTABLE — submitting a differing exten returns exten_immutable (omit it to edit the rest). 404 if not in the caller's PBX. Requires a non-readonly ukey.


== Call ==
== Call ==
Line 17: Line 17:
|-
|-
| <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 || — || Immutable; omit. If sent it must equal the stored exten, else exten_immutable.
|-
|-
| <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.

Revision as of 14:14, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Edit a queue's config. title + config editable; the realtime name is read-only (trigger-owned) and exten is IMMUTABLE — submitting a differing exten returns exten_immutable (omit it to edit the rest). 404 if not in the caller's PBX. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=updatequeue&ukey=YOUR_KEY

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
id integer Yes Queue id (_id).
title string Yes Queue display title (required, max 30).
exten string No Immutable; omit. If sent it must equal the stored exten, else exten_immutable.
strategy string No ringall ringall / leastrecent / fewestcalls / roundrobin / random.
timeout integer No 15 Ring timeout (seconds).
retry integer No 5 Retry delay (seconds).
wrapuptime integer No 0 Wrap-up time (seconds).
maxlen integer No 0 Max callers (0 = unlimited).
joinempty integer No 1 1 = allow join when empty.
leavewhenempty integer No 0 1 = drop when empties.
music integer No 0 MOH music id (0 = default).
weight integer No 0 Queue weight.
servicelevel integer No 0 Service-level target (seconds).
desvio string No Timeout-forward destination.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updatequeue&ukey=KEY&pbx=tucall&id=1001&title=Soporte

Response

{ok, queue:{...}}.


Back to TuCloudAPI