TuCloudAPI addqueue: Difference between revisions
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 | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
Create a call queue. title required. The realtime name | 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. | ||
Revision as of 14:13, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
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).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&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. |
title |
string | Yes | — | Queue display title (required, max 30). |
exten |
string | No | — | Queue direct-dial number: exactly 3 digits, free; blank = auto next-free. |
strategy |
string | No | ringall |
ringall / leastrecent / fewestcalls / roundrobin / random. |
timeout |
integer | No | 15 |
Ring timeout per member (seconds). |
retry |
integer | No | 5 |
Retry delay (seconds). |
wrapuptime |
integer | No | 0 |
Wrap-up time after a call (seconds). |
maxlen |
integer | No | 0 |
Max callers waiting (0 = unlimited). |
joinempty |
integer | No | 1 |
1 = allow join when no agents, 0 = no. |
leavewhenempty |
integer | No | 0 |
1 = drop callers when queue empties, 0 = no. |
music |
integer | No | 0 |
Music-on-hold: tucloud_pbx_music id (0 = default). |
weight |
integer | No | 0 |
Queue weight/priority. |
servicelevel |
integer | No | 0 |
Service-level target (seconds). |
desvio |
string | No | — | Timeout-forward destination (digits/*/#). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addqueue&ukey=KEY&pbx=tucall&title=Soporte&strategy=leastrecent
Response
{ok, queue:{...}}.
Back to TuCloudAPI