SEND CALL

Creates a call broadcast, adds numbers to it, and sends it immediately

You can start sending calls using VoiceBroadcastConfig or by setting up an IVR using IvrBroadcastConfig. Sending a call requires at least a ToNumber and a sound id or an IVR. The returned broadcastId can be passed to QueryCalls to get the state of the call actions in a campaign and get a list of individual callIds for use in a GetCall request. The broadcastId can also be passed to GetBroadcastStats to get information about the call campaign, such as BilledAmount, Duration, State, etc.

REQUEST PARAMETERS

Parameter Data Type Demo Value Description
SendCall object
RequestId anyURI MyUniqueIdForThisRequest Unique ID, used to de-dup requests and make sure request is not processed twice
Type BroadcastType TEXT Type of Broadcast [VOICE, IVR, TEXT]
BroadcastName string My Send Broadcast Title of Broadcast (default: API Send)
To List[PhoneNumber] +13105551213,+18185551213 List of E.164 11 digit numbers space or comma separated
ScrubBroadcastDuplicates boolean false Scrub duplicates (default: false)
MaxActive int 50 Max simultaneous calls
VoiceBroadcastConfig * object Configuration needed for a Voice Broadcast
Id long 1 Unique ID of BroadcastConfig
Created dateTime 2012-10-26T21:32:52Z DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
From PhoneNumber 13105551212 E.164 11 digit number or short code
LocalTimeZoneRestriction object Restrict the times your compaign can run
BeginTime time 09:00:00 Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time 17:00:00 Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig object Retry logic for broadcast
MaxAttempts int 1 Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int 60 Minutes between broadcast attempts (default: 60)
RetryResults List[Result] BUSY NO_ANS Conditions to retry on[LA, AM, BUSY, DNC, XFER, XFER_LEG, NO_ANS, UNDIALED, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, SD, POSTPONED]
RetryPhoneTypes List[RetryPhoneType] FIRST_NUMBER HOME_PHONE Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
AnsweringMachineConfig AnsweringMachineConfig LIVE_IMMEDIATE Action to take if machine answers[AM_ONLY, AM_AND_LIVE, LIVE_WITH_AMD, LIVE_IMMEDIATE]
LiveSoundText * string
LiveSoundId * long 123 ID of Sound to play if call answered by live person
LiveSoundTextVoice Voice
MachineSoundText * string
MachineSoundId * long 124 ID of Sound to play if call answered by machine
MachineSoundTextVoice Voice
TransferSoundText * string
TransferSoundId * long 125 ID of Sound to play if call transfered
TransferSoundTextVoice Voice
TransferDigit PhoneDigit 1 Phone digit call transfers on if pressed
TransferNumber PhoneNumber 18185551212 Number to transfer call to
DncSoundText * string
DncSoundId * long 12345 Do Not Call unique ID of sound
DncSoundTextVoice Voice
DncDigit PhoneDigit 9 Do Not Call Digit
MaxActiveTransfers int 1 Max Transfers
IvrBroadcastConfig * object Configuration needed for an IVR Broadcast
Id long 1 Unique ID of BroadcastConfig
Created dateTime 2012-10-26T21:32:52Z DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
From PhoneNumber 13105551212 E.164 11 digit number or short code
LocalTimeZoneRestriction object Restrict the times your compaign can run
BeginTime time 09:00:00 Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time 17:00:00 Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig object Retry logic for broadcast
MaxAttempts int 1 Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int 60 Minutes between broadcast attempts (default: 60)
RetryResults List[Result] BUSY NO_ANS Conditions to retry on[LA, AM, BUSY, DNC, XFER, XFER_LEG, NO_ANS, UNDIALED, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, SD, POSTPONED]
RetryPhoneTypes List[RetryPhoneType] FIRST_NUMBER HOME_PHONE Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
DialplanXml string IVR xml document describing dialplan

RESPONSE PARAMETERS

Parameter Data Type Description
CreatedId long Unique ID of resource

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string SendCall()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("call", Method.POST);
            request.AddParameter("Type", "VOICE");
            request.AddParameter("BroadcastName", "Test API SendCall Broadcast");
            request.AddParameter("To", "18185551212");
            request.AddParameter("From", "13105551212");
            request.AddParameter("AnsweringMachineConfig", "LIVE_IMMEDIATE");
            request.AddParameter("LiveSoundId", "9");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceReference xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource">

    <r:Id>2838887003</r:Id>

<r:Location>https://www.callfire.com/api/1.1/rest/broadcast/2838887003</r:Location>

</r:ResourceReference>