TuCloudAPI gettasks
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
List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts. Tenant resolved from (ukey, pbx).
Call
https://tucloudapi.7kas.com:9087/tucloud?func=gettasks&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. |
q |
string | No | — | Optional name search (contains). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=gettasks&ukey=KEY&pbx=tucall
Response
{ok, rows:[TASK...], pagination:{page,perPage,total}}. TASK={_id,name,description,time,second,month,dayofmonth,dayofweek,hold,status,status_label,status_badge,schedule_label,steps_count}.
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