GetCampaignSendProgress

Gets a campaign send status using send ID

This method gets the progress of a sent campaign by the campaign's send ID. It will return a status indicating where the campaign is in the sending process.

SOAP action: http://apiconnector.com/v2/ApiService/GetCampaignSendProgress

πŸ“˜

Input and output parameters

The input and output parameters for this method are:

Input parameters

  • Send ID - required; GUID

Output parameters

  • GetCampaignSendProgressResult
    • Id - GUID
    • CampaignId - integer
    • AddressBooks - array of integers
      • integer
    • ContactIds - array of integers
      • integer
    • SendDate - dateTime
    • SplitTestOptions
      • TestMetric - string ('Opens', 'Clicks')
      • TestPercentage - integer
      • TestPeriodHours - integer
    • Status - string ('NotSent', 'Scheduled', 'Sending', 'Sent', 'Cancelled')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var campaignSend = new ApiCampaignSend();
	var sentCampaign = client.SendCampaign(campaignSend);
	while (sentCampaign.Status == ApiCampaignSendStatuses.NotSent)
	{
	    Thread.Sleep(60000);
	    sentCampaign = client.GetCampaignSendProgress(sentCampaign.Id);
	}
}