View source for TuCloudAPI addblacklist

''TuCloudAPI function to manage FuturePBX (the cloud PBX). 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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <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>route_id</code> || integer || Yes || — || Divert-to route _id (required, in-tenant; a hangup route = block).
|-
| <code>src</code> || string || No || — || Caller number / leading-digits prefix to match (digits, optional +, max 64). Blank = match-all.
|-
| <code>cli_id</code> || integer || No || <code>0</code> || DID this rule applies to (0 = all DIDs).
|-
| <code>nota</code> || string || No || — || Free label, e.g. SPAM (max 64).
|-
| <code>priorityorder</code> || integer || No || <code>0</code> || Ordering hint 0-99 (lower wins first).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addblacklist&ukey=KEY&pbx=tucall&src=930269938&route_id=197</nowiki>

== Response ==
{ok, entry:{...}} or {ok:false,conflict}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]