TuCloudAPI addtask

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 your ukey owns that PBX; otherwise it returns {"ok":false,"code":"forbidden"}.

Description

Create a scheduled task (status forced 0). name required.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addtask&ukey=YOUR_KEY&pbx=PBX_NAME

Requires the ukey parameter. Always HTTP 200; 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	—	Task name (required).
description	string	No	—	Optional description.
time	string	No	00:00	Time of day HH:MM.
second	integer	No	0	Second 0-59 (cron runner).
month	integer	No	0	Month 1-12; 0 = any.
dayofmonth	integer	No	0	Day of month 1-31; 0 = any.
dayofweek	integer	No	0	Day of week 0-6; 7 = any.
hold	integer	No	0	1 = recurring, 0 = one-shot.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addtask&ukey=KEY&pbx=tucall&name=Verano&time=00:00&hold=1

Response

{ok, task:TASK}.

Errors

Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Codes: missing_pbx, unknown_pbx, forbidden, invalid_param, not_found, db_error, server_busy.

---

Back to TuCloudAPI