Overview

Skill Level: Any

Prerequisites

This interface returns a list of mailings for a specified database (or query) and contact as well as metrics associated with those mailings.

Note: This operation only returns mailings with associated events (for example, Open, Clickthrough, and Bounce).

Step-by-step

  1. Syntax of the request and response SOAP for ListRecipientMailings

    Operation  <ListRecipientMailings>     
    Elements  LIST_ID  Unique ID of the database or query whose mailings you are requesting.   
      RECIPIENT_ID  Unique ID of the contact for whom to look up mailings.   
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>221F8D72AEA8D6BA82D32C590396F031</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:ListRecipientMailings>
    <sil1:LIST_ID>24872</sil1:LIST_ID>
    <sil1:RECIPIENT_ID>28052753</sil1:RECIPIENT_ID>
    </sil1:ListRecipientMailings>
    </soapenv:Body>
    </soapenv:Envelope> 
       
    Response  <RESULT>     
    Elements  SUCCESS  True if successful.  
      Mailing  Zero or more XML nodes containing the definition of each mailing. Each node must contain all of the following elements.   
      Child Element  MailingName  Name of the mailing (enclosed in CDATA tags). 
        MailingId  Unique ID of the mailing. 
        SentTS  Time Watson Campaign Automation sent the mailing. 
        TotalOpens  Total messages opened. 
        TotalClickstreams  Total clickstreams clicked. 
        TotalClicks  Total links clicked. 
        TotalConversions  Total link conversions. 
        TotalAttachments  Total attachments opened. 
        TotalForwards  Total times message was forwarded. 
        TotalMediaPlays  Total times media was played. 
        TotalBounces  Total bounces. 
        TotalOptOuts  Total times opted out of mailings. 
    Example¬† <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body xmlns=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    <Mailing>
    <MailingId>800780</MailingId>
    <ReportId>66323909</ReportId>
    <MailingName>AAT_Optin (1)</MailingName>
    <SentTS/>
    <TotalOpens>1</TotalOpens>
    <TotalClickstreams>0</TotalClickstreams>
    <TotalClicks>0</TotalClicks>
    <TotalConversions>0</TotalConversions>
    <TotalAttachments>0</TotalAttachments>
    <TotalForwards>0</TotalForwards>
    <TotalMediaPlays>0</TotalMediaPlays>
    <TotalBounces>0</TotalBounces>
    <TotalOptOuts>0</TotalOptOuts>
    </Mailing>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
       

Join The Discussion

Your email address will not be published. Required fields are marked *