Docs / Ringba setup · 9 min
Ringba setup
Gate routing on a live verdict with a Ring Tree Target and Call Acceptance Parsing.
How it works on Ringba
Ringba's mechanism for calling an external API and routing on the answer is a Ring Tree Target (RTT) inside a Ring Tree: before Ringba sends the call to the target, it pings a URL you configure and runs your Call Acceptance Parsing code on the response. Return true and the call is sent; return false and the target is rejected before it ever rings.
That maps exactly onto CallerSift: the RTT pings your lookup URL with the caller number, the parsing code reads verdict, and a blocked caller never reaches the buyer behind that target.
Ring trees are included in Ringba's Professional and Enterprise subscriptions and must be enabled on your account by your Ringba account representative. Only admin users can manage them.
Your lookup URL
Every workspace gets one lookup URL, shown on your dashboard home page. POST the caller number to it and the JSON response answers verdict: allow or block.
POSThttps://api.callersift.com/v1/your-workspace
Create the Ring Tree Target
request body
{
"caller_number": "[tag:InboundNumber:Number]",
"api_key": "fck_your_key"
}call acceptance parsing
input = JSON.parse(input); return input.verdict === "allow";
- In Ringba, go to Ring Trees, then Manage Ring Tree Targets, then Create Ring Tree Target.
- Under General Information, set the name and the real destination number the buyer answers on when the target wins.
- Under Request Settings, set the URL to your lookup URL, the method to POST, and the request body below (the [tag:InboundNumber:Number] token inserts the caller's E.164 number; see Ringba's token list).
- In the parsing editor, set Call Acceptance Parsing to the JavaScript below. Basic mode can Run Request against a test ping first; Advanced mode takes the expression directly.
This is the same pattern Ringba documents in Create a Ring Tree Target to Check for Agent Availability; CallerSift just supplies the API being pinged.
Wire it into the campaign
- Go to Ring Trees, then Manage Ring Trees, then Create Ring Tree, and add your RTT (the Ring Tree Setup Guide walks every field).
- In Error Settings, set the Ping Timeout (Ringba recommends 2000 ms; CallerSift answers in milliseconds) and turn ON "send a call even if the ping fails" so a network blip stays fail-open.
- Open your campaign's Routing Plan, select the Trees tab, and add the ring tree at the priority where screening should gate the call.
- Watch verdicts land under Ring Trees, then Summary: a blocked caller shows the Acceptance Rejection disposition, and the same lookup appears in your CallerSift dashboard.
Watch out for
- Ringba pings every eligible RTT for a call simultaneously. If several RTTs each ping CallerSift, one call can produce several lookups. Repeat numbers answer from cache at no charge, but the cleanest setup is one screening RTT at top priority acting as the gate.
- A block rejects that target only; where the call goes next is your routing plan's fallback. Point the fallback at a dead-end target if blocked callers should never connect anywhere.
Official Ringba docs
- Ring Tree Target Setup Guide: every RTT field, request settings, and parsing editors.
- Check for Agent Availability: the ping-an-API-and-parse pattern this guide adapts.
- Ring Tree Setup Guide: ring tree creation and error settings.
- Ring Tree Target Summary: ping dispositions like Acceptance Rejection and Ping Timeout.
- Most Common Tokens: caller number and call tokens for the request body.