Skip to main content

Inbound Data Enrichment (IDE)

Amanda Cross
Updated

You use Ringba’s Inbound Data Enrichment (IDE) feature to add information about the caller to the call as tags. Then, you can see the tags in reporting and use them with tag routing filters to route calls to particular targets based on the value in the tags. 

This article contains the following sections:

Inbound Data Enrichment

Ringba's Inbound Data Enrichment (IDE) feature lets your publishers and lead-generation partners send you information about a caller before the call arrives. This data makes the calls more valuable to you because it helps you route the call to the highest-paying buyer. It makes the call more valuable to buyers because the additional data makes the call easier to convert. 

For example, your publisher captures a caller's ZIP Code, age, and name as part of a warm transfer. Your routing plan uses the tag values to route the call to a buyer that serves the ZIP Code. You can also pass the data to the target so the person answering the call knows the caller's name and age, providing a seamless caller experience.

Later when you are reviewing the call, you see the tag values in the Call Details report.

IDE Flow

The following steps outline the high-level process of receiving and using IDE data: 

  1. The publisher, lead-generation partner, or other party collects the data about the caller.
  2. The party's system uses the IDE URL to ping Ringba with the data along with the caller ID.
  3. Ringba captures the data and caller ID in an impression that remains available for 48 hours.
  4. When a call arrives from that caller ID, Ringba adds the data from the impression to the call as tags.
  5. Ringba uses the data to route the call according to your tag routing filters.
  6. When the call appears on the Reporting screen, the Call Details report includes the tags.

Note: IDE only enables passing data to Ringba; it does not provide data natively. Your publisher must already have the data in order to pass it to Ringba with IDE. To access a repository of existing caller information, see Instant Caller Profiles.

IDE Requirements

  • To use IDE, the publisher must send the IDE ping with the caller information before the call arrives. If the IDE ping arrives after the call, Ringba cannot attach the data to the call.
  • The call must arrive within 48 hours of the IDE ping. Ringba stores the impression with the data for 48 hours. If the call arrives after that time, Ringba cannot attach the data to the call.
  • To apply tag filters on a new tag that doesn’t exist yet, you must create a URL parameter. See the procedure later in this article.

Getting the URL for your Publisher

Most of the work of setting up IDE is the responsibility of your publisher, lead-generation partner, or other party that wants to send you data about the caller. But to get started, your publisher needs the URL to use to ping Ringba.

Use the following steps to access the information your partner needs so you can send it to them:

  1. Navigate to the Campaigns screen and open the campaign where you want to set up IDE. Scroll to the Publisher section.
  2. Find the partner you want and click the link icon that appears next to the phone number. Ringba copies a URL to your clipboard. The URL is unique to each publisher number.
  3. Provide this URL to the partner to use to send you data. See the following section for a description of the parts of the URL.

How Publishers Use IDE

Your partner sends the data to Ringba using the URL from the previous section. Ringba accepts the ping as a GET or POST methods, but in either case the data must be sent as query strings parameters, not in a request body. 

About the URL

When you click the link icon, Ringba copies a link that looks like the following to your clipboard:

http://display.ringba.com/enrich/<Number>?callerid=​<<E.164-CALLER-NUMBER>>&key1=value1&key2=value2

The URL contains:

  • https://display.ringba.com/enrich/: This part of the URL directs the request to Ringba and includes instructions for how to use the data in the request. 
  • <Number>: You do not literally see <Number> in the URL you copy. Instead, you see the unique ID for the publisher number.
  • callerid=<<E.164-CALLER-NUMBER>>: This text literally appears in the URL you copy. It is instructional to show that the tag called callerID contains the caller ID in E.164 format. This is a required field because Ringba needs the caller ID to know which call the data belongs to. The party who sends the data must replace <<E.164-CALLER-NUMBER>> with the actual caller ID number in E.164 format. 
  • key1=value1: This text literally appears in the URL you copy. It is instructional to show how to format a tag/value pair. The party who sends the data replaces key1 with the name of the tag and value1 with the value of the tag. 
  • key2=value2: This is a second example of a tag/value pair. This instructional text demonstrates that you can include multiple tag values in the request. Your partner can use this pattern to add as many URL parameters as they need to pass all the information they have.

Example

In this example, your partner wants to send you the name and age of the caller. Starting from the URL you sent, your partner makes the following replacements:

  • replaces <<E.164-CALLER-NUMBER>> with the real caller ID.
    Important: Your partner must use the real caller ID for the caller in place of <<E.164-CALLER-NUMBER>> or the solution will fail.
  • replaces key1 with name
  • replaces value1 with John
  • replaces key2 with age
  • replaces value2 with 26

Here's what the request looks like in Postman.
IDE_request_postman.png

Recall that <Number> from the URL was a placeholder for the real ID number that gets copied to your clipboard. The valid URL would look something similar to this:

https://display.ringba.com/enrich/1361562119999999999?callerid=16195559999&NAME=JOHN&AGE=26

The partner sends the ping and Ringba captures the attributes in an impression. A call arrives from the caller ID 16195559999 within 48 hours, so Ringba attaches the tags from the impression to the call. Ringba routes the call to a target, who converts it.

Later, you review the call on your Reporting screen. You expand the call in the Call Details report and click the Tags tab to see this data among the other tag data for the call.

ide_call_details.png

Creating a URL Parameter

You must create a URL parameter to contain each kind of data your partner plans to send you. You create URL parameters by navigating to Integrations > URL Parameters.

url_param.png

Enter User in the Reporting Menu Name field. Complete the rest of the fields as appropriate for the tag. If you already have this tag, you can skip this step.

Inbound Data Enrichment FAQ

How can I avoid getting a CORS error when implementing IDE in a webpage?

A publisher sending data from their webpage might encounter a CORS error. The following script shows how to send the request using no-cors mode:

<script src="script.js"></script>
    <script>
    // Add event listener to the button
    document.getElementById('fetchButton').addEventListener('click', function () {
        // Fetch API call
        fetch('https://display.ringba.com/enrich/2416242043270464609?callerid=14347557591&first_name=wanda&last_name=al', {
        method: 'GET',
        mode: 'no-cors'
    })
    .then(response => console.log('Request succeeded with no-cors mode', response))
    .catch(error => console.error('Error:', error));
    });
</script>

What should I do if I need help with Inbound Data Enrichment?

If you have any questions or need additional help, please reach out to our support team via chat or email at support@ringba.com.

Related to

Related articles