Jump to content

TuCloudAPI addtaskstep

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

Description

Append a step to a task. Server validates: task in tenant; action_id belongs to app_id; record_id is in this PBX's picker set (cross-tenant guard). Blank data stored as NULL. step_order = max+10.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addtaskstep&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.
task integer Yes Task id (_id).
app_id integer Yes App id (from getapps).
record_id integer Yes Record id (from getappsrecords).
action_id integer Yes Action id (from getappactions).
data string No New value; blank = not forced (stored NULL).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addtaskstep&ukey=KEY&pbx=tucall&task=224&app_id=1&record_id=204&action_id=173&data=

Response

{ok, steps:[STEP...]}.

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