Jump to content

TuCloudAPI getcalendars

From Wiki 7Kas
Revision as of 14:31, 3 August 2026 by Maintenance script (talk | contribs) (TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Description

List the PBX calendar date-overrides (one row = one recurring month/day + time window that reroutes inbound to a route for CLIs on that template). Optional template filter. Tenant from (ukey, pbx).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getcalendars&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.
template integer No Filter to one calendar-template group (omit for all).
q string No Optional nota search (contains).

Example

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

Response

{ok, rows:[{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,nota}]}.


Back to TuCloudAPI