Publisher docs
InboundX API.Send calls, live in minutes.
Answer three questions and follow the clicks, or read the full reference. Either way, one test tells you exactly what arrived.
Easy · click by click
Answer three questions
How you send, how the campaign pays, which platform. Then numbered steps, the values ready to copy, and a live test.
Advanced · full reference
Build it yourself
Every parameter, answer and reason, straight from the running code.
{
"status": "reserved",
"payout": 45,
"seconds": 60,
"sip_address": "inboundx@inboundx.sip.telnyx.com"
}Test my setup — no login
Get a temporary URL, send one ping, and see what arrived in plain words.
The three fixes that solve most setups
All reasons →How it works
Connect your call platform in four steps: ask us for a bid, send the call when we win it, share your call ID, and receive a conversion when a call pays. The names, fields and answers on these pages come straight from the running code, so they always match what we do.
reserved, transfer the call to the address in the bid.Step 3Your call IDSend your own call ID, with the ping or right after the call starts, so we can name the call when it converts.Step 4ConversionsWhen a call pays, we call your postback URL with your call ID and the payout.Two kinds of campaign
seconds.Your credentials
Each campaign you send to has its own ping key, from your buyer. Keep it secret: anyone who has it can ping as you. Send it as key on every request.
You can also send your publisher ID as publisher_id. It's optional. When you send it, we check that it matches the key.
Quickstart
Ping with your key and the caller's number:
curl -X POST "https://app.inboundx.io/api/rtb/ping" \
-d "key=YOUR_PING_KEY" \
-d "caller_number=+15555550123" \
-d "caller_state=TX" \
-d "request_id=abc-123"If we can take the caller, the answer has status set to reserved and the address to send the call to. If we can't, status is no-target, with a reason.
Then check your whole setup without sending real traffic, on Test your setup.
For tools and AI agents, the API is described in OpenAPI 3.1 at https://app.inboundx.io/openapi.json.
For what InboundX is and who it is for, see https://inboundx.io.