QueryBroadcastSchedule

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.

QueryBroadcastSchedule

Lists existing BroadcastSchedules

List information about Broadcast Schedules attached to a Broadcast.

Request Parameters

Parameter Demo Value Description Data Type
QueryBroadcastSchedules BroadcastSchedules request by query object
MaxResults Max number of results to return limited to 1000 (default: 1000) long
FirstResult Start of next result set (default: 0) long
BroadcastId Unique ID of Broadcast long

* indicates choice value, bolded parameters are required

Response Parameters

Parameter Description Data Type
BroadcastScheduleQueryResult List of BroadcastSchedules returned from query
TotalResults Results count long
BroadcastSchedule
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]

 

Example Code

	<?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'));


/**
 * QueryBroadcastSchedule
 */
$query = new stdclass();
$query->MaxResults = 2;   
$query->FirstResult = 0;   
$query->BroadcastId = 3; // required  

$response = $client->QueryBroadcastSchedule($query);
print_r($response);

// Sample response:
//
// stdClass Object (
// 	[TotalResults] => 2
// 	[BroadcastSchedule] => Array(
// 		[0] => stdClass Object (
// 			[StartTimeOfDay] => 09:00:00-08:00
// 			[StopTimeOfDay] => 17:00:00-08:00
// 			[TimeZone] => America/Los_Angeles
// 			[BeginDate] => 2013-03-06-08:00
// 			[DaysOfWeek] => SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY
// 			[id] => 2
// 		)
// 		[1] => stdClass Object (
// 			[StartTimeOfDay] => 09:00:00-08:00
// 			[StopTimeOfDay] => 17:00:00-08:00
// 			[TimeZone] => PST
// 			[BeginDate] => 2013-03-08-08:00
// 			[DaysOfWeek] => MONDAY TUESDAY WEDNESDAY
// 			[id] => 3
// 		)
// 	)
// )


?>