InboundXPublisher docs

On this page: Step 1 of 7 · Add a buyer

Connect Other / custom

Real-time bid (RTB) Buffer: counts after N seconds 7 steps

Showing sample values. Sign in to use yours →

What goes here
  • CALLER_NUMBER_MACRO: your platform's token for the caller's number.
  • CALL_ID_MACRO (optional): your platform's call ID token, if it has one; otherwise leave it out and use the Call ID URL.
  • Everything else is ours: copy it exactly as it is.
1

Add InboundX as a buyer

In your platform, add a new buyer for InboundX (some platforms call it a target) and choose the ping type, so your platform asks us before it sends each call.

Not confirmed for your platform. Where your platform adds a buyer that pings isn't confirmed. Confirm with your platform where a new buyer or target is created.
2

Paste your ping URL

Put this in the buyer's ping URL. Your key goes where the sample key is, and your platform fills in the bracketed tokens on every call.

Ping URL
https://app.inboundx.io/api/rtb/ping?key=YOUR_PING_KEY&caller_number=CALLER_NUMBER_MACRO&request_id=CALL_ID_MACRO
Replace each word in capitals with your platform's own token for that value. Keep the key secret.
Not confirmed for your platform. Where your platform takes a ping URL isn't confirmed. Confirm with your platform where the ping URL goes.
3

Accept only when we bid

Tell your platform how to read our answer. We answer reserved in status when we take the caller; anything else means don't send the call.

Accept the bid when this field
status
equals
reserved
Price field
payout
Not confirmed for your platform. How your platform reads a bid isn't confirmed. Confirm with your platform where the accept rule and the price field go.
4

Send the call to our address

This is our requirement, whatever platform you use: send the call to this exact address, with a real @ (not %40), within 15 seconds of the bid, with the caller's own number as the caller ID.

Send the call to
sip:YOUR_ROUTE@ADDRESS_FROM_YOUR_SETUP
This one is a sample. Copy yours from your setup message or the portal's Setup page.
Not confirmed for your platform. Where to enter it in your platform isn't confirmed. Confirm with your platform which field sends calls to a SIP address. If it fills the address in from our bid, check that it keeps the @.
5

Keep the caller's own number

This is our requirement: the call must reach us with the caller's own number as the caller ID, within 15 seconds of our bid. We match the call to its bid by that number, so your own number, or a hidden one, won't match.

Not confirmed for your platform. Where your platform sets the caller ID on a transfer isn't confirmed. Confirm with your platform that it passes the caller's own number through.
6

Send your call ID once the call starts

We don't know when this platform creates its call ID. If it has one when you ping, put it on the ping; if not, send it with the call-ID endpoint.

This is our requirement: once the call reaches your platform, call this URL with the caller's number and your platform's own call ID.

Call ID URL
https://app.inboundx.io/api/rtb/call-id?key=YOUR_PING_KEY&caller_number=CALLER_NUMBER_MACRO&request_id=CALL_ID_MACRO
We find the call by the caller's number, so send the same number you pinged with.
Not confirmed for your platform. How your platform sends a request when a call arrives isn't confirmed. Confirm with your platform that it can call this URL, and that its call ID exists by then.
7

Count the call after the buffer

This campaign pays on the buffer: a call counts once it lasts long enough. Our bid carries those seconds in seconds: map that field to your platform's minimum call duration for InboundX, or type the seconds below. No postback is needed: the call's length is the conversion.

Map this bid field to the duration
seconds
Seconds the call must last
60
Not confirmed for your platform. Where your platform sets a buyer's minimum call duration isn't confirmed. Confirm with your platform where the seconds go.

Test my setup

One test ping through your platform's setup. We show what arrived, and what to change, as it happens.

Test my setupNo login
Not started

Check your setup with one test ping

We'll give you a temporary ping URL. Put it in your platform in place of your real one, call your tracking number from any phone, and see what arrived, in plain words.

  • Your ping arrives
    waiting
  • The caller's number is filled in
    waiting
  • The caller's state is readable
    waiting
  • Every field is under a name we read
    waiting
  • The call arrives inside the hold
    not tested yet
  • The call's caller ID matches the ping
    not tested yet
Nothing is billed and no agent is held: every ping gets a test bid that can't be dialled.
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