Get campaign send progress

The GetCampaignSendProgress method can be used to query the progress of a campaign being sent. It will return a status indicating where the campaign is in the sending process.

This method is particularly useful if you need to perform actions such as collect reporting once a campaign has finished sending. As it informs you of where the campaign is in the current sending process.

Guidance Notes

The progressID must be a valid GUID that has been returned to you by calling SendCampaignToAddressBooksWithProgress or SendSplitTestCampaignToAddressBookWithProgress. The campaign's status will be one of NotSent, Scheduled, Sent or Cancelled.

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
progressId	guid	This is the the GUID which is returned to you when you call any of our WithProgress methods.	required

Return values

result

NotSend or Scheduled or Sending or Sent or Cancelled

Error responses

ERROR_CAMPAIGN_NOT_FOUND
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/GetCampaignSendProgress"

Example of use in C# .NET

/// <summary>
/// This method can be used to query the progress of a campaign being sent. 
/// It will return a status indicating where the campaign is in the sending process. 
/// </summary>
public void GetCampaignSendProgress()
{
    /* see SendCampaignToAddressBooksWithProgress 
     * for an example of this method
     */
}

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/GetCampaignSendProgress"
<?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>
    <GetCampaignSendProgress xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <progressID>guid</progressID>
    </GetCampaignSendProgress>
  </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>
    <GetCampaignSendProgressResponse xmlns="http://apiconnector.com">
      <GetCampaignSendProgressResult>NotSent or Scheduled or Sending or Sent or Cancelled</GetCampaignSendProgressResult>
    </GetCampaignSendProgressResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates