Skip to main content

Create a Ring Tree Target to Ping an RTB Campaign

Amanda Cross
Updated

In order to pass data and receive bids dynamically from a Buyer that owns a Ringba account as part of Real Time Bidding (RTB) campaigns, you must set up a Ring Tree. This setup sends a request to the Buyer's endpoint before sending the call. Depending on the Buyer's response, the call is forwarded to them.

Note: You must have Ring Trees enabled in your account to see this feature. Contact your Account Representative for more information about enabling Ring Trees.

The Buyer must provide you with the URL and the parameters they require so you can send a request to their endpoint. Ringba provides multiple tags/tokens you can set up your Ring Tree to send, including native tags provided by Ringba (such as caller ID, state, payout, and revenue) and custom tags that are collected elsewhere and sent into your Ringba account (such as ZIP code, age, click ID, and birthdate).

Note: By default, Ringba does not share the Caller ID with the buyer until the bid is accepted. If you need to share the Caller ID, see How do I allow the RTB client to see the Caller ID? for specific instructions beyond the general steps below.

The process to create a Ring Tree to ping a Buyer's URL has three parts:

  1. Create a URL Parameter for any custom tag you want to include
  2. Create the Ring Tree and the Ring Tree Target
    1. Create the Ring Tree Target
    2. Create the Ring Tree
  3. Add the Ring Tree to the Routing Plan

The following sections describe the steps to complete each of these parts.

Part 1) How to create a URL Parameter for a custom tag

If you are collecting user data from outside Ringba and sending it to your account, you must create a URL Parameter to contain that data. Once you create the URL Parameter, a token becomes available to include in the request you send to your Buyer. Some examples of user data that you might collect and include in a URL Parameter include ZIP code, age, first name, last name, date of birth, and email.

Note: If you plan to send only native tags and not include external data, you can skip this part.

Learn More: For more on creating a URL Parameter, check out the URL Parameters article.

Part 2) How to create the Ring Tree and the Ring Tree Target

In this part, you create the Ring Tree Target and a Ring Tree to include the target in.

Create the Ring Tree Target

In this scenario, a Ring Tree Target is the Buyer you want Ringba to ping (with all the Buyer's required parameters) and receive a bid from for the call. Ringba recommends using a Dynamic Number (DID) for this kind of integration to improve connectivity and ensure consistent reporting with the buyer. If you use a static number instead, the buyer records the conversion using the payout amount on the static number, which may be different than the amount in the bid you accepted. We also recommend setting the Revenue Type to dynamic.

Before you complete the following steps, you must get the URL and list of required parameters from the Buyer. When the call reaches the Ring Tree Target, Ringba sends a request to the Buyer with the parameters attached to the URL. If the system receives a bid on the request from the Buyer's endpoint, and if the bid meets the minimum revenue criteria you establish under the Ring Tree (see Part 3 later in this article), Ringba routes call to the Buyer.

  1. Go to Ring Trees > Manage Ring Tree Targets.
  2. Click the Create Ring Tree Target button at the top of the page.
  3. Complete the fields in the first section.
    • Toggle on the Dynamic Number switch.
    • Toggle on the RTB Shareable Tags switch to simplify the configuration. RTB Shareable Tags allow you to share call information with Buyers who are participating in a bidding process, as long as the Buyer also has a Ringba account. For example, if your Buyer wants you to share the caller's ZIP code, you can use RTB Shareable Tags to send, in real time, the ZIP code the call is coming from.

      Important:       When you toggle on the RTB Shareable Tags switch, Ringba immediately reverts any parsing steps you previously configured back to the default. If you close the Ring Tree Target without saving, your custom parsing steps reappear. If you save the Ring Tree Target, however, your custom parsing steps will not reappear, even if you toggle the switch back off again.
    new_rtt.png
  1. Complete the fields related to RTB Shareable Tags.
    rtb_shareable_tags_switch.png

    Note: If you select two or more shareable tags with the same name, the feature fails. For example, you might have multiple ZIP code tags with the same name.

    To correct this problem, in the Request Settings section, you can switch to the Advanced editor and use the coalescing functionality ( | ) to combine the tags. In the example below, Ringba shares the first available tag from the list.

    {
    "zipcode": "[[user:zipcode]|[Gather:zipcode]]"
    }
    • Share Inbound Call ID Switch: Toggle on to send the Call ID for each incoming call to the Buyer. The Call ID is a unique identifier for each call coming into your account. The Buyer sees the Call ID in a token called [tag:user:publisherInboundCallId].
    • Expose Caller ID Switch: Toggle on to expose the caller ID to the Buyer. The Buyer sees the Caller ID in multiple tags, including the inbound number, prefix, and suffix.
    • RTB ID Switch: Enter the RTB ID your Buyer provided to ping their campaign. The RTB ID value is a long hexadecimal value that looks similar to this: 1c22a98c60a74cf38944c0cc77eb0t12

      Note:       The RTB ID value is a long hexadecimal value containing both numbers and letters. It looks similar to this: 1c22a98c60a74cf38944c0cc77eb0t12. Your buyer may provide it as part of a URL like this:
      https://rtb.ringba.com/v1/production/1c22a98c60a74cf38944c0cc77eb0t12.json?CID=14061571951&Tag1=TagValue1&Tag2=TagValue2
      In this case, you should copy all numbers and letters, starting immediately after /production/ and ending right before .json
    • Search for Tags/Search Selected Tags Columns: The two columns let you share other tags with the Buyer. The available tags appear in the column on the left. Once you select a tag, it appears in the column on the right. If you don't want to share any tags, the column on the right must be empty.

Note: If you want to share a custom tag (not a Ringba default tag), you must create a URL parameter as described in Part 1 earlier in this article.

  1. (Optional) If desired, you can also configure Cap Settings, Concurrency Settings, Restrict Duplicate Calls Settings, or Predictive Routing Settings sections you see in the following graphic.
    ring_tree_targets_cap_settings.png
  2. You must complete the Revenue Settings section.
    • For the Conversion Settings, select Override.
    • For the Revenue Type, select Dynamic.
    • Complete the rest of the fields appropriately. Make sure to confirm with your Buyer which option to choose in the Convert On drop-down.
    rtt_revenue_settings.png
  3. (Optional) If desired, you can add a Tag Routing Filter. For example, the following filter only forwards calls that comes from Alabama to the Ring Tree Target:
    rtt_tag_routing_filters.png
  4. If you have completed all the steps above, you can click the Create Ring Tree Target button. Continue to the steps below to create the Ring Tree.

Create the Ring Tree

Ring Trees are designed to support multiple Ring Tree Targets, depending on the use case. If you add multiple Ring Tree Targets inside a single Ring Tree, the system pings all the Targets simultaneously. It forwards the call to the target with the highest bid. Follow the steps below to create a Ring Tree and add the Ring Tree Target.

  1. Go to Ring Trees > Manage Ring Trees.
  2. Click the Create Ring Tree button on the top of the page.
  3. Complete the fields in the first section, including Name, Time Zone, and Hours of Operation.
  4. Complete the fields in the Revenue Settings section the same was you did in step 5 above, when you set up the Revenue Settings for the Ring Tree Target.
    new_rt.png
  5. In the Error Setting section, we suggest you set the Dial Timeout to 10 and the Ping Timeout to 2000.
    rt_error_settings.png
  6. In the Add Ring Tree Targets section, in the Select Target field, search for the Ring Tree Target you created earlier and select it. Click the Add button, and then click the Create Ring Tree button.
    rt_add_ring_tree_targets.png

7. Your Ring Tree is now fully created and ready to go live.

Part 3) How to add the Ring Tree to a Campaign Routing Plan

Once you have created the Ring Tree and Ring Tree Target, you can add it to a routing plan in a Campaign.

  1. Go to the Campaign and navigate to Call Routing.
  2. Click the Trees tab and search for the Ring Tree created in the previous step.
  3. Add the Ring Tree to the Routing Plan by clicking the arrow icon under the Add column and set both priority and weight as desired.
    campaign_call_routing.png

Note: If you are using Call Flows, you must include the Routing Plan containing the Ring Tree in your Call Flow.

Related articles