TuCloudAPI getcalendar: 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 22: | Line 22: | ||
== Response == | == Response == | ||
{ok, calendar:{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,nota}}. | {ok, calendar:{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,expires_on,nota}}. expires_on: as in getcalendars. | ||
== Errors == | == Errors == | ||
Latest revision as of 13:29, 5 November 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
ℹ Requires the
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
Get one calendar row. 404-style not_found if not in the caller's PBX.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getcalendar&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. |
id |
integer | Yes | — | Calendar row id (_id). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getcalendar&ukey=KEY&pbx=tucall&id=81522
Response
{ok, calendar:{_id,template,monthstart,daystart,monthend,dayend,timestart,timeend,destination,destination_name,hold,expires_on,nota}}. expires_on: as in getcalendars.
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