CallFire Solutions

Query Broadcasts

Follow

QUERY BROADCASTS

Lists existing Broadcasts

Use this operation to see the status of Broadcasts in the account. You can filter by type of campaign that is currently running. It returns a list of Broadcast information such as campaign name, type, status, total results and more. See the Response Parameters table below for a complete list of data that the QueryBroadcast operation returns.

REQUEST PARAMETERS

ParameterDemo ValueDescriptionData Type
QueryBroadcasts   Broadcasts request by query object
MaxResults Max number of results to return limited to 1000 (default: 1000) long
FirstResult Start of next result set (default: 0) long
Type [VOICE, IVR, TEXT] List[BroadcastType]
Running Filter on running Broadcasts boolean
LabelName Label that result must have to be included string

Response Parameters

ParameterDescriptionData Type
BroadcastQueryResult List of Broadcasts returned from query  
TotalResults Results count long
Broadcast A TEXT, IVR, or VOICE Broadcast  
Id Unique ID of Broadcast long
Name Name of Broadcast string
Status Status of Broadcast (response only)[START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED] BroadcastStatus
LastModified Last Modified 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' dateTime
Type Type of Broadcast[VOICE, IVR, TEXT] BroadcastType
VoiceBroadcastConfig Configuration needed for a Voice Broadcast  
Id Unique ID of BroadcastConfig long
Created DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' dateTime
FromNumber E.164 11 digit number or short code PhoneNumber
LocalTimeZoneRestriction Restrict the times your compaign can run  
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  
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, SENT, RECEIVED, DNT, TOO_BIG, 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
TextBroadcastConfig Configuration needed for a Text Broadcast  
Id Unique ID of BroadcastConfig long
Created DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' dateTime
FromNumber E.164 11 digit number or short code PhoneNumber
LocalTimeZoneRestriction Restrict the times your compaign can run  
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  
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, SENT, RECEIVED, DNT, TOO_BIG, 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]
Message 160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response string
BigMessageStrategy Set strategy if message is over 160 chars (default: SEND_MULTIPLE)[SEND_MULTIPLE, DO_NOT_SEND, TRIM] BigMessageStrategy
IvrBroadcastConfig Configuration needed for an IVR Broadcast  
Id Unique ID of BroadcastConfig long
Created DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' dateTime
FromNumber E.164 11 digit number or short code PhoneNumber
LocalTimeZoneRestriction Restrict the times your compaign can run  
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  
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, SENT, RECEIVED, DNT, TOO_BIG, 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
CccBroadcastConfig Configuration needed for a CCC Broadcast  
Id Unique ID of BroadcastConfig long
Created DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' dateTime
FromNumber E.164 11 digit number or short code PhoneNumber
LocalTimeZoneRestriction Restrict the times your compaign can run  
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  
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, SENT, RECEIVED, DNT, TOO_BIG, 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]
AgentGroupId Unique ID of AgentGroup long
SmartDropSoundId Unique ID of SmartDropSound long
ScriptId Unique ID of Script long
TransferNumberIdList ID List of TransferNumbers List[long]
PowerDialingRatio Power Dialing Ratio (default: 1) decimal
AllowAnyTransfer Allow any transfer boolean
Recorded Recorded boolean

EXAMPLE


using RestSharp;

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

            var request = new RestRequest("broadcast", Method.GET);
            request.AddParameter("MaxResults", "100");
            request.AddParameter("FirstResult", "21");
            request.AddParameter("Type", "VOICE");
            request.AddParameter("Running", "true");

            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:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="309">

    <Broadcast id="1903346001">

       <Name>broadcastSoap</Name>

       <Status>STOPPED</Status>

       <LastModified>2014-06-05T16:51:32Z</LastModified>

       <Type>TEXT</Type>

       <TextBroadcastConfig>

          <FromNumber>67076</FromNumber>

          <LocalTimeZoneRestriction>

             <BeginTime>16:51:32Z</BeginTime>

             <EndTime>16:51:32Z</EndTime>

          </LocalTimeZoneRestriction>

          <Message>Test</Message>

       </TextBroadcastConfig>

    </Broadcast>

</r:ResourceList>

Have more questions? Submit a request

Comments