Introduction

If your application currently uses the legacy CallFire API, it is important that you migrate to our production supported API and newer platform. The new platform has been in production for 5 years and is widely used and supported.

Migration Guide

The new version of the API is not backwards compatible. For our most often used API’s we’ve created an API bridge to reduce the migration effort. For other API’s, a migration will have to be made to our new API and documentation and a mapping is provided in detail below.

Setup Guide

Current account will be offline as we initiate account migration

Credits will move over along with associated rates
Contact lists
Do Not Contact (DNC) lists
Campaign sounds
DIDs
Call Tracking

IVRs will need to manually need to be moved so login to your legacy account and capture IVR configurations beforehand
Campaign and call details will not be migrated, but you may also grab those before account migration
Login to your migrated account and create new API keys
From here, you will need to ensure your application maps to the new APIs in the section below

What’s new

The new CallFire platform is ready to sunset our legacy system completely in 2020. The new API’s are documented here and have many improvements over the legacy API including improved scalability, Restful responses, Swagger interface supported, JSON responses and much more!

API Mapping

API Service	Legacy WSDL URL	Legacy API Operations	New Corresponding API operation	Notes
WSDL API
SMS Service	https://www.callfire.com/service/SMSService?wsdl
		sendSMSCampaign	https://developers.callfire.com/docs.html#sendTexts
Inbound Calls	http://www.callfire.com/service/InboundService?wsdl
		purchaseSingleNumber	https://developers.callfire.com/docs.html#orderNumbers
		forwardSingleNumber	https://developers.callfire.com/docs.html#updateNumberLeaseConfig
Rest API		( base url: https://www.callfire.com/cloud/1 )
SMS API
		POST /sms/send	https://developers.callfire.com/docs.html#sendTexts
Callfire XML Campaign
		POST /callfirexml/campaign	inbound: https://developers.callfire.com/docs.html#updateNumberLeaseConfig outbound: https://developers.callfire.com/docs.html#createCallBroadcast
		PUT /callfirexml/campaign/{id}	inbound: https://developers.callfire.com/docs.html#updateNumberLeaseConfig outbound: https://developers.callfire.com/docs.html#updateCallBroadcast
Sending Calls
		POST /campaign/{campaignid}/call	https://developers.callfire.com/docs.html#sendCalls
Callbacks
		POST /reports/callback/callfinish	https://developers.callfire.com/docs.html#createWebhook	https://developers.callfire.com/webhooks-guide.html
		POST /reports/callback/callfinish/{campaignid}	https://developers.callfire.com/docs.html#createWebhook	https://developers.callfire.com/webhooks-guide.html
		POST /reports/callback/campaignfinish	https://developers.callfire.com/docs.html#createWebhook https://developers.callfire.com/docs.html#getCallBroadcastStats	https://developers.callfire.com/webhooks-guide.html
Phone Numbers
		GET /inbound/numbers	https://developers.callfire.com/docs.html#findNumbersLocal https://developers.callfire.com/docs.html#findNumbersTollfree
		POST /inbound/numbers	https://developers.callfire.com/docs.html#orderNumbers
Reports
		GET /reports/calls/{campaignid}	https://developers.callfire.com/docs.html#findCalls
		GET /reports/calls/finished/{campaignid}	https://developers.callfire.com/docs.html#findCalls
		GET /reports/call/{callid}	https://developers.callfire.com/docs.html#getCall
Recording and Files
		GET /files/recording/list/{campid}/{callid}	https://developers.callfire.com/docs.html#getCallRecording
		GET /files/recording/{fileid}	https://developers.callfire.com/docs.html#getCallRecording
		GET /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}	https://developers.callfire.com/docs.html#getCallRecordingMp3ByName
		GET /files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}/mp3	https://developers.callfire.com/docs.html#getCallRecordingMp3ByName
Validation
		GET /utils/getNumberDetails?npanxs=AREA_CODE	https://developers.callfire.com/docs.html#findNumberRegions

Campaign Service	https://www.callfire.com/service/CampaignService?wsdl
		addAutoDNCToCampaign	https://developers.callfire.com/docs.html#createCallBroadcast
		addNumbersToCampaign	https://developers.callfire.com/docs.html#addCallBroadcastRecipients
		createBroadcastNoAMD	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastToList	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastToList1	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastToNumbers	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastToNumbers1	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithDNC	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithDNC1	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransfer	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransfer1	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransferDNC	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransferDNC1	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransferDNCNoAMD	https://developers.callfire.com/docs.html#createCallBroadcast
		createBroadcastWithTransferDNCNoAMD1	https://developers.callfire.com/docs.html#createCallBroadcast
		createLiveAnswerNoDetect	https://developers.callfire.com/docs.html#createCallBroadcast
		createReplicaCampaign	N/A	to clone campaign use GET operation to retrieve campaign, then copy all fields into create campaign request
		createSingleQuestionPoll	https://developers.callfire.com/docs.html#createCallBroadcast	use IVR to setup poll, code example: https://developers.callfire.com/usecase-political-poll.html IVR documentation: https://developers.callfire.com/callfire_xml_introduction.html
		createSimpleTTSCampaign	https://developers.callfire.com/docs.html#createCallBroadcast
		getCampaignByName	https://developers.callfire.com/docs.html#findCallBroadcasts
		getCampaignByIDs	https://developers.callfire.com/docs.html#findCallBroadcasts
		getCampaignStats	https://developers.callfire.com/docs.html#getCallBroadcastStats
		getFullCampaignList	https://developers.callfire.com/docs.html#getCallBroadcastStats	there is no operation to get aggregated stats for all campaigns at once, use this operation for every campaign to get stats and aggregate on client side
		getMinuteBalance	https://developers.callfire.com/docs.html#getBillingPlanUsage	get account balance, it is in credits instead of minutes
		getRunningCampaignList	https://developers.callfire.com/docs.html#findCallBroadcasts	use filter running=true to fetch all campaigns in running status
		sendBroadcastToList	https://developers.callfire.com/docs.html#createCallBroadcast
		sendBroadcastToList1	https://developers.callfire.com/docs.html#createCallBroadcast
		sendBroadcastToList2	https://developers.callfire.com/docs.html#createCallBroadcast
		sendBroadcastToListWithSoundId	https://developers.callfire.com/docs.html#createCallBroadcast
		sendCallForCampaign	https://developers.callfire.com/docs.html#sendCalls
		sendSingleBridgeCall	https://developers.callfire.com/docs.html#sendCalls	use IVR to setup transfer
		sendSingleCallCampaign	https://developers.callfire.com/docs.html#sendCalls
		deleteCallsByNumber	https://developers.callfire.com/docs.html#toggleCallBroadcastRecipientsStatus
		deleteCampaign	https://developers.callfire.com/docs.html#archiveVoiceBroadcast
		useAnsweringMachineDetectionType2	https://developers.callfire.com/docs.html#updateCallBroadcast	use update operation to set corresponding campaign setting
		scrubCampaign	N/A	DNC contacts are being scrubbed upon adding to campaign
		startCampaign	https://developers.callfire.com/docs.html#startVoiceBroadcast
		stopCampaign	https://developers.callfire.com/docs.html#stopVoiceBroadcast
		getRecording	https://developers.callfire.com/docs.html#getCallRecordings
		updateSpeed	https://developers.callfire.com/docs.html#updateCallBroadcast	use update operation to set corresponding campaign setting

Click to Call	https://www.callfire.com/service/ClickToCallAPI?wsdl
		createClickToCallCampaign	N/A
		sendConnection	N/A
		GET https://www.callfire.com/service/clicktocall/sendconnect	N/A

Direct Connect	https://www.callfire.com/service/DirectConnectService?wsdl
		agentLogin	N/A
		agentLoginWithMusicOnHold	N/A
		barge	N/A
		bridgeCall	N/A
		deBridgeCall	N/A
		getAgentInfo	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/GetAgent_get_9
		getAgentId	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/QueryAgentSessions_get_23
		getAgentList	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/QueryAgents_get_10
		kickAgent	N/A
		sendAMCallToSound	N/A
		sendAMCallToSoundDirect	N/A
		redirectCall	N/A
		startCampaign	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/ControlCccCampaign_put_7
		stopCampaign	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/ControlCccCampaign_put_7

List Service	https://www.callfire.com/service/ListService?wsdl
		removeNumbersFromList	https://developers.callfire.com/docs.html#removeContactListItems
		removeNumberFromList	https://developers.callfire.com/docs.html#removeContactListItem
		addNumberToList	https://developers.callfire.com/docs.html#addContactListItems
		addNumbersToList	https://developers.callfire.com/docs.html#addContactListItems
		addNumberToListWithEmail	https://developers.callfire.com/docs.html#addContactListItems
		getLists	https://developers.callfire.com/docs.html#findContactLists
		addList	https://developers.callfire.com/docs.html#createContactList
		clearList	https://developers.callfire.com/docs.html#removeContactListItems

Record Service	https://www.callfire.com/service/RecordService?wsdl
		getRecording	https://developers.callfire.com/docs.html#getCallRecording
		getRecordingByCallid	https://developers.callfire.com/docs.html#getCallRecordings
		removeRecording	N/A
		sendRecordBroadcast	https://developers.callfire.com/docs.html#createCallBroadcast
		sendRecordingCallSoundID	https://developers.callfire.com/docs.html#createCallBroadcast
		sendRecordingCallSoundIDWithLimit	https://developers.callfire.com/docs.html#createCallBroadcast
		sendRecordingCallSoundIDWithLimit2	https://developers.callfire.com/docs.html#createCallBroadcast
		sendSingleCallRecordBroadcast	https://developers.callfire.com/docs.html#createCallBroadcast
		sendSingleCallRecordBroadcastWithLimit	https://developers.callfire.com/docs.html#createCallBroadcast
		sendSingleCallRecordBroadcastWithLimitAndExtension	https://developers.callfire.com/docs.html#createCallBroadcast

Scheduler Service	https://www.callfire.com/service/SchedulerService?wsdl
		deleteCampaignSchedule	https://developers.callfire.com/docs.html#createCallBroadcast	schedule object is already present in Broadcast and can be set when you create new campaign or add later using updateCallBroadcast operation
		getNewCampaignSchedule	https://developers.callfire.com/docs.html#getCallBroadcast	schedule object is already present in Broadcast and can be set when you create new campaign or add later using updateCallBroadcast operation
		scheduleCampaignWithDateStrings	https://developers.callfire.com/docs.html#updateCallBroadcast	schedule object is already present in Broadcast and can be set when you create new campaign or add later using updateCallBroadcast operation

Virtual Call Center API	https://www.callfire.com/service/PredictiveService?wsdl
		answeringMachineTransferStoreAgentResponse	N/A
		createCallCenterConnectCampaign	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/CreateCccCampaign_post_2
		createCallCenterConnectCampaignWithAM	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/CreateCccCampaign_post_2
		getAgentStats	https://www.callfire.com/api-documentation/rest/version/1.1#!/ccc/GetAgentSession_get_22
		getConnectionForAgent	N/A
		loginAgent	N/A
		sendAgentCallBack	N/A
		sendAgentCallBackWithMusicSetting	N/A
		storeAgentResponse	N/A
		updateRatio	N/A

soundFile Service	https://www.callfire.com/service/SoundFileService?wsdl
		convertMp3OrWaveFile	https://developers.callfire.com/docs.html#postFileCampaignSound
		getSoundFile	https://developers.callfire.com/docs.html#getCampaignSoundDataMp3 https://developers.callfire.com/docs.html#getCampaignSoundDataWav
		listExternalIdFiles	https://developers.callfire.com/docs.html#findCampaignSounds
		listFiles	https://developers.callfire.com/docs.html#findCampaignSounds
		removeFile	https://developers.callfire.com/docs.html#deleteCampaignSound
		storeFile	https://developers.callfire.com/docs.html#postFileCampaignSound
		storeFile1	https://developers.callfire.com/docs.html#postFileCampaignSound
		updateFile	N/A	just remove and re-upload new file again

WhiteLabel	https://www.callfire.com/service/WhiteLabelService?wsdl
		createUsers	N/A

CallFire Legacy API Migration

Introduction

Migration Guide

Setup Guide

What’s new

API Mapping