TuCloudAPI addschedule
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
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
https://tucloudapi.7kas.com:9087/tucloud?func=addschedule&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. |
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}.
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