Jump to content

TuCloudAPI getroute

From Wiki 7Kas
Revision as of 14:31, 3 August 2026 by Maintenance script (talk | contribs) (TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Get one route header plus its ordered steps (destinations). 404-style not_found if not in the caller's PBX.

Call

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

Requires the ukey parameter.

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 Route id (_id).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getroute&ukey=KEY&pbx=tucall&id=197

Response

{ok, route:{_id,name,nota,ref_id}, steps:[{_id,priority,app,app_label,appdata,dest_label,timer}]}.


Back to TuCloudAPI