GET BROADCAST SCHEDULE

Gets a BroadcastSchedule by id

This operation lists information about individual Broadcast Schedule attached to a Broadcast.

REQUEST PARAMETERS

Parameter Data type Demo Value Description
GetBroadcastSchedule object BroadcastSchedule request by unique ID
Id long 135 Unique ID of resource

RESPONSE PARAMETERS

Parameter Data Type Description
BroadcastSchedule
id long Unique ID of Broadcast Schedule
StartTimeOfDay time Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX
StopTimeOfDay time Latest time a client can be contacted in the timezone associated with the number's NPA/NXX
TimeZone string Time Zone
BeginDate date Start date of Campaign
EndDate date End date of Campaign
DaysOfWeek List[DayOfWeek] [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string GetBroadcastSchedule()
        {
            long scheduleId = 4; //Your schedule 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/schedule/{0}", scheduleId), Method.GET);

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

The XML returned is:

<r:Resource xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource">

    <BroadcastSchedule id="4">

       <StartTimeOfDay>09:00:00Z</StartTimeOfDay>

       <StopTimeOfDay>18:00:00Z</StopTimeOfDay>

       <TimeZone>America/Los_Angeles</TimeZone>

       <BeginDate>2015-03-01Z</BeginDate>

       <EndDate>2015-03-09Z</EndDate>

       <DaysOfWeek>SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY</DaysOfWeek>

    </BroadcastSchedule>

</r:Resource>