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
Parameter | Data Type | Demo Value | Description |
---|---|---|---|
UpdateBroadcast | object | Update Broadcast using attached info | |
RequestId | anyURI | MyUUIDForDeDupping | Unique ID of web request to de-dup on |
Broadcast | object | A TEXT, IVR, or VOICE Broadcast | |
Id | long | 1 | Unique ID of Broadcast |
Name | string | My Test Broadcast | Name of Broadcast |
Status | BroadcastStatus | FINISHED | Status of Broadcast (response only)[START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED] |
LastModified | dateTime | 2012-10-26T21:32:52Z | Last Modified 'CCYY-MM-DDThh:mm:ss[Z(+/-)hh:mm]' |
Type | BroadcastStatus | TEXT | Type of Broadcast[VOICE, IVR, TEXT] |
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]' |
FromNumber | 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 |
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 |
TextBroadcastConfig * | object | Configuration needed for a Text 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]' |
FromNumber | 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[SENT, RECEIVED, DNT, TOO_BIG, 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] |
Message | string | use your phone to text YOUR_KEYWORD to 67076, and we'll send you special coupons that you can use in our store. | 160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response |
BigMessageStrategy | BigMessageStrategy | SEND_MULTIPLE | Set strategy if message is over 160 chars (default: SEND_MULTIPLE)[SEND_MULTIPLE, DO_NOT_SEND, TRIM] |
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]' |
FromNumber | 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 | |
CccBroadcastConfig * | object | Configuration needed for a CCC 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]' |
FromNumber | 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, SENT, RECEIVED, DNT, TOO_BIG, 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] |
AgentGroupId | long | 222 | Unique ID of AgentGroup |
SmartDropSoundId | long | 222 | Unique ID of SmartDropSound |
ScriptId | long | true | Unique ID of Script |
TransferNumberIdList | List[long] | 2 5 8 | ID List of TransferNumbers |
PowerDialingRatio | decimal | 1.0 | Power Dialing Ratio (default: 1) |
AllowAnyTransfer | boolean | true | Allow any transfer |
Recorded | boolean | true | Recorded |
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.