TuCloudAPI addoutrule: Difference between revisions

Latest revision as of 14:30, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Append an allow/deny rule to a profile. dst = the dial-prefix to match (digits); denyallow 0=allow, 1=deny; route_id = the route to divert to when a deny matches (0 = block). srv + route validated in-tenant. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addoutrule&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.
`srv`	integer	Yes	—	Parent profile _id.
`dst`	string	No	—	Dial-prefix to match (digits, optional +, max 64; blank = match-all).
`denyallow`	integer	No	`1`	0 = Permitir (allow), 1 = Rechazar (deny, default).
`route_id`	integer	No	`0`	Divert-to route _id when deny matches (0 = block).
`nota`	string	No	—	Optional note (max 64).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addoutrule&ukey=KEY&pbx=tucall&srv=8&dst=806&denyallow=1&route_id=88892

Response

{ok, rules:[{_id,dst,denyallow,route_id,route_name,nota}]}.

Back to TuCloudAPI

@@ Line 12: / Line 12: @@
 ! 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>srv</code> || integer || Yes || — || Parent profile _id.