InboundXPublisher docs

On this page: Step 1 of 4 · Our number

Connect Retreaver

Phone number (DID) PPC: pays when the call qualifies 4 steps

Showing sample values. Sign in to use yours →

1

Dial our number

In Retreaver, add InboundX as a target that sends calls to this phone number. Every call you send to it reaches us; there's no ping.

Our phone number
BUYER_PHONE_NUMBER
This one is a sample. Copy yours from your setup message or the portal's Setup page.

From Retreaver's documentation Quoted as the platform documents it.

Where to add a number targetDocumented
Contact Handlers → Call Endpoints → create a new buyer at the top of the page → Create Call Endpoint.
The number fieldDocumented
Number
Contact Handlers › Call Endpoints › create a new buyer at the top of the page › Create Call Endpoint
Name
InboundX
Number
BUYER_PHONE_NUMBER
Illustration: the menu path is from Retreaver's documentation; the screen may look different.
2

Keep the caller's own number

This is our requirement: the call must reach our number with the caller's own number as the caller ID. We tell calls apart by that number, so your own number, or a hidden one, won't work.

Not confirmed for Retreaver. Where this goes in Retreaver's screens isn't documented. What its documentation does say is below; confirm the screen with Retreaver.

From Retreaver's documentation Quoted as the platform documents it.

The caller's number on a forwarded callNot confirmed: confirm with Retreaver
Passing the caller ID throughDocumented
scope: Targets API; buyer editing for obfuscationobfuscate_cid: Masks the caller number presented to the target.custom_cid: Custom caller ID to present to the target.cid_number_id: Account number to present as caller ID.
3

Don't convert on call length

This campaign pays when the call qualifies, not after a number of seconds. Turn off any duration conversion on the target that dials our number. The postback in the next step tells Retreaver which calls paid.

Not confirmed for Retreaver. How Retreaver turns off a duration conversion isn't confirmed. Confirm with Retreaver that only the postback marks a call as paid.

From Retreaver's documentation Quoted as the platform documents it.

Turning off the call-length conversionNot confirmed: confirm with Retreaver
4

Tell your platform which calls paid

When a call pays, we call a URL on your platform with these tokens filled in. Here's where to find that URL:

In Retreaver, open your conversion postback key and copy its URL. Put {PHONE} where it says CALLER_NUMBER, {PAYOUT} as the value and {CALL_ID} as call_uuid.

Your call ID
{CALL_ID}
What the call earned, in US dollars
{PAYOUT}
The caller's number
{PHONE}
It should end up like this
https://your-platform.example/conversion?call={CALL_ID}&phone={PHONE}&payout={PAYOUT}
Required: it's the only way Retreaver learns which calls paid.

From Retreaver's documentation Quoted as the platform documents it.

Where conversions are set upDocumented
Buyer → Postback Keys → Add Key → Conversion; configure campaign Postback conversion criteria with the buyer tag.
Conversion URL templateDocumented
https://retreaverdata.com/postbacks/{POSTBACK_KEY}?caller_number={PHONE}&call_uuid={CALL_ID}&value={PAYOUT}
Conversion request methodDocumented
POST
Converting on a postbackDocumented
Campaign → Conversion Criteria → Postback; scope the matches filter to the buyer. Buyer → Postback Keys → Add Key creates the conversion postback key.
Buyer › Postback Keys › Add Key › Conversion
Name
InboundX
Conversion URL
https://your-platform.example/conversion?call=…
Illustration: the menu path is from Retreaver's documentation; the screen may look different.

Test my setup

A number has no ping to test. Make one real test call:

  1. Tell your buyer when you're ready, so they can watch the first call arrive.
  2. Send one real call through Retreaver to our number.
  3. Check the call in your portal's call log. When it pays, check the conversion reached your platform.
Still stuck? of your setup and we'll point at the wrong field.Every platform at a glance
Your ping keys come from the buyer you send calls to. Ask them for a key, or for help with your setup.© InboundX