TuCloudAPI addroutestep
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Append a step to a route (priority = max+1). appdata is validated in-tenant per app. timer is the ring seconds (default 15). Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=addroutestep&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. |
route |
integer | Yes | — | Route id (_id). |
app |
integer | Yes | — | Step application 1-10: 1=extension, 2=group, 3=locution, 4=goto priority, 5=hangup, 6=voicemail, 7=goto route, 8=calendar, 9=schedule, 10=queue. |
appdata |
integer | No | 0 |
Destination id for the app: extension/group/locution/route/schedule _id (validated in-tenant for apps 1/2/3/7/9), target priority (4), mailbox (6), calendar template (8) or queue id (10). Ignored (forced 0) for hangup (5). |
timer |
integer | No | 15 |
Ring seconds for this step (default 15). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addroutestep&ukey=KEY&pbx=tucall&route=197&app=1&appdata=87365&timer=20
Response
{ok, steps:[{_id,priority,app,app_label,appdata,dest_label,timer}]}.
Back to TuCloudAPI