CallFire Solutions

Update Broadcast

Follow

UPDATE BROADCAST

Updates an existing Broadcast's configuration

Update existing broadcast's configuration such as time zone restrictions or retry logic. Currently all the fields from the configuration are updated, so the 'Message' field needs to be populated just like in the CreateBroadcast operation.

You should use an unique id to specify broadcast. You need to provide a dummy 'Name' field Broadcast even though the field will not be overwritten.

REQUEST PARAMETERS

ParameterDemo ValueDescriptionData Type
UpdateBroadcast   Update Broadcast using attached info object
RequestId Unique ID of web request to de-dup on anyURI
Broadcast   A TEXT, IVR, or VOICE Broadcast object
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 object
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 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
TextBroadcastConfig *   Configuration needed for a Text Broadcast object
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 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[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 object
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 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
CccBroadcastConfig *   Configuration needed for a CCC Broadcast object
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 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, 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 UpdateBroadcast()
        {
            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.PUT);
            request.AddParameter("Name", "Sample Outbound SMS Broadcast");
            request.AddParameter("Type", "TEXT");
            request.AddParameter("LocalRestrictBegin", "09:00:00");
            request.AddParameter("LocalRestrictEnd", "17:00:00");

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

The XML returned is:

[To be completed]

//Important: UpdateBroadcast doesn't work on the REST Documentation. This issue was reported on the previous project. This should be fixed. I will not be able to complete the response until this is fixed

Have more questions? Submit a request

Comments