Jump to content

TuCloudAPI updateoutrule: 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 || — || Rule id (_id).
| <code>id</code> || integer || Yes || — || Rule 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

Edit an outbound rule (dst/denyallow/route_id/nota). Tenant-checked via the row; route re-validated. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=updateoutrule&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 Rule id (_id).
dst string No Dial-prefix (digits/+, max 64; blank = match-all).
denyallow integer No 1 0 = allow, 1 = deny (default).
route_id integer No 0 Divert route _id (0 = block).
nota string No Optional note (max 64).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updateoutrule&ukey=KEY&pbx=tucall&id=42&dst=806&denyallow=1

Response

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


Back to TuCloudAPI