Connect TrackDrive · InboundX docs

Add InboundX as a buyer

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

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

Where to add itDocumented: Campaigns → Buyers → New From Template → ** Ringba RTB Buyer Example
The request editorDocumented: Buyer Conversion Settings: replace REPLACE_ME URL; Telephone Number Path determines the returned destination. Response values can override Number, Duration and Revenue.

Campaigns › Buyers › New From Template › Ringba RTB Buyer Example

Name

InboundX

Type

RTB ping

Ping URL

Dial

Illustration: the menu path is from TrackDrive's documentation; the screen may look different.

Paste your ping URL

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

Ping URL

https://app.inboundx.io/api/rtb/ping?key=YOUR_PING_KEY&caller_number=[caller_id]&caller_state=[geo_state]&request_id=[call_uuid]

Keep the key secret: anyone who has it can ping as you.

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

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

Request methodsNot confirmed: confirm with TrackDrive
Caller number tokenDocumented: [caller_id]
Caller state tokenDocumented: [geo_state]
Caller ZIP tokenNot confirmed: confirm with TrackDrive
Token syntaxDocumented: [token_name], lowercase letters/digits/underscore; optional default suffix [token]{default}.
Other tokensDocumented: caller_without_prefix: [caller_id_short]

Accept only when we bid

Tell TrackDrive 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 TrackDrive. Where this goes in TrackDrive's screens isn't documented. What its documentation does say is below; confirm the screen with TrackDrive.

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

How it reads our answerDocumented: Was The Response Acceptable?, Extract Value From Response Body, Check If Response/Extracted Value Contains; supports JSON path, XPath and regular expressions.
Fields its built-in template readsNot confirmed: confirm with TrackDrive

Dial the address in the bid

Send the call to the sip_address in each bid, exactly as it is.

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.

Dial the address in this field of each bid

sip_address

Use the address in each bid rather than one you saved.

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

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

A fixed SIP addressDocumented: External platform SIP endpoint uses sip:, @ and [number_to_dial]; buyer-number substitution is documented.
The SIP address from each bidNot confirmed: confirm with TrackDrive
The sip: prefixNot confirmed: confirm with TrackDrive
How it treats the @Not confirmed: confirm with TrackDrive

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 TrackDrive. Where TrackDrive sets the caller ID on a transfer isn't confirmed. Confirm with TrackDrive that it passes the caller's own number through.

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

Passing the caller ID throughNot confirmed: confirm with TrackDrive
Ping timeoutNot confirmed: confirm with TrackDrive
The caller's number on a SIP transferNot confirmed: confirm with TrackDrive

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.

Have TrackDrive call this URL once the call reaches it, with the caller's number and its own call ID.

Call ID URL

https://app.inboundx.io/api/rtb/call-id?key=YOUR_PING_KEY&caller_number=[caller_id]&request_id=[call_uuid]

We find the call by the caller's number, so send the same number you pinged with.

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

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

Call ID tokenDocumented: [call_uuid]
Call ID at ping timeNot confirmed: confirm with TrackDrive

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 TrackDrive, and ignore seconds in our bid. The postback in the next step tells TrackDrive which calls paid.

Ignore this bid field

seconds

Not confirmed for TrackDrive. How TrackDrive turns off a duration conversion isn't confirmed. Confirm with TrackDrive 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 TrackDrive learns which calls paid.

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

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

Conversion endpointDocumented: method: POSTpath: /api/v1/calls/update_call/{CALL_ID}authentication: Basic Authbody_fields: revenue, buyer_converted, offer_converted
A GET conversion URLNot confirmed: confirm with TrackDrive
A conversion pixel URLNot confirmed: confirm with TrackDrive
Pixel placeholdersNot confirmed: confirm with TrackDrive

Test my setup

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

Test my setupNo login

Not started

Check your TrackDrive 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.