List hard bouncing contacts with labels

The ListHardBouncingContactsWithLabels method is obsolete please use ListHardBouncingContactsWithLabels2.

This method retrieved a list of all the contacts who hard bounced when sent a specified campaign along with any specified data labels.

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	int	This is the Id of the campaign you wish to query against.	required
labels	array-string	The names of the data fields you want to get the data for.	required

Return values

The result is an array of contact objects.

Error responses

ERROR_CAMPAIGN_INVALID
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/ListHardBouncingContactsWithLabels"

Example of use in C# .NET

/// <summary>
/// This method gets a list of contacts who hard bounced when sent a particular 
/// campaign along with any specified data fields. 
/// 
/// This method has been superseded by ListHardBouncingContactsWithLabels2
/// </summary>
public void ListHardBouncingContactsWithLabels()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
 
    Console.WriteLine("ListHardBouncingContactsWithLabels");
    Console.WriteLine("----------------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // create an array containing the names of the data fields we are interested in
        string[] dataLabels = new []
                                  {
                                    "FULLNAME",
                                    "POSTCODE"
                                  };
 
        // get the list of contacts from the web service
        com.apiconnector.APIContact[] contacts = api.ListHardBouncingContactsWithLabels(username, password, campaignId, dataLabels);
 
        // display the contacts if we have any
        if (contacts != null && contacts.Length > 0)
        {
            foreach (com.apiconnector.APIContact contact in contacts)
            {
                Console.WriteLine("AudienceType : {0}", contact.AudienceType);
                Console.WriteLine("Email : {0}", contact.Email);
                Console.WriteLine("EmailType : {0}", contact.EmailType);
                Console.WriteLine("ID : {0}", contact.ID);
                Console.WriteLine("Notes : {0}", contact.Notes);
                Console.WriteLine("OptInType : {0}", contact.OptInType);
 
                // if we have some data fields - display them
                if (contact.DataFields != null &&
                    contact.DataFields.Keys != null &&
                    contact.DataFields.Values != null &&
                    contact.DataFields.Keys.Length > 0 &&
                    contact.DataFields.Values.Length > 0 &&
                    contact.DataFields.Values.Length == contact.DataFields.Keys.Length)
                {
                    Console.WriteLine("DataFields:");
 
                    for (int i = 0; i < contact.DataFields.Keys.Length; i++)
                    {
                        Console.WriteLine("\t{0} : {1}", contact.DataFields.Keys[i],
                                          contact.DataFields.Values[i]);
                    }
                }
            }
        }
    }
    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/ListHardBouncingContactsWithLabels"
<?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>
    <ListHardBouncingContactsWithLabels xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <labels>
        <string>string</string>
        <string>string</string>
      </labels>
    </ListHardBouncingContactsWithLabels>
  </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>
    <ListHardBouncingContactsWithLabelsResponse xmlns="http://apiconnector.com">
      <ListHardBouncingContactsWithLabelsResult>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
      </ListHardBouncingContactsWithLabelsResult>
    </ListHardBouncingContactsWithLabelsResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

List hard bouncing contacts with labels

The ListHardBouncingContactsWithLabels method is obsolete please use ListHardBouncingContactsWithLabels2.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: