CallFire has a new API!
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.
Broadcast can be set to run at scheduled times a prescribed by BroadcastSchedule.
Can pick start time, stop time, begin date, and day of week. Returns broadcastScheduleId
that can be used in GetBroadcastSchedule and DeleteBroadcastSchedule
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| CreateBroadcastSchedule | Create BroadcastSchedule using attached info | object | |
| RequestId | anyURI | ||
| BroadcastId | long | ||
| BroadcastSchedule | object | ||
| id | Unique ID of Broadcast Schedule | long | |
| StartTimeOfDay | Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX | time | |
| StopTimeOfDay | Latest time a client can be contacted in the timezone associated with the number's NPA/NXX | time | |
| TimeZone | Time Zone | string | |
| BeginDate | Start date of Campaign | date | |
| EndDate | End date of Campaign | date | |
| DaysOfWeek | [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY] | List[DayOfWeek] |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| CreatedId | Unique ID of resource | long |
<?php
/**
* 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'));
/**
* CreateBroadcastSchedule
*/
$request = new stdclass();
$request->BroadcastId = 3; // required
$request->BroadcastSchedule = new stdclass(); // required
$request->BroadcastSchedule->id = 1; // Unused.
$request->BroadcastSchedule->StartTimeOfDay = '09:00:00'; // required
$request->BroadcastSchedule->StopTimeOfDay = '17:00:00'; // required
$request->BroadcastSchedule->TimeZone = 'xxx'; // required
// $request->BroadcastSchedule->BeginDate = '2013-01-30';
// $request->BroadcastSchedule->EndDate = '2013-01-30';
$request->BroadcastSchedule->DaysOfWeek = array(DayOfWeek); // required [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]
$broadcastScheduleId = $client->CreateBroadcastSchedule($request);
echo "broadcastScheduleId: " . $broadcastScheduleId;
// Sample response:
// broadcastScheduleId: 3
?>