TuCloudAPI addoutrule
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.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
https://tucloudapi.7kas.com:9087/tucloud?func=addoutrule&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
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}]}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI