We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Update existing broadcast's configuration such as time zone restrictions
or retry logic. Currently all fields from config are updated so the 'Message'
field needs to be populated just like in CreateBroadcast operation.
Use unique ID to specify broadcast. Need to provide dummy 'Name' field Broadcast
even though the field will not be overwritten.
Testing this method using swagger doc REST interface (Try Me! button) does not work correctly.
Please use curl or other rest client to test api call.
Update Broadcast using attached info
Unique ID of web request to de-dup on
A TEXT, IVR, or VOICE Broadcast
Unique ID of Broadcast
Name of Broadcast
Status of Broadcast (response only)[START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED, TEST, SETUP, SCHEDULED, SUSPENDED, VALIDATING_EMAIL, VALIDATING_START, BLOCKED_SUSPICIOUS, APPROVED, DECLINED]
Last Modified 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'
Type of Broadcast[VOICE, IVR, TEXT, CCC]
Labels on Broadcast
If 'true' resumes the unfinished campaign to the next day
Configuration needed for a Voice Broadcast
Unique ID of BroadcastConfig
DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'
E.164 11 digit number or short code
Restrict the times your compaign can run
Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE]
Unique ID of AgentGroup
Unique ID of SmartDropSound
Unique ID of Script
ID List of TransferNumbers
Allow any transfer
Transfer caller Id
* indicates choice value, bolded parameters are required
* You'll need your login/password pair when you create the SOAP client.
* Don't use the fake login/password provided here; it's just for show and
* won't work.
$wsdl = "http://callfire.com/api/1.1/wsdl/callfire-service-http-soap12.wsdl";
$client = new SoapClient($wsdl, array(
'soap_version' => SOAP_1_2,
'login' => 'YourLoginId',
'password' => 'YourPassword'));
* UpdateBroadcast. Update existing broadcast updates all fields therefore the
* same fields needed in create are needed here, like Name and Message.
$request = new stdclass();
$request->Broadcast = new stdclass(); // required
$request->Broadcast->id = 3;
$request->Broadcast->Name = 'Sample Outbound SMS Broadcast';
$request->Broadcast->TextBroadcastConfig = new stdclass(); // required choice
$request->Broadcast->TextBroadcastConfig->Message = 'Hi Birdie #2';
$request->Broadcast->TextBroadcastConfig->LocalTimeZoneRestriction = new stdclass();
$request->Broadcast->TextBroadcastConfig->LocalTimeZoneRestriction->BeginTime = '09:00:00';
$request->Broadcast->TextBroadcastConfig->LocalTimeZoneRestriction->EndTime = '17:00:00';
// No response from UpdateBroadcast