Skip to main content

Retrieving Channel Name for Calls

Amanda Cross
Updated

We at Ringba X understand that it is vital for you, a buyer, to segregate your traffic from Ringba X by different sources: different sellers, different traffic sources, and so on.

To help you accomplish this goal, Ringba X exposes the Channel for every call.

call_logs_channel.png

What Is a Channel?

The Channel field contains an encoded combination of multiple parameters, including:

  • Seller
  • Traffic Source
  • Category
  • Country Language

It is encoded as a 3-word phrase for ease of use. The encoding is unique to each buyer.

How Can I Receive the Channel?

The way you receive the channel information depends on the type of campaign. The following sections describe how the channel is available in:

  • RTB Buyer Campaigns
  • Static Buyer Campaigns

RTB Buyer Campaigns

You can receive the channel at the time of bidding you are using an RTB campaign.

When setting up an RTB campaign, the channel name automatically appears in the bid requests to the your Ringba RTB endpoint. It is available in a bid and in call reporting under the tag User:channel. 

You can also specify a different name for the tag in the Channel Name field on the Destination window:

basic_details_channel_name.png

Static Buyer Campaigns

When you buy a call through a static buyer campaign, currently the channel name is not proactively sent, due to a large variation in capabilities of different buyerss systems and lack of standard approach for delivering additional information about the inbound call. The call itself does not carry any metadata except for the Caller ID.

If you believe that your system can receive additional call metadata via webhooks - please reach out to our technical support.

The information about the call, including Channel name, is stored in RingbaX and available in Reporting UI or via the reporting API.

Reporting API currently allows to list all calls in a specified time range using the following endpoint:

POST https://api.ringbax.com/api/v1/reporting/buyer/{buyer-account-id}/calls

Sample Request Body:

{
  "dateFrom":"2024-10-30T08:00:00Z",
  "dateTo":"2024-11-07T07:59:00Z",
  "timeZone":"Pacific Standard Time",
  "pageSize":25,
  "pageNumber":1
}

All fields are required.

  • timeZone is used for formatting the timestamps in the response. See the list of Microsoft Timezone Identifiers here.

Response body (always JSON):

[
    {
        "buyerCampaignName": "{string}",
        "cost": {decimal number, USD},
        "channel": "{channel name, string}",
        "conversionRequiredCallDuration": {integer number},
        "callId": "{call ID, string}",
        "timestamp": "{timestamp in requested timezone}",
        "categoryName": "{string}",
        "language": "{string}",
        "country": "{string}",
        "trafficSourceName": "{string}",
        "trafficSourceType": "{string}",
        "callerId": "{Caller ID in +E164 format}",
        "durationInSeconds": {integer number},
        "recordingUrl": "{recording URL}"
    }
]

This API endpoint requires authentication and the API Token must be provided via Authorization header.

Related articles