Connect Other / custom · InboundX docs

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.

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.

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.

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 @.

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.

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.

Don't convert on call length

This campaign pays when the call qualifies, not after a number of seconds. Turn off any duration conversion for InboundX in your platform, and ignore seconds in our bid. The postback in the next step tells your platform which calls paid.

Ignore this bid field

seconds

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

Tell your platform which calls paid

This is our requirement: when a call pays, we call your platform's conversion URL with these tokens filled in, so it learns which calls paid.

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 your platform learns which calls paid.

Not confirmed for your platform. Where your platform takes a conversion URL isn't confirmed. Confirm with your platform where to enter it and which of its tokens fill these in.

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.