TuCloudAPI updatequeue: Difference between revisions
Appearance
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <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>id</code> || integer || Yes || — || Queue id (_id). | | <code>id</code> || integer || Yes || — || Queue id (_id). | ||
Latest revision as of 14:31, 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 | — | FuturePBX 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