Jump to content

TuCloudAPI getqueuelookups: 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 ==
Tenant-scoped pickers for the queue form: music (MOH classes) and the strategy enum.
Tenant-scoped pickers for the queue form: music (MOH classes), the strategy enum, and next_free (the create-form exten prefill = first free 3-digit queue number, null if 900-999 full).


== Call ==
== Call ==
Line 18: Line 18:


== Response ==
== Response ==
{ok, music:[{_id,label}], strategies:[ringall,leastrecent,fewestcalls,roundrobin,random]}.
{ok, music:[{_id,label}], strategies:[ringall,leastrecent,fewestcalls,roundrobin,random], next_free}.


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

Revision as of 14:14, 3 August 2026

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

Description

Tenant-scoped pickers for the queue form: music (MOH classes), the strategy enum, and next_free (the create-form exten prefill = first free 3-digit queue number, null if 900-999 full).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getqueuelookups&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.

Example

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

Response

{ok, music:[{_id,label}], strategies:[ringall,leastrecent,fewestcalls,roundrobin,random], next_free}.


Back to TuCloudAPI