Send split test campaign to address book with progress

The SendSplitTestCampaignToAddressBookWithProgress method sends a split test campaign to a specified address book or address books and allows you to track the progress of the send.

Guidance Notes

The returned token (a GUID) can be used to query send progress by calling GetCampaignSendProgress.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser-908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
campaignId	id	The ID number of the campaign you wish to send.	required
addressBookIds	array-int	An array of the addressbooks you want to send the campaign to.
sendDate	dateTime	The date and time you wish the campaign to be sent (server time).	required
testPercentage	int	This is the percentage of recipients you wish to test the campaign against and must be an integer between 1 and 60 (inclusive).	required
testPeriodHours	int	This is the time period (number of hours) that you would like to split test the campaign over and must be an integer between 1 and 24 (inclusive).	required
testMetric	Opens or Clicks	This determines whether you want to gauge the test based on opens or number of clicks in the campaign.	required

Return values

result

guid

The returned token (a GUID) can be used to query send progress by calling GetCampaignSendProgres.

Error responses

ERROR_ADDRESSBOOK_NOT_FOUND
ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_CAMPAIGN_SENDNOTPERMITTED
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendSplitTestCampaignToAddressBookWithProgress"

Example of use in C# .NET

/// <summary>
/// This method sends a split test campaign to a specified address books 
/// and allows you to track the progress of the send. 
/// </summary>
public void SendSplitTestCampaignToAddressBookWithProgress()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
 
    Console.WriteLine("SendCampaignToAddressBooksWithProgress");
    Console.WriteLine("--------------------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // create a list of address book ids, that we want to send the campaign to 
        int[] addressBookIds = new[]
                                   {
                                       1       
                                   };
 
        // we want the campaign to be sent as soon as (remember the web service expects UTC time)
        DateTime sendDate = DateTime.UtcNow;
 
        // instruct the web service to send the campaign
        // we want 50% of contacts to be sent the campaign as a test
        // we want to also track the number of opens
        // and we also want to send the test over 3 hours
        Guid sendGuid = api.SendSplitTestCampaignToAddressBookWithProgress(username, password, campaignId, 
                                                                                               addressBookIds,
                                                                                               sendDate,
                                                                                               50,
                                                                                               3,
                                                                                               com.apiconnector.APISplitTestMetric.Opens);
 
 
        // did we get something meaningful back
        if (sendGuid != Guid.Empty)
        {
            // get the first status
            com.apiconnector.SendProgress progress = api.GetCampaignSendProgress(username, password, sendGuid);
 
            // are we still waiting
            while (progress != com.apiconnector.SendProgress.Sent && progress != com.apiconnector.SendProgress.Cancelled)
            {
                // poll for the progress
                progress = api.GetCampaignSendProgress(username, password, sendGuid);
 
                // output something, so the user doesn't think we have died
                Console.Write(".");
 
                //
                // check every 60 seconds
                //
                System.Threading.Thread.Sleep(60000);
            }
 
            // display the final output
            Console.WriteLine();
            Console.WriteLine("Final Progress {0}", progress);
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendSplitTestCampaignToAddressBookWithProgress"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendSplitTestCampaignToAddressBookWithProgress xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <addressBookIds>
        <int>int</int>
        <int>int</int>
      </addressBookIds>
      <sendDate>dateTime</sendDate>
      <testPercentage>int</testPercentage>
      <testPeriodHours>int</testPeriodHours>
      <testMetric>Opens or Clicks</testMetric>
    </SendSplitTestCampaignToAddressBookWithProgress>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendSplitTestCampaignToAddressBookWithProgressResponse xmlns="http://apiconnector.com">
      <SendSplitTestCampaignToAddressBookWithProgressResult>guid</SendSplitTestCampaignToAddressBookWithProgressResult>
    </SendSplitTestCampaignToAddressBookWithProgressResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates