Jump to content

TuCloudAPI updateroutestep: Difference between revisions

From Wiki 7Kas
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 || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
| <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 || — || Step id (_id).
| <code>id</code> || integer || Yes || — || Step 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

Change a step's app/appdata/timer (and optionally priority). appdata re-validated in-tenant. Tenant-checked via the parent route. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=updateroutestep&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 Step 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 (default 15).
priority integer No 0 New priority/order (0 = keep current).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updateroutestep&ukey=KEY&pbx=tucall&id=89663&app=1&appdata=87365

Response

{ok, steps:[...]}.


Back to TuCloudAPI