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 |
||||
|
sendSMSCampaign |
||||
|
Inbound Calls |
||||
|
purchaseSingleNumber |
||||
|
forwardSingleNumber |
https://developers.callfire.com/docs.html#updateNumberLeaseConfig |
|||
|
Rest API |
( base url: https://www.callfire.com/cloud/1 ) |
|||
|
SMS API |
||||
|
POST /sms/send |
||||
|
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 |
||||
|
Callbacks |
||||
|
POST /reports/callback/callfinish |
||||
|
POST /reports/callback/callfinish/{campaignid} |
||||
|
POST /reports/callback/campaignfinish |
https://developers.callfire.com/docs.html#createWebhook https://developers.callfire.com/docs.html#getCallBroadcastStats |
|||
|
Phone Numbers |
||||
|
GET /inbound/numbers |
https://developers.callfire.com/docs.html#findNumbersLocal https://developers.callfire.com/docs.html#findNumbersTollfree |
|||
|
POST /inbound/numbers |
||||
|
Reports |
||||
|
GET /reports/calls/{campaignid} |
||||
|
GET /reports/calls/finished/{campaignid} |
||||
|
GET /reports/call/{callid} |
||||
|
Recording and Files |
||||
|
GET /files/recording/list/{campid}/{callid} |
||||
|
GET /files/recording/{fileid} |
||||
|
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 |
||||
|
Campaign Service |
||||
|
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 |
||||
|
sendSingleBridgeCall |
use IVR to setup transfer |
|||
|
sendSingleCallCampaign |
||||
|
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 |
||||
|
updateSpeed |
https://developers.callfire.com/docs.html#updateCallBroadcast |
use update operation to set corresponding campaign setting |
||
|
Click to Call |
||||
|
createClickToCallCampaign |
N/A |
|||
|
sendConnection |
N/A |
|||
|
GET https://www.callfire.com/service/clicktocall/sendconnect |
N/A |
|||
|
Direct Connect |
||||
|
agentLogin |
N/A |
|||
|
agentLoginWithMusicOnHold |
N/A |
|||
|
barge |
N/A |
|||
|
bridgeCall |
N/A |
|||
|
deBridgeCall |
N/A |
|||
|
getAgentInfo |
N/A |
|||
|
getAgentId |
N/A |
|||
|
getAgentList |
N/A |
|||
|
kickAgent |
N/A |
|||
|
sendAMCallToSound |
N/A |
|||
|
sendAMCallToSoundDirect |
N/A |
|||
|
redirectCall |
N/A |
|||
|
startCampaign |
N/A |
|||
|
stopCampaign |
N/A |
|||
|
List Service |
||||
|
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 |
||||
|
addList |
||||
|
clearList |
https://developers.callfire.com/docs.html#removeContactListItems |
|||
|
Record Service |
||||
|
getRecording |
||||
|
getRecordingByCallid |
||||
|
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 |
||||
|
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 |
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 |
||||
|
answeringMachineTransferStoreAgentResponse |
N/A |
|||
|
createCallCenterConnectCampaign |
N/A |
|||
|
createCallCenterConnectCampaignWithAM |
N/A |
|||
|
getAgentStats |
N/A |
|||
|
getConnectionForAgent |
N/A |
|||
|
loginAgent |
N/A |
|||
|
sendAgentCallBack |
N/A |
|||
|
sendAgentCallBackWithMusicSetting |
N/A |
|||
|
storeAgentResponse |
N/A |
|||
|
updateRatio |
N/A |
|||
|
soundFile Service |
||||
|
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 |
||||
|
createUsers |
N/A |