TuCloudAPI getcalendars: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI calendar: Repetir cada año (hold) and expires_on |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}} | |||
== 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 == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=getcalendars&ukey=YOUR_KEY&pbx=PBX_NAME | |||
Requires the <code>ukey</code> parameter. | GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope. | ||
== Parameters == | == Parameters == | ||
| Line 12: | Line 14: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. | ||
|- | |- | ||
| <code>template</code> || integer || No || — || Filter to one calendar-template group (omit for all). | | <code>template</code> || integer || No || — || Filter to one calendar-template group (omit for all). | ||
| Line 22: | 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 == | |||
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function. | |||
---- | ---- | ||
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]] | ||
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
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