TuCloudAPI getroute
TuCloudAPI function to manage tucloud (PBX) services. 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 | — | TuCloud PBX 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