VoIP Applications
This document will go over how to create a VoIP based voice broadcast API campaign, along with sample code.
Quick Links
Pre-Requisites
- Create an account on callfire.com
- Get your API Key from the Account Page.
- Make sure you have enough funds in your account for the volume you will dial.
VoIP Voice Broadcast Functions
Send Voice Broadcast to List - sendBroadcastToList
This function will allow you to send a broadcast out to the phone numbers you specify. The sound file provided will be played back to live pickups and be left as a message on answering machines.
Warning: This function will automatically start the campaign! Only call this if you are ready to broadcast right away.
- Live Answer and Answering Machine Detection
- Playback sound to Live Pickup and leave a message to Answering Machines
- Use your own Callerid
- Campaign STARTS automatically
Create Voice Broadcast to List - createBroadcastToNumbers
Same as sendBroadcastToList, except the campaign is not started immediately. This function will create a broadcast to the phone numbers you specify. The sound file provided will be played back to live pickups and be left as a message on answering machines.
- Live Answer and Answering Machine Detection
- Playback sound to Live Pickup and leave a message to Answering Machines
- Use your own Callerid
- Campaign DOES NOT start automatically
Create Voice Broadcast with Transfer - createBroadcastWithTransfer
This will create a voice broadcast campaign with the capability to transfer. Plays back a unique file for Live Answer and Answering Machine.
- Live Answer and Answering Machine Detection
- Leave different messages for Live Answer and Answering Machine
- Detect any digit from the user to transfer to your number
- Playback a file when user chooses the transfer digit
- Use your own Callerid
- Campaign DOES NOT start automatically
Create Voice Broadcast with Transfer and DNC - createBroadcastWithTransferDNC
This function will create a broadcast to the phone numbers you specify, it allows an option to transfer and add to the DNC List. The sound file provided will be played back to live pickups and be left as a message on answering machines. On live answer, the user can select a digit to transfer to your call center or press another digit to be marked as Do Not Call.
- Live Answer and Answering Machine Detection
- Leave different messages for Live Answer and Answering Machine
- Detect any digit from the user to transfer to your number
- Detect any digit from the user to mark as Do-Not-Call
- Playback a file when user chooses the transfer digit
- Playback a file when user chooses the Do-Not-Call Digit
- Use your own Callerid
- Campaign DOES NOT start automatically
Create Voice Broadcast with Single Question and receive the results - creategenerateSinglQuestionPoll or createSinglQuestionPoll
This function will create a broadcast to the phone numbers you specify, it allows customers to select one of three options. The sound file provided will be played back to live pickups and be left as a message on answering machines. On live answer, the user can select one of the digits that are valid and the response will be recorded as a "callstatus" string you specify.
- Live Answer and Answering Machine Detection
- Leave different messages for Live Answer and Answering Machine
- Detect any 3 digits from the user to mark the call with a callstatus
- Specifiy the string to mark the callstatus field for the digit pressed. (ex. press 1 and set the callstatus to "ACCEPTED")
- Playback a file when user chooses one of the digits
- Use your own Callerid
- Campaign DOES NOT start automatically
Start Campaign - startCampaign
Use this function to start a campaign that you created or stopped in the past.
Stop Campaign - stopCampaign
Stops a campaign.
Update Speed - updateSpeed
Use this function to change the speed of your campaign. You can specify the calls per minute.
Add Numbers to Campaign - addNumbersToCampaign
If you need to add more numbers to an existing campaign, use this to upload additional phone numbers.
getRunningCampaignList
Returns a list of Running Campaigns and their statistics.
getFullCampaignList
Returns a list of all your campaigns and their statistics.
