TuCloudAPI getroutelookups: 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 == | ||
Tenant-scoped destination pickers for the step editor: the app enum plus extensions, groups, locutions, schedules, calendars and | Tenant-scoped destination pickers for the step editor: the app enum plus extensions, groups, locutions, schedules, calendars, routes and queues (app=10 "Cola": _id = the stable voip_queue.id stored in the step appdata, label = the queue title). | ||
== Call == | == Call == | ||
| Line 18: | Line 18: | ||
== Response == | == Response == | ||
{ok, apps:[{app,label}], extensions:[{_id,label}], groups:[...], locutions:[...], schedules:[...], calendars:[{template,label}], routes:[{_id,label}]}. | {ok, apps:[{app,label}], extensions:[{_id,label}], groups:[...], locutions:[...], schedules:[...], calendars:[{template,label}], routes:[{_id,label}], queues:[{_id,label}]}. | ||
---- | ---- | ||
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 destination pickers for the step editor: the app enum plus extensions, groups, locutions, schedules, calendars, routes and queues (app=10 "Cola": _id = the stable voip_queue.id stored in the step appdata, label = the queue title).
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getroutelookups&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=getroutelookups&ukey=KEY&pbx=tucall
Response
{ok, apps:[{app,label}], extensions:[{_id,label}], groups:[...], locutions:[...], schedules:[...], calendars:[{template,label}], routes:[{_id,label}], queues:[{_id,label}]}.
Back to TuCloudAPI