Jump to content

TuCloudAPI getqueues: Difference between revisions

From Wiki 7Kas
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 tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''
''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 || — || 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>q</code> || string || No || — || Optional title search (contains).
| <code>q</code> || string || No || — || Optional title search (contains).
Line 20: Line 20:


== Response ==
== Response ==
{ok, rows:[{_id,title,name,strategy,member_count}]}.
{ok, rows:[{_id,title,name,exten,strategy,member_count}]}.


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

List the PBX call queues (ACD) with member counts. Tenant from (ukey, pbx).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getqueues&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.
q string No Optional title search (contains).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getqueues&ukey=KEY&pbx=tucall

Response

{ok, rows:[{_id,title,name,exten,strategy,member_count}]}.


Back to TuCloudAPI