CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Return campaign stats that includes call counts and billing amounts.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| GetCccCampaignStatsRequest | CCC Campaign Stats request by unique ID | object | |
| campaignId | Unique ID of campaign | long | |
| IntervalBegin | Beginning of DateTime interval to search on | dateTime | |
| IntervalEnd | End of DateTime interval to search on | dateTime |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| CccCampaignStats | ||
| AgentCount | Number of agents assigned to ccc campaign | int |
| ActiveAgentCount | Number of agents currently on calls | int |
| CallsAttempted | Number of calls attempted for ccc campaign | int |
| CallsPlaced | Number of calls placed for ccc campaign | int |
| CallsDuration | Total duration of all calls made | int |
| BilledDuration | Billed duration of all calls made | int |
| BilledAmount | Amount charged | decimal |
| CallsRemaining | Remaining number of calls to be made | int |
| CallsAwaitingRedial | Calls awaiting redial | int |
| CallsLiveAnswer | Number of calls with a live answer for ccc campaign | int |
| ResponseRatePercent | Percent of calls with live answer (100 * CallsLiveAnswer / CallsMade) | int |
| ResultStat | ||
| Result | [LA, AM, BUSY, DNC, XFER, NO_ANS, XFER_LEG, SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED, SD, POSTPONED, ABANDONED, SKIPPED, INVALID_NUMBER] | Result |
| Attempts | Calls attempted | int |
| Actions | Calls placed | int |