Connect CallGrid · InboundX docs

Add InboundX as a buyer

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

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

Where to add itDocumented: Buyers → Destinations → New Destination
The request editorDocumented: Variable Destination with Phone Type: Variable Number; Webhook Integration enabled. Template Mode or Manual; Manual Request Setup includes Method, URL, Headers and + Add Header.

Buyers › Destinations › New Destination

Name

InboundX

Type

RTB ping

Ping URL

Dial

Illustration: the menu path is from CallGrid'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 CallGrid fills in the bracketed tokens on every call.

Ping URL

https://app.inboundx.io/api/rtb/ping?key=YOUR_PING_KEY&caller_number=[[tag:CallerId]]&caller_state=[[tag:InboundStateCode]]

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

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

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

Request methodsDocumented: GETPOST
Caller number tokenDocumented: [[tag:CallerId]]
Caller state tokenDocumented: [[tag:VisitorStateCode|tag:InboundStateCode]]
Caller ZIP tokenDocumented: [[tag:VisitorZipCode|tag:InboundZipCode]]

Accept only when we bid

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

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

How it reads our answerDocumented: Acceptance Parsing selects JSON/XML fields and comparison conditions. OpenAPI WebhookSchema exposes variablePhone, variableRevenue, variableDuration and variablePingId.
Fields its built-in template readsDocumented: bidAmounttargetNumber

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

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

A fixed SIP addressDocumented: SIP destination format has sip: prefix.
The SIP address from each bidNot confirmed: confirm with CallGrid
The sip: prefixNot confirmed: confirm with CallGrid
How it treats the @Not confirmed: confirm with CallGrid

Keep the caller's own number

Leave the caller ID as the caller's own number, and send the call within 15 seconds of our bid. We match the call to its bid by that number: your own number, or a hidden one, won't match.

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

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

Passing the caller ID throughNot confirmed: confirm with CallGrid
Ping timeoutDocumented: template_default_seconds: 10template: Ringba integration
The caller's number on a SIP transferNot confirmed: confirm with CallGrid

Send your call ID once the call starts

The call ID is created only when the call arrives, so 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=[[tag:CallerId]]&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 CallGrid. How CallGrid sends a request when a call arrives isn't confirmed. Confirm with CallGrid that it can call this URL, and that its call ID exists by then.

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

Call ID tokenNot confirmed: confirm with CallGrid
Call ID at ping timeNot confirmed: confirm with CallGrid

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

Ignore this bid field

seconds

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

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

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

Conversion endpointDocumented: path: /api/postback/event/{POSTBACK_ID}methods: GET, POSTquery_fields: organizationId, callIdprefer: callId
Conversion amount fieldNot confirmed: confirm with CallGrid
Its conversion URLDocumented: origin: https://api.callgrid.compath: /api/postback/event/{id}method: GETid: Postback IDquery_parameters: organizationId, callIdcallId: Exact call match, preferred over callerId.
A conversion pixel URLNot confirmed: confirm with CallGrid
Pixel placeholdersNot confirmed: confirm with CallGrid

Test my setup

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

Test my setupNo login

Not started

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