GET CONTACT BATCH

Gets a ContactBatch by id

This operation allows retrieving information on individual Contact Batch using contactId, which is returned from CreateContactBatch.

REQUEST PARAMETERS

Parameter Data Type Demo Value Description
GetContactBatch object ContactBatch request by unique ID
Id long 135 Unique ID of resource

RESPONSE PARAMETERS

Parameter Data Type Description
ContactBatch
Id long
Name string Name of Contact Batch
Status BatchStatus [NEW, VALIDATING, ERRORS, SOURCE_ERROR, ACTIVE]
BroadcastId long ID of Broadcast this Batch is attached to
Created dateTime
Size int Contact count in this Batch
Remaining int

EXAMPLE

using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string GetContactBatch()
        {
            long contactBatchId = 3; //Your Contact Batch 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/batch/{0}", contactBatchId), 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">

    <Broadcast id="1902607001">

       <Name>broadcastSoap</Name>

       <Status>ARCHIVED</Status>

       <LastModified>2014-12-16T11:58:39Z</LastModified>

       <Type>TEXT</Type>

          <TextBroadcastConfig>

          <FromNumber>67076</FromNumber>

          <Message>Test</Message>

       </TextBroadcastConfig>

    </Broadcast>

</r:Resource>