TuCloudAPI addblacklist
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
Create an inbound-intercept rule. src = the caller number or leading-digits prefix to match; route_id = the route to divert matched calls to (required, in-tenant; a hangup route = block). cli_id 0 = all DIDs. Dedup on (pbx,cli_id,src) -> conflict. Server derives root. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=addblacklist&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. |
route_id |
integer | Yes | — | Divert-to route _id (required, in-tenant; a hangup route = block). |
src |
string | No | — | Caller number / leading-digits prefix to match (digits, optional +, max 64). Blank = match-all. |
cli_id |
integer | No | 0 |
DID this rule applies to (0 = all DIDs). |
nota |
string | No | — | Free label, e.g. SPAM (max 64). |
priorityorder |
integer | No | 0 |
Ordering hint 0-99 (lower wins first). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=addblacklist&ukey=KEY&pbx=tucall&src=930269938&route_id=197
Response
{ok, entry:{...}} or {ok:false,conflict}.
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