Number Pools

September 13, 2016 | Angela Dougherty

You will need a Number Pool configured for your campaign if you want numbers dynamically generated on the landing page for your caller data to uniquely be attributed to calls. Because we are tagging numbers dynamically as visitors reach your landing page, you might need a large number pool depending on the number of unique keyword/ad combinations that you want to track, but limited to the number of concurrent visitors you expect.

Once the visitor calls the number that is displayed, we automatically tag the call with any tags that have been set on the number.

You will need to use one of Retreaver’s two available scripts in your landing page.Our more robust Retreaver.js is our JavaScript library for displaying trackable phone numbers. It offers a flexible API so developers can interact with our services in a way that is both straightforward and compliant with modern standards. It is able to be cached by the visitors browser, and quickly distributed via a CDN.

More on Retreaver.js

If you run low volume traffic and do not require alerts, our much simpler Insert.js will fulfill your needs.

More on Insert.js

Creating a Number Pool

Click on Number Pools / New Number Pool or click here. Basically you have two ways of pulling numbers, ones you pull by doing Number/ New Number, and then ones we generate at the landing page using the Number Pools. The Sniffing Parameters you tell us to look for from the URL are put into Retreaver Tags and attributed to calls.

We ping from your site to Retreaver to know when a consumer is looking at a number. The Buffer Seconds dictates that after they leave, how much longer we hold onto the number/extension. The Max Lease Time dictates how long we let them view it it without calling before we release the number/extension back into the pool. Also once a call is ended, if there are no other users calling the same number, it is released back into to the pool.

A new visitor will reset the timer on the Max Lease Time, but once the Max Lease Time or the last visitor leaves, the number becomes available to be something else later.

Default Number

You need a default number in the source code in order to display to viewers as a fallback when your Number Pool is full. This Default Number is there work alongside the Number Pool. You would add a sub_id Tag for this Number and have it equal ‘default number’ so you know what this number is for in the future. It will be used when the number pool is not sized properly and we need to show a static number from our system. You lose tracking information about why the lander was called, but you won’t lose the call.

Default Sniffing Parameters

To configure your default Retreaver.js URL parameter sniffing settings you have to tell Retreaver what to look for in the URL.These defaults will make setting up new campaigns much quicker, especially if you have multiple levels of sub-affiliates to deal with. To edit your company settings, click Settings, then Company and select Edit at the top.
param_sniffing

Default Parameter Sniffing settings.

Once you’ve opened the edit screen, you can choose what keywords to sniff out of the URL and what Tag name you want it to be assigned. In the example below, f_n is being assigned first_name in Retreaver.

url_sniffing

Adding a URL parameter to sniff for in Company settings.

How Many Numbers do I Need?

This depends on how deeply you plan to track. You may primarily want to just track back to AffID and SubID. If tracking down to the ClickID, you will need one number displayed per page viewer, which can add up fast. This sort of granularity might be worth the cost in a large pool of numbers. However, if possible, if you can track to fewer keywords then you can ensure your pools will be smaller.

Example 1: If you are only tracking kw=test and 50,000 people are all looking at that keyword, they all get the same number. However if each browser has a different &kw= they will all get a different number. If all kinds of visitors have the same zoneid, they all see the same number. No reason to generate a new number per visitor if you are only tracking that field and it is the same for many visitors.

Example 2: If you send URL Source and SubSource, and in this example you only had 3 sources and 10 subsources, that is only a total combination of 30. So your Number Pool only needs 30 numbers and will track with 100% accuracy.

Example 3: 1 million visitors are viewing a web page and the URL reads http://yourdomain.com/?a=ABC&s=test This results in 1 million viewers all seeing the same number, since they share all the same tracking data.

In summary, it just depends on how long you set the Max Lease Time in the pool and what you are tracking. If you are tracking down to ClickID, it will be a unique number per visitor, that is how many concurrent visitors you have within the lease time. Try setting the Max Pool Size you think will work and then if we contact you via email saying that your pool is too small, you can either:

1) Ignore it and lose a bit of tracking details.

OR

2) Increase the pool size to track what you want more accurately.

Send Digits

August 24, 2016 | Angela Dougherty

Using Send Digits to Bypass a Buyer’s IVR

Simply put, Retreaver can often bypass any buyer’s IVR by sending DTMF tones (key presses) on behalf of the caller.

Select Buyers, then select your desired buyer to edit. Near the top of this edit page you’ll find the field for Send Digits. Each w represents 0.5 pause. You may find ww1 works for you in this field. Perhaps you find that when you place a test call it doesn’t seem to work. Try adding a w and try a test call again. This trial and error is how you arrive at the minimal pause before the system will allow a key press to be accepted.

We have seen in the past that many buyer’s IVR systems allow multiple key presses. Such as www1www2. We have also seen a buyer’s IVR’s require a Zip entry. This use case ended up using www1wwwww90210 in order to bypass this. Since every IVR is different, this will always require a couple test calls to get just right.

Send digits

In this example there is a 1.5 second pause before the keypress 1 is sent.

Your callers will continue to hear ringing or music-on-hold while the key presses are being processed.

Filter Calls by Zip Code

May 26, 2016 | Angela Dougherty

Getting Started

Calls are automatically tagged with geo tags picked up from the caller ID, which can be added to your buyers to filter your calls. The geo tags that were picked up from the caller ID resolve information such as country, state and city.

However, if you require more granular filtering to be done with Zip codes, you will need to complete these two steps:

1) Add an IVR prompt for Zip codes in your Campaign settings under Prompts.

and

2) Add Tags to your buyer to filter what Zip codes they are able to take.

1) Creating Zip Code Entry Prompts

Zip code Entry

This prompt will play immediately when the call connects.

Zip entry

Creating a zip code entry prompt.

Zip Entry Failed

This plays when the caller does not enter a valid Zip code.

You will want this message to repeat a couple times.

zip failed

Creating a zip entry failed prompt.

Filtering Calls to the Buyer Using Tags

Tags on a buyer control what calls it can take.

More info on filtering calls to your buyers.

Edit the buyer, and add the appropriate geo tags to ensure that the buyer only receives calls from the designated geographical areas.

To add the tags, click on Wizard>Geo>Zip. From here you can enter zip codes individually or ideally, upload a file. This will tell Retreaver that these are the Zip codes this buyer can take, do not send this buyer calls from other Zip codes. It is worth noting that this Upload option will not accept Excel files, only CSV (comma separated values)

Tag Format

Geo tags are in the formatgeo:[ISO 3166-1 alpha-2 country code](-optional state, province or zip). For instance, the tag for California is geo:us-ca while the tag for Canada is geo:ca. For a Zip code 90210, the tag would be geo:us-90210.

Buyer Permissions

April 7, 2016 | Angela Dougherty

Before getting started with learning how Buyer Permissions functions, it is recommended to know a little about how Retreaver’s Collaborators functions:

Getting started with Collaborators.

Permissions for buyers has a locking mechanic. You can lock the permissions to the entire company or to a specific collaborator or if the buyer is unlocked, the system will just use the permissions specified there. Most importantly, this feature allows you to give all or certain buyers the ability to edit their buyer record in your Retreaver account, making it so urgent late-night changes can be made without the account holder or superusers present, allowing granular customized control over all your buyers.

Default Buyer Permissions

Company-wide default settings can be configured for all collaborating buyers to inherit, even as you add new ones. Simply go to Settings and Company, then Edit. Otherwise, you can just click this link. You can choose what you do and do not want collaborating buyers to be able to see and modify by default. All collaborating buyers have these permissions until specified otherwise via editing Collaborator or buyer permissions explained further along.

default_role_permissions

The many default role permissions available for all collaborators managing buyers- unless otherwise overridden via the steps below.

Default Collaborator Buyer Permissions

You may also edit permissions for a collaborator in the event that they manage multiple buyers. By selecting Settings on the left menu, followed by Users and Collaborators, you can then select Permissions to edit what that individual has capabilities to do when managing buyers for your company.

Users_collab_permissions

How to edit Permissions for a specific collaborator.

On the following screen pictured below, you may customize this individual’s permissions within your company. Once you click the padlock icon, this unlocks the settings for this specific collaborator, overriding what you have set for default in the company screen described above.

collaborator_roles

Unlocking permissions and customize them per collaborator, or for Buyer-specific overrides by editing the collaborator.

Individual Collaborator Buyer Permissions

Lastly, you can override everything you’ve configured in the company defaults or the collaborator record above by selecting Buyers in the left menu then simply click the number for the Buyer. The following screen pictured below has the Permissions tab where you can customize the override permissions for any collaborator managing this Buyer.

buyer_specific_permissions

Unlocking the Permissions at the Buyer level, overriding all that is set in company or in the collaborator records.

Insert.js

March 15, 2016 | Angela Dougherty

URL Parameter Sniffing

Retreaver can pick anything up from the URL, but you need to tell it what to look for, and what it’s called in the system. For example, you don’t want anyone to know who drives your traffic, so you would sniff for a to resolve the affiliate_id.

Sniffing
The Dynamic Number Insertion section on your Campaign screen.

Tracking keywords becomes easy when you can just send it to us in the URL. We can then sniff for them and filter calls to your buyers using these fields.

We recommend these articles to help understand how Retreaver functions: Learn what Tags are, then learn about how a call gets Tagged, then learn how to filter calls to your Buyers with these Tags.

Retreaver.js

An alternative to Insert.js is our more robust Retreaver.js is our JavaScript library for displaying trackable phone numbers, it offers a flexible API so developers can interact with our services in a way that is both straightforward and compliant with modern standards. It is able to be cached by the visitors browser, and quickly distributed via a CDN.

More info on Retreaver.js

If you run low volume traffic and do not require alerts, this guide on our much simpler Insert.js will fulfill your needs.


Insert.js

Our script without &message= will only show the number and not hyperlink it. To hyperlink, you just take what would be the JavaScript to hyperlink a number, image, text, or a button and put that in the &message={URL Encoded JavaScript}.
We then replace the JavaScript call to us with the formatted JavaScript you put in &message=.

No Hyperlink

(Do not include &message= in the script)

src=”https://api.rtvrapi.com/insert.js?key={Insert Campaign Key Here}&default_number=%2B{Insert Phone with Country Code Here}” type=”text/javascript”></script>

Hyperlinking an Image, Text, Phone Number, or Button

(Setting &message= for different functionality)

Image: <a href=”tel:+1[plain_number]”><img src=”{Path To Image}”></a>

Text: <a href=”tel:+1[plain_number]”>{Text To Be Hyperlinked}</a>

Formatted Number: <a href=”tel:+1[plain_number]”>[number]</a>

Button: The hyperlink part will look like <a href=tel:+1[plain_number] class=”button”>, then the rest of the format for Image, Text, or Formatted Number.
You will take from <a to </a> and URL Encode it, and that is what the &message= is set to.

We find this tool helpful in encoding and decoding URLs: http://meyerweb.com/eric/tools/dencoder/

Click Here For Hyperlink Code Examples

Final Script

<script src=”https://api.rtvrapi.com/insert.js?key={Insert Campaign Key Here}&default_number=%2B{Insert Default Phone With Country Code Here}&message={URL Encoded HyperLink Javascript Code}” type=”text/javascript”></script>

 

Interfacing to HasOffers

| Angela Dougherty

hasoffers-logo

In order for HasOffers to interface to Retreaver using goals, the offer should be set up with a conversion pixel of Server Postback w/ Affiliate ID. Goals should also be enabled in HasOffers.

Configuring your Pay Per Call Offer this way allows you to track Publisher payout to the main conversion. Then revenue to the goals that are set up for each buyer. The HasOffers goals have been designed to allow for a different advertiser on each goal. The conversion pixel type on the goals should also be set to Server Postback w/ Affiliate ID.
The following four steps will help you understand how HasOffers interfaces with Retreaver.


Step 1: Create the offer in HasOffers

1


Step 2: Create a Goal for each Buyer in HasOffers

2


Step 2 Results: Goal for Main Offer and Each Buyer in HasOffers

3


Step 3: Cross reference Goal with Buyer ID

Click View on the Goal Options in HasOffers to see the conversion pixel. Use the goal_is from the pixel as your Buyer ID in Retreaver.


Step 4: Tracking URL set up in the Campaign on Retreaver

NOTE: The tracking URL for the revenue has &goal_id=[buyer_id]

NOTE: In the screenshot below in the tracking links you will see it says [affiliate_id] this value has changed in Retreaver to [publisher_id]

5

How a Call gets Tagged

February 22, 2016 | Angela Dougherty

For the basics on how Retreaver’s Tags function, take a look at this article:

Introduction to Tag Types and Operators

All our reporting is simply based off what Tags are in the call_uuid for each individual call. This article will go over the five ways to get the call tagged with data:

1) Attached to static Numbers.

Pull a static number and add a Tag using the Tag Wizard. You could have a Tag like sub_id or custom Tags you’ve already created such as traffic_type:==online_listings. This is also where you would add a Buyer Tag to identify the Buyer(s) you want to force the call to.

edit_number_tags

New Number tagged with traffic_type and forcing calls to buyer_id:==16140.

2) At the landing page using our Script.

In this situation you define a Number Pool or an Extensions Pool. Based on what you tell us to sniff out of the URL and what Tags to put them in, we will either reuse a number if we find one in the pool that already has those Tags or we recycle a number if it has been returned to the pool. If you were only tracking affiliate_id and sub_id all viewers of the page would all see the same number.

Lastly, we create a new number on the fly to the max size of the pool. If you have defined your pool in such a way that it is too small for us to get a new number, then the default number is shown to the consumer.  This default number is usually another number in Retreaver that will not be able to track, but at least you won’t lose the call.

3) From Tags that prompt the caller to input an answer.

If the number has already been tagged with it, our system will skip asking those prompts since we already have the answer.

4) Outbound dial to the consumer from our system.

You only need one number per campaign for outbound dials, as you are Tagging the outbound call with the values you want on the call. In this situation only one number per campaign is needed, because you send the Tags on the outbound call to the consumer in the script that initiates the call, any values you send will be appended to the Tags already in the number or overwrite those Tags if they are the same.

5) Via Postback from a 3rd party tracking system.

You can send information to a 3rd part tracking system with the call_uuid and a call key. We can post to a data append company or even to your system with a caller id, the call uuid, and the call key, and they can send all kinds of information back to the call as it is happening or after the call is complete. Such as name, address, credit rating, or whatever you need.

Here is an example of a call in Retreaver that is being Tagged with the following values from all five ways a call can be attributed:

ways_a_call_is_tagged

How Tags from many sources attribute the call with information.

Next

How to filter calls to Buyers based on Tags

Interfacing to Voluum

February 20, 2016 | Angela Dougherty

voluum-logo

Voluum is one of the most robust tracking systems available to help you optimize your lead spends. However, if you try to track calls to Voluum using a clickid, you would need enough numbers to track all your concurrent visitors since each visitor would need a unique number to tag the number with the unique clickid. The following documentation is an alternative way to still use Voluum, but only track the information that is important to you, and not down to a clickid. You could also do this for epom.com or a variety of other tracking systems.

Using a tracking system like Voluum you could even have your Google Adwords go through Voluum and only track what you want to track. If you use Google Analytics integration with Retreaver, you are stuck with having a number pool big enough to track visitors with a unique phone number, which is fine for low volume campaigns, but not very good for high traffic campaigns.

Retreaver can interface to Voluum in two ways. By Server to Server using a ClickID, and by Cookie Based Pixels only tracking the relevant information you need from each traffic source to optimize. It is suggested you use the Cookie Based Method instead of S2S so that your number pool sized can be managed better, and the tracking will be more accurate.

New to Voluum? It would help us out here at Retreaver if you used this referral link when you sign up for Voluum:
https://panel.voluum.com/link/?t=C5ndL5yBZOCtkXBIvAiOuzSvtjPLH8IrQHo8XuoN2Gp8S3BdXZmZuS+W5RCHbELQ


Cookie Based Tracking


When optimizing, send fewer fields to your landing page from Voluum, and then add more fields to track as you refine the broader sources. For example, On Redirect.com, you could bid on 500 Sources and all their Sub Sources. You will be sending both of the values on the click to Voluum to track; however, if you only send in the Source to the landing page initially, you can figure out which sources to bid on and which to eliminate, before you start sending the Sub Source to the lander to refine the Source’s traffic by Sub Source.


Traffic Sources


In the below images, you can see that every Traffic Source setup in Voluum has been given some custom token names that will be used to track the important information that you would like posted to Voluum.

No matter what traffic source you are getting the traffic from, it is best to come up with a naming standard for the fields you want to track from each Traffic Source. In this example, we have used r_src through r_src5 meaning retreaver_tracked_source.

Redirect.com Custom Tokens:

Redirect Tokens

1. This is where Voluum will look in the url to find the custom token to extract.
The replacement tokens for this column are {var1} thru {var10} based on the order listed in this column.

2. This is how the Traffic Source denotes the token name for replacement in their system.
Note: Delimiters for tokens vary by traffic source, most use {tokenname}, but as shown above redirect uses #tokenname#, LinkTrust uses [=tokenname=], and even Retreaver uses [tokenname]. See the help section in the traffic source for how they delimit tokens for replacements in strings.

3. This is the name of the field to be shown on Voluum reporting.
You can name it what the traffic source calls it or however you want to see these fields on Voluum reporting. If you want to use this column for token replacement it is {var:fieldname}.

4. This is just a flag to indicate if the field should be included on the Voluum Reporting for this Traffic Source or not.

5. The variable r_buyer denotes the Retreaver Buyer of the call. We have to define it for each Traffic Source so that Voluum has it as a custom field, but you would not fill in the Placeholder since you will not be getting this field from the Traffic Source; but rather, from Retreaver after the call is complete.


50onRed Custom Tokens:

50rtokens


MediaHub Custom Tokens:

mediahub tokens


ZeroPark Custom Tokens:

zeropark tokens

Of course these traffic sources may have many more tokens you want to track, Retreaver calls these Tags. There can be many more sources you have. Contact Support if you have a Traffic Source you do not know how to define the Advanced Settings in the Traffic Source for.


Setting up an Offer and Campaign on Voluum


There are many ways to get the traffic to the final landing page via Voluum. However, for this example, we are only going to create an Offer and combine it with a Traffic Source in the Campaign.

Step 1: Offer Setup

Pictured below is the Voluum Offer Edit Screen:

offer1

1. http://mylander.com/index.html?a=[PUT_RETREAVER_PUBLISHER_ID_HERE]&os={os}&browser={browser}&isp={isp}&ip={ip}&r_src={var1}&r_src2={var2}&r_src3={var3}&r_src4={var4}&r_src5={var5}&vcid={campaign.id}&dfn=(888)%20222-3333&dn=%2B18882223333&clickid={clickid}

System tokens in Voluum are defined as {tokenname}, while user defined tokens are {var1 thru var10} if doing based on column 1 names of the Tracking Source Custom Variables OR {var:tokenname} if using the name in the 3rd column.

All of the query string variables are optional. Query string are all the data after the ? in the URL. However, if you follow these standards to send to each lander, we can use a standard pixel in the tracking URL of all the Retreaver Campaigns.

In this example, we are only sending os, browser, isp, and ip to the landing page so we may use this information for display variables on the page. Variables r_src through r_src5 are sent as whatever values we received from the Traffic Source. Variable vcid is the Voluum Campaign ID; Retreaver will pick this up as a Tag for the postback URL. The last two fields named dfn (Default Formatted Number) and dn (Default Number) are used so that you can have many campaigns from Voluum, but land on the same landing page. By sending in the dfn and dn fields, you will be able to have a unique default number to use if the Number Pool definition in Retreaver is too small.

URLs must be Encoded when placing them in Voluum.  In the URL example %20 is the <space> between the Area Code and Preifx, and %2B in the dn field is the plus sign (+).

Step 2: Voluum Campaign Setup

Pictured below is an example of the Redirect.com Campaign Setup In Voluum:

redirectcampaignexample

1. Campaign URL to be placed on the Rediret.com system to send traffic through Voluum: http://YourVoluumDomain.com/96abe75b-91ba-4ca8-a0c8-26c104805316?r_src=#SOURCE#&r_src2=#SUBSOURCE#&r_src3=&r_src4=&r_src5=&r_buyer=

Note that it is adding the query string fields from the Traffic Source Advanced Settings. A different traffic source would have different tokens appended.

2. You can combine any traffic source you want with the same offer.

3. The offer has the URL that points to the landing page in this example.

Step 3: Setting up the Campaign on Retreaver

Although you would normally set up campaigns on Voluum separately for each Traffic Source, in Retreaver that would require extra numbers to be used since the Number Pools are defined by Campaign. It is highly recommended that you just use one Campaign per vertical, and let our tags do the reporting for you.

Here we are only focused on the Tracking URLs to interface to Voluum with data instead of by clickid. Our dedicated support staff are here to help you configure your tracking interface with Voluum or help configure your campaign, contact us at support@retreaver.com and be sure to have your tracking URL from Voluum handy.

trackingurls1

Configuring tokens within your tracking URL. Note that in the above image, target_id has since changed to buyer_id.

You may have noticed that the landing page url placed on Voluum had &vcid={campaign.id}. This is how we will be able to interface back to Voluum which will have many campaigns, but only have one campaign setup in Retreaver.

  1. Tracking URL to do a Click in order to write a cookie to the Retreaver servers, for the pixel that fires below: http://v.selftrk.com/[vcid]?r_src=[r_src]&r_src2=[r_src2]&r_src3=[r_src3]&r_src4=[r_src4]&r_src5=[r_src5]&r_buyer=[buyer_id]&tfn=pixel You can send in [buyer_id] if you have used that field in the Buyer Edits, or [system_buyer_id] if you haven’t. We are sending &tfn=pixel only to tell the code on the landing page, that this is a Retreaver click for the postback, and the lander does not need to try and generate a lead.
  2. Pixel URL: https://v.selftrk.com/conversion.gif?payout=[revenue]&txid=[call_uuid]

Example Default Number to be used for Redirect.com Campaign

Redirect number overview

We add two tags to each static number we have to pull manually from the system for each campaign that is running. This will allow us to still track that we have a call back to Voluum; however, we identify that the number pool was full and the default number had to be used:

  • vcid is set to the campaign id from Voluum
  • r_src is set to whatever you want to show in Voluum reporting that these calls aren’t actually tracking the source of the call on the campaign.

Setting up the Campaign Settings on Retreaver


There are two ways to tell Retreaver what you want to track from the landing page URL:

1. In the campaign settings you modify what you want us to track from the URL and what Retreaver Tag to place it in.

2. Have the Retreaver campaign look for all the possible tags you want to track, but as you optimize, modify how much information you actually send to the landing page in the URL.

Option 2 is going to make much more sense, since we are trying to optimize many campaigns in Voluum to only one campaign in Retreaver.  As mentioned in the beginning of this article, the best way to optimize is start with tags that are not very unique, and then as you decide which ones of those are working well enough to refine more, add them to the landing page URL in Voluum on the campaign.

Sniffing Voluum

Note that if you are trying to send an publisher_id to Retreaver, it must exist in Retreaver to populate the tag. In the example above the voluum landing page URL has &a={trafficsource.name}. This assumes that you have named your traffic sources with the same value as the publisher ID in Retreaver. Since campaigns in Voluum are linked to traffic sources, you could also hard code this to be &a=RD. RD being the publisher ID you have given Redirect.com in Retreaver.


Suggested Optimization Strategy

The suggestion we make as you optimize a campaign (now that you are not tracking by clickID) is to only send broad information to the landing page, and then as you can narrow your bids on the broad tag values, do more refined tracking.

Redirect.com example: Since you won’t know what Sources to bid on from Redirect.com when you start, do a broad bid but only send the Source to the landing page. Even though you get the Subsource from Redirect to Voluum, initially don’t send it to the landing page. Once you have narrowed down what Sources are making calls happen, you then only bid on those Sources, and start sending the SubSource to the landing page. In the flow of this document that would be r_src={var1} initially, then add in r_src2={var2}.

This same logic can be used for any Tracking Source.  Send all the information from the Tracking Source to Voluum, but control what you want Retreaver to track by only sending limited information to the landing page originally and adding more information as you refine the bids.


Server to Server Tracking by Click ID


With Voluum’s clickid postback, the clickid has all the information about the click, siteid, browser, browserversion, os, osversion etc. So you can send us the clickid, and we post that back to Voluum and they will provide your reporting. Voluum’s reporting gives much more insight on your tracking as well as a great place to optimize the keywords and zones that work.

You need to host up a modified landing page, which we can of course help you with should you need it. Then you configure your Voluum to send similar to what is below.
http://yourdomain.com/index2tm2.php?a=MH&clickid={clickid}

You must include: &clickid={clickid}

You can optionally send:

&os={os} You can filter calls to Buyers using this field.
&osversion={osversion}
&ip={ip}
&isp={isp}
&browser={browser}
&browserversion={browserversion}
&etc etc from voluum tags

If you are not trying to track back to anything and just use our reporting, then pass zoneid and placementid to Voluum or bypass them. Then send to us and don’t try to postback to Voluum. We can track anything you send to us.

Note: The Postback URL after the call completes needs UUID, key and CallID.

If you simply want to see what source is bringing traffic for calls, you can just track that with Retreaver.

Routing to SIP and using SIP Headers

| Angela Dougherty

Routing Calls Via SIP Address

With Retreaver, you can route calls to SIP addresses and receive inbound calls via SIP.

Outbound:

Outbound SIP is done simply by changing the Buyer Phone Number to begin with sip: Once you begin typing this, the screen will change so that you can key in fields required to do outbound SIP. There are no changes needed to the Retreaver system to do outbound SIP, but it is important to know how the buyer will authenticate the calls via SIP to their system.

You may authenticate one of 3 ways

1) No authentication. (Just leave Username and Password Blank in Buyer Setup)
2) With Username and password.
3) By WhiteListing Twilio IP addresses. (Also leave Username and Password blank for this option)

For option 3, here is what your Buyer will need to know:

Signalling IPs to Whitelist

Port 5060 (UDP/TCP), 5061 (TLS)
54.172.60.0
54.172.60.1
54.172.60.2
54.172.60.3
54.171.127.192
54.171.127.193
54.171.127.194
54.65.63.192
54.65.63.193
54.65.63.194
54.169.127.128
54.169.127.129
54.169.127.130
54.252.254.64
54.252.254.65
54.252.254.66
177.71.206.192
177.71.206.193
177.71.206.194

Inbound:

In order to do inbound SIP to Retreaver, it will need to be set up manually so contact us at support@retreaver.com to get started.
Once you have those settings completed, you can begin setting up the inbound SIP.

For Inbound SIP, we require SIP authentication in one of 2 ways:

1) With Username and Password.
We give this to you during setup.
Example format: sip:+18882223333@retreaver.sip.twilio.com

2) By White Listing IP addresses where traffic will come from.
Send any lists from any source you need whitelisted to support@retreaver.com.
Example format: sip:+18882223333@retreaver-ip.sip.twilio.com
Any number you pull from the system can receive calls via SIP from any country. Just replace the +18882223333 with the phone number you want SIP calls to come in on. Don’t forget the country code!

Using SIP Headers

Calls to SIP-based Buyers automatically include several SIP headers in the INVITE request to the Buyer. These headers include X-PH-RetreaverUUID, the UUID for the call; X-PH-RetreaverKey, the postback key for the call; X-PH-RetreaverAFID, the publisher ID of the responsible Publisher; and X-PH-RetreaverSID, the sub_id of the responsible sub-affiliate if one is set.

Interfacing to CAKE

| Angela Dougherty

CAKE logo

Below is some information on interfacing to CAKE, however we suggest you contact us at support@retreaver.com and include your tracking URL and what a conversion pixel looks like for us to help you set it up correctly. The Retreaver Team is here to help you interface to any external tracking system you ever need.

How to configure your CAKE Tracking URL.

When configured, you will simply have a click if it doesn’t convert and a click and conversion if it does. That’s the magic of Retreaver.

Matching IDs

Publisher ID matches Affiliate_ID with CAKE.
Campaign ID matches Offer ID with CAKE.
Buyer ID matches Buyer ID with CAKE.

If you are doing lead-gen in CAKE, you will only need the Buyer ID to match.