TuCloudAPI getcalendars: Difference between revisions
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
TuCloudAPI calendar: Repetir cada año (hold) and expires_on |
||
| Line 4: | Line 4: | ||
== Description == | == 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). | 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. hold = «Repetir cada año» 1/0; expires_on = for hold 0, the ISO date (YYYY-MM-DD) of the last day it applies (the day after, the row is deleted), null for hold 1. Tenant from (ukey, pbx). | ||
== Call == | == Call == | ||
| Line 24: | Line 24: | ||
== Response == | == Response == | ||
{ok, rows:[{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,nota}]}. | {ok, rows:[{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,expires_on,nota}]}. | ||
== Errors == | == Errors == | ||
Latest revision as of 13:29, 5 November 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.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. hold = «Repetir cada año» 1/0; expires_on = for hold 0, the ISO date (YYYY-MM-DD) of the last day it applies (the day after, the row is deleted), null for hold 1. Tenant from (ukey, pbx).
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getcalendars&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
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,expires_on,nota}]}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI