Jump to content

TuCloudAPI addschedule: Difference between revisions

From Wiki 7Kas
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)
 
Line 12: Line 12:
! Parameter !! Type !! Required !! Default !! Meaning
! Parameter !! Type !! Required !! Default !! Meaning
|-
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
| <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>name</code> || string || Yes || — || Display name (required, max 32).
| <code>name</code> || string || Yes || — || Display name (required, max 32).

Latest revision as of 14:30, 3 August 2026

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

Description

Create a weekly schedule. template (the per-tenant schedule number, UNIQUE) auto-assigns to max+1 when 0. Send the grid as the "slots" JSON string (POST body). Server derives root. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addschedule&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.
name string Yes Display name (required, max 32).
template integer No 0 Schedule number 1-99 (0 = auto max+1). Unique per PBX.
slots string No {} JSON object string of the weekly grid: keys {day}{N} (day = monday..sunday, N = 0..11 = slot A..L), value = HH:MM (the start time slot N becomes active that weekday) or blank = unused. Sent as a POST body field.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addschedule&ukey=KEY&pbx=tucall&name=Verano

Response

{ok, schedule:{...}} or {ok:false,conflict}.


Back to TuCloudAPI