Jump to content

TuCloudAPI gettasksteps

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

Get the ordered steps of a task (tenant-checked).

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=gettasksteps&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).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=gettasksteps&ukey=KEY&pbx=tucall&task=224

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