TuCloudAPI deleteroute: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. | ||
|- | |- | ||
| <code>id</code> || integer || Yes || — || Route id (_id). | | <code>id</code> || integer || Yes || — || Route id (_id). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Delete a route. Blocked {ok:false,in_use,refs:{...}} when still referenced by a CLI route slot, a locution IVR digit, a calendar destination, a blacklist rule, an outbound service, or another route's "goto route" step. Pass reassign_to=<route _id> to repoint every reference to that route and then delete (one transaction). Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=deleteroute&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). |
reassign_to |
integer | No | 0 |
Target route _id to repoint references to before delete (0 = block if in use). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=deleteroute&ukey=KEY&pbx=tucall&id=197
Response
{ok, _id} or {ok:false,in_use,refs:{clis,locutions,calendars,blacklist,ext_outs,routes}}.
Back to TuCloudAPI