TuCloudAPI addblacklist
TuCloudAPI function to manage tucloud (PBX) services. Available to: SuperRoot, Operator, Client.
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
GET https://tucloudapi.7kas.com:9087/tucloud?func=addblacklist&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | TuCloud PBX 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}.
Back to TuCloudAPI