Jump to content

TuCloudAPI getroutelookups

From Wiki 7Kas

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