List campaign contact replies

The ListCampaignContactReplies method to retrieve a list of replies and contact has made to a campaign.

You may request up to 5 records at a time. To iterate through the whole data set you should use the select and skip parameters. For example to select the first 5 records in the data set you should set the select parameter to 5 and the skip parameter to 0. To select the next 5 records you should set the select parameter to 5 and the skip parameter to 5. You should continue to do this until 0 records are returned to you to get the whole data set.

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
contactId	int	This is the ID of the contact you wish to query against.
select	int	This is a number which indicates the number of records you wish to select. This argument must no greater than 5.	required
skip	int	This is a number which is the number of records you want to skip; to select all records from 6 to 10: set this number to 5.	required

Return values

The result is an array of APICampaignContactReply objects, each consisting of the following:

toAddress	string	The email address the reply is from.
fromAddress	string	The email address the reply is to.
subject	string	The subject of the email.
message	string	The contents of the email (this may include HTML).
isHtml	boolean	Whether the email is HTML (TRUE) or Plain Text (FALSE).
dateReplied	dateTime	The date and time the reply was sent.
replyType	string	The type of reply sent, this has possible values of Reply, AutoReply, ChallengeResponse (spam filtering) or Unsafe (contains javascript / suspect attachments).

Error responses

ERROR_CAMPAIGN_INVALID
ERROR_CAMPAIGN_NOT_FOUND
ERROR_CONTACT_INVALID
ERROR_CONTACT_NOT_FOUND
ERROR_CONTACT_SUPPRESSED
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/ListCampaignContactReplies"

Example of use in C# .NET

 /// <summary>
/// This method retrieves a list of replies and contact has made to a campaign.
/// 5 records at a time
/// </summary>
public void ListCampaignContactReplies()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int campaignId = 1;
    const int contactId = 1;
 
    Console.WriteLine("ListCampaignContactReplies");
    Console.WriteLine("--------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        int currentPage = 0;   // what page are we on
        const int itemsPerPage = 5;  // the number of clickers we want to be returned for each page
                                    // This number must no greater than 5
 
        // execute the first get from the server
        // the select parameter is the itemsperPage, 
        // the skip is the itemsPerPage * the currentPage
        com.apiconnector.APICampaignContactReply[] replies = api.ListCampaignContactReplies(username, password, campaignId, contactId, itemsPerPage, currentPage * itemsPerPage);
 
        while (replies != null && replies.Length > 0)
        {
            // output the current page
            Console.WriteLine("CurrentPage: {0}", currentPage + 1);
 
            foreach (com.apiconnector.APICampaignContactReply reply in replies)
            {
 
                Console.WriteLine("dateReplied : {0}", reply.dateReplied.ToShortDateString());
                Console.WriteLine("fromAddress : {0}", reply.fromAddress);
                Console.WriteLine("isHtml : {0}", reply.isHtml);
                Console.WriteLine("message : {0}", reply.message);
                Console.WriteLine("replyType : {0}", reply.replyType);
                Console.WriteLine("subject : {0}", reply.subject);
                Console.WriteLine("toAddress : {0}", reply.toAddress);
 
 
                Console.WriteLine();
            }
 
            // increment the page
            currentPage++;
 
            // execute the next get - see above
            replies = api.ListCampaignContactReplies(username, password, campaignId, contactId, itemsPerPage, currentPage * itemsPerPage);
        }
 
        // output some stats
        Console.WriteLine("Total Pages {0}, {1} per page", currentPage, itemsPerPage);
        Console.WriteLine();
    }
    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/ListCampaignContactReplies"
<?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>
    <ListCampaignContactReplies xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <contactId>int</contactId>
      <select>int</select>
      <skip>int</skip>
    </ListCampaignContactReplies>
  </soap:Body>
</soap:Envelope>/textarea>
            </div>
         </div>
         <div class="btm_contactbox">
            <h3>Sample response</h3>
            <div class="btm_contactbox_inner">
               <textarea class="api_code" style="height: 320px; ;">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>
    <ListCampaignContactRepliesResponse xmlns="http://apiconnector.com">
      <ListCampaignContactRepliesResult>
        <APICampaignContactReply>
          <toAddress>string</toAddress>
          <fromAddress>string</fromAddress>
          <subject>string</subject>
          <message>string</message>
          <isHtml>boolean</isHtml>
          <dateReplied>dateTime</dateReplied>
          <replyType>string</replyType>
        </APICampaignContactReply>
        <APICampaignContactReply>
          <toAddress>string</toAddress>
          <fromAddress>string</fromAddress>
          <subject>string</subject>
          <message>string</message>
          <isHtml>boolean</isHtml>
          <dateReplied>dateTime</dateReplied>
          <replyType>string</replyType>
        </APICampaignContactReply>
      </ListCampaignContactRepliesResult>
    </ListCampaignContactRepliesResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates