TuCloudAPI getqueue: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| 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). | ||
| Line 20: | Line 20: | ||
== Response == | == Response == | ||
{ok, queue:{_id,title,name,strategy,timeout,retry,wrapuptime,maxlen,joinempty,leavewhenempty,musiconhold,music_id,weight,servicelevel,desvio}}. | {ok, queue:{_id,title,name,exten,strategy,timeout,retry,wrapuptime,maxlen,joinempty,leavewhenempty,musiconhold,music_id,weight,servicelevel,desvio}}. | ||
---- | ---- | ||
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]] | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Get one queue's config. music_id is the tucloud_pbx_music id for the MOH class. 404-style not_found if not in the caller's PBX.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getqueue&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). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getqueue&ukey=KEY&pbx=tucall&id=1001
Response
{ok, queue:{_id,title,name,exten,strategy,timeout,retry,wrapuptime,maxlen,joinempty,leavewhenempty,musiconhold,music_id,weight,servicelevel,desvio}}.
Back to TuCloudAPI