CallFire Solutions

Create Contact Batch

Follow

CREATE CONTACT BATCH

Creates a new Contact Batch

Contact Batch is a list of contacts associated with a broadcast. You can use this operation to attach a list of contacts to an existing Campaign. A list of ToNumbers or an existing Contact List id is required to create and attach the Contact List. The unique contactListId is returned, which can be used in ControlContactBatch to enable or disable this batch.

REQUEST PARAMETERS

ParameterDemo ValueDescriptionData Type
CreateContactBatch   Create ContactBatch using attached info object
RequestId   anyURI
BroadcastId Id of Broadcast long
Name   string
To * List of E.164 11 digit numbers space or comma separated List[PhoneNumber]
ContactListId *   long
ScrubBroadcastDuplicates   boolean

RESPONSE PARAMETERS

ParameterDescriptionData Type
CreatedId Unique ID of resource long

EXAMPLE


using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string CreateContactBatch()
        {
            long broadcastId = 18; //Your Broadcast 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/{0}/batch", broadcastId), Method.POST);
            request.AddParameter("Name", "My Test API ContactBatch Numbers List");
            request.AddParameter("To", "13105551216, 13105551217");
            request.AddParameter("ContactListId", "2");
            request.AddParameter("ScrubBroadcastDuplicates", "true");

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

<?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>2049975003</r:Id>

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

</r:ResourceReference>

Have more questions? Submit a request

Comments