CREATE BROADCAST

Creates a new Broadcast

This operation creates a new Broadcast campaign and returns a broadcastId. To see the status of this campaign call GetBroadcast with the returned broadcastId.

There are 3 types of Broadcast: TEXT, IVR, or VOICE. Select the appropriate configuration to match the broadcast type, TextBroadcastConfig, IvrBroadcastConfig, or VoiceBroadcastConfig. Prefer the Text Service operations (ex: SendText) and Call Service operations (ex: SendCall) over this operation when managing simple text and call campaigns since those operations are simpler and more concise.

Request Parameters

Response Parameters

Example

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {

        // Simple example
        public string CreateBroadcast1()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("broadcast", Method.POST);
            request.AddParameter("Name", "Example simple TextBroadcast");
            request.AddParameter("Type", "TEXT");
            request.AddParameter("Message", "Hello, just testing broadcast");
            request.AddParameter("ScrubBroadcastDuplicates", "true");

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

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

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

    <r:Id>2826971003</r:Id>

<r:Location>https://www.callfire.com/api/1.1/rest/broadcast/2826971001</r:Location>

</r:ResourceReference>

Example

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        // A little more complicated example with text to speech
        public string CreateBroadcast2()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("broadcast", Method.POST);
            request.AddParameter("Name", "Test Broadcast Service (text to speech)");
            request.AddParameter("Type", "VOICE");
            request.AddParameter("From ", "9206596476");
            request.AddParameter("MaxAttempts ", "5");
            request.AddParameter("MinutesBetweenAttempts", "10");
            request.AddParameter("RetryResults", "BUSY");
            request.AddParameter("AnsweringMachineConfig", "LIVE_IMMEDIATE");
            request.AddParameter("LiveSoundText", "Hello, just testing broadcast for a person answer");
            request.AddParameter("MachineSoundText", "Hello, just testing broadcast for an machine answer");
            request.AddParameter("MachineSoundTextVoice", "FEMALE2");
            request.AddParameter("TransferSoundText", "Hello, just testing broadcast for transfer");
            request.AddParameter("TransferSoundTextVoice ", "FEMALE2");
            request.AddParameter("TransferDigit", "8");
            request.AddParameter("TransferNumber", "2135551212");
            request.AddParameter("ScrubBroadcastDuplicates", "true");

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

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

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

    <r:Id>2826971003</r:Id>

<r:Location>https://www.callfire.com/api/1.1/rest/broadcast/2826971003</r:Location>

</r:ResourceReference>