Jump to content

TuCloudAPI updateschedule

From Wiki 7Kas

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

Edit a schedule (template/name/grid). Full-form save: send every cell (blank clears it). 404 if not in the caller's PBX. Requires a non-readonly ukey.

Call

https://tucloudapi.7kas.com:9087/tucloud?func=updateschedule&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 — Schedule id (_id).
name string Yes — Display name (required, max 32).
template integer No 0 Schedule number 1-99 (0 = keep current).
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=updateschedule&ukey=KEY&pbx=tucall&id=241&name=Verano

Response

{ok, schedule:{...}}.

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