CallFire Solutions

Send Call

Follow

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

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

RESPONSE PARAMETERS

ParameterDescriptionData Type
CreatedId Unique ID of resource long

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>

Have more questions? Submit a request

Comments