Reports Rest API

How it Works

This rest api will enable reports to be pulled from CallFire. You can get call reports for any campaign and filter using dates.

Call Reports for Campaigns

All Calls (2000 Records)

Pulls 2000 records at a time for the calls in a campaign. Filter by date too.

URL

https://www.callfire.com/cloud/1/reports/calls/{campaignid}

HTTP Method

GET

Content Type

text/plain

Parameters

• apikey: Required. This is your account api key.
• offset: Optional. The api will return 2000 calls. So you can use this as an offset if you need the next 2000.
• startDate: Optional. start on or after this date. formatted: yyyyMMdd
• stopDate: Optional. stop on or before this date. Formatted: yyyyMMdd

Finished calls only (2000 Records)

Pulls 2000 records at a time for the calls in a campaign.

URL

https://www.callfire.com/cloud/1/reports/calls/finished/{campaignid}

HTTP Method

GET

Content Type

text/plain

Parameters

• apikey: Required. This is your account api key.
• offset: Optional. The api will return 2000 calls. So you can use this as an offset if you need the next 2000.
• startDate: Optional. start on or after this date. formatted: yyyyMMdd
• stopDate: Optional. stop on or before this date. Formatted: yyyyMMdd

Single call report

Pulls 2000 records at a time for the calls in a campaign.

URL

https://www.callfire.com/cloud/1/reports/call/{callid}

HTTP Method

GET

Content Type

text/plain

Parameters

• apikey: Required. This is your account api key.

Call Report Response Example

Content-Type = application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes">
<report>
    <call>
        <callid>111111</callid>
	<campaignid>22222</campaignid>
	<phonenumber>2132212289</phonenumber>
	<dnis>8778973473</dnis>
	<tags>
		<tag>sales number</tag>
		<tag>houston</tag>
	</tags>
	<disposition>TRANSFER</disposition>
	<duration>35</duration>
	<callstart>2010-03-24 15:58:18.0</callstart>
	<notes>
		notes that a call center campaign will add to a call.
	</notes>
	<extra-data>
		additional data uploaded with the phone number
	</extra-data>
	<agentid>21212</agentid>
	<agentresponse>interested</agentresponse>
	<responsetime>2010-03-24 15:58:38.0</responsetime>
	<stored-data>
		<var name="bigconcern">economy</var>
		<var name="willvote">yes</var>
	</stored-data>
	<recordings>
		<file>
		    https://www.callfire.com/cloud/1/files/recording/
		</file>
	</recordings>
    </call>
</report>