GET BROADCAST

Gets a single Broadcast by id

This operation uses the id returned from CreateBroadcast or from QueryBroadcast to retrieve information on an individual Broadcast. It includes information such as campaign name, type, status, last modified and more. See the Response Parameters table below for a complete list of the data that the GetBroadcast operation returns.

REQUEST PARAMETERS

Parameter Data Type Demo Value Description
GetBroadcast object Broadcast request by unique ID
Id long 135 Unique ID of resource

Response Parameters

Parameter Data Type Description
Broadcast A TEXT, IVR, or VOICE Broadcast
Id long Unique ID of Broadcast
Name string Name of Broadcast
Status BroadcastStatus Status of Broadcast (response only) [START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED]
LastModified dateTime Last Modified 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
Type BroadcastType Type of Broadcast[VOICE, IVR, TEXT]
VoiceBroadcastConfig Configuration needed for a Voice Broadcast
Id long Unique ID of BroadcastConfig
Created dateTime DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
FromNumber PhoneNumber E.164 11 digit number or short code
LocalTimeZoneRestriction Restrict the times your compaign can run
BeginTime time Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig Retry logic for broadcast
MaxAttempts int Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int Minutes between broadcast attempts (default: 60)
RetryResults List[Result] 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]
RetryPhoneTypes List[RetryPhoneType] Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
AnsweringMachineConfig AnsweringMachineConfig Action to take if machine answers[AM_ONLY, AM_AND_LIVE, LIVE_WITH_AMD, LIVE_IMMEDIATE]
LiveSoundText string
LiveSoundId long ID of Sound to play if call answered by live person
LiveSoundTextVoice Voice
MachineSoundText string
MachineSoundId long ID of Sound to play if call answered by machine
MachineSoundTextVoice Voice
TransferSoundText string
TransferSoundId long ID of Sound to play if call transfered
TransferSoundTextVoice Voice
TransferDigit PhoneDigit Phone digit call transfers on if pressed
TransferNumber PhoneNumber Number to transfer call to
DncSoundText string
DncSoundId long Do Not Call unique ID of sound
DncSoundTextVoice Voice
DncDigit PhoneDigit Do Not Call Digit
MaxActiveTransfers int Max Transfers
TextBroadcastConfig Configuration needed for a Text Broadcast
Id long Unique ID of BroadcastConfig
Created dateTime DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
FromNumber PhoneNumber E.164 11 digit number or short code
LocalTimeZoneRestriction Restrict the times your compaign can run
BeginTime time Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig Retry logic for broadcast
MaxAttempts int Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int Minutes between broadcast attempts (default: 60)
RetryResults List[Result] 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]
RetryPhoneTypes List[RetryPhoneType] Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
Message string 160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response
BigMessageStrategy BigMessageStrategy Set strategy if message is over 160 chars (default: SEND_MULTIPLE)[SEND_MULTIPLE, DO_NOT_SEND, TRIM]
IvrBroadcastConfig Configuration needed for an IVR Broadcast
Id long Unique ID of BroadcastConfig
Created dateTime DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
FromNumber PhoneNumber E.164 11 digit number or short code
LocalTimeZoneRestriction Restrict the times your compaign can run
BeginTime time Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig Retry logic for broadcast
MaxAttempts int Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int Minutes between broadcast attempts (default: 60)
RetryResults List[Result] 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]
RetryPhoneTypes List[RetryPhoneType] Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
DialplanXml string IVR xml document describing dialplan
CccBroadcastConfig Configuration needed for a CCC Broadcast
Id long Unique ID of BroadcastConfig
Created dateTime DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]'
FromNumber PhoneNumber E.164 11 digit number or short code
LocalTimeZoneRestriction Restrict the times your compaign can run
BeginTime time Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
EndTime time Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
RetryConfig Retry logic for broadcast
MaxAttempts int Max attempts to retry broadcast (default: 1)
MinutesBetweenAttempts int Minutes between broadcast attempts (default: 60)
RetryResults List[Result] 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]
RetryPhoneTypes List[RetryPhoneType] Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
AgentGroupId long Unique ID of AgentGroup
SmartDropSoundId long Unique ID of SmartDropSound
ScriptId long Unique ID of Script
TransferNumberIdList List[long] ID List of TransferNumbers
PowerDialingRatio decimal Power Dialing Ratio (default: 1)
AllowAnyTransfer boolean Allow any transfer
Recorded boolean Recorded

EXAMPLE

Setup and send Request

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string GetBroadcast()
        {
            long broadcastId = 18; //Your Broadcast Id here

            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest(string.Format("broadcast/{0}", broadcastId), Method.GET);

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

The XML returned is:

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

    <Broadcast id="18">

       <Name>broadcastRest</Name>

       <Status>STOPPED</Status>

       <LastModified>2014-06-05T16:49:33Z</LastModified>

       <Type>TEXT</Type>

       <TextBroadcastConfig>

          <FromNumber>67076</FromNumber>

          <Message>Test</Message>

       </TextBroadcastConfig>

    </Broadcast>

</r:Resource>