We may provide you with optional and/or required data points for your campaign.
If you ping without a required tag populated, a no-bid reply will be returned.
For example, we encourage the use of all of the following “tags” AKA Parameters:
CID
exposeCallerId = yes
zipcode
State
SubID
In the example outlined on this page we are showing five required tags: CID, exposeCallerId, zipcode, State, and SubID.
These are simply commonly used, but are not required for all campaigns.
Example GET Bid Request
https://rtb.ringba.com/v1/production/[RTB ID]?cid=+12123334444&zipcode=99999&State=CA&SubID=AffiliateID |
Example JSON Post Request
URL: https://rtb.ringba.com/v1/production/[RTB ID].json
{ “CID”:”+12123334444”, "exposeCallerId":"yes", “zipcode”:”99999”, “State”:”NY”, “SubID”:”AffiliateID” } |
Example XML Post Bid Request
URL: https://rtb.ringba.com/v1/production/[RTB ID].xml
<BidRequest> <CID>+12123334444</CID> <exposeCallerId>Yes</exposeCallerId> <zipcode>99999</zipcode> <State>12345</State> <SubID>AffiliateID</SubID> </BidRequest> |
Example JSON Bid Failure Reply:
Anytime a bid has failed, it will return a $0 bid and no transfer phone number or SIP address.
The reason for failure is presented in the reject reason field.
URL: https://rtb.ringba.com/v1/production/[RTB ID].xml
{ “bidId”: “bdb74fe968224e55b941f02fa1cb23b0”, “bidAmount”: 0, “rejectReason”: “Missing required fields” } |