Kampagnen auslesen

Beim Importieren von Abonnenten über die mailworx Web-Service Schnittstelle, ist es möglich, dass nach dem Import allen Abonnenten automatisch eine Newsletter-Kampagne gesendet wird. Hierzu ist es notwendig, die benötigte Kampagneninformationen der Methode zur Verfügung zu stellen. Die Kampagneninformation können mittels GetCampaigns ausgelesen werden.

In mailworx existieren zwei Arten von Kampagnen: Ereignisabhängige Kampagnen, welche beim Eintreten eines bestimmten Ereignisses, wie z.B.: das Ausfüllen eines Formulars, oder bei Geburtstagsmails das Eintreten des bestimmten Datums, an den/die entsprechenden Abonnenten gesendet wird und Standardkampagnen, welche manuell versendet werden.

Die Methode GetCampaigns ermöglicht das separate auslesen von ereignisabhängigen und bereits versendete Standardkampagnen, sowie Standardkampagnen, welche noch nicht versendet wurden.

Request Properties

LastChange
Wenn diese Eigenschaft gesetzt wird, werden nur die Kampagnen ausgelesen, welche seit diesem Zeitpunkt verändert wurden.
Typ der Eigenschaft: DATE

Type
Wenn diese Eigenschaft gesetzt wird, werden nur Kampagnen ausgelesen, die den angegeben Typ besitzen. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig vom Typ ausgelesen.
Typ der Eigenschaft: CampaignType

ResponseDetail
Gibt den Detailgrad an, mit dem die Kampagnen ausgelesen werden sollen.
Typ der Eigenschaft: CampaignResponseDetailIInfo

Id
Wenn diese Eigenschaft gesetzt wird, wird nur die Kampagne ausgelesen, welche diese Guid besitzt. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig von der Guid ausgelesen.
Typ der Eigenschaft: GUID

FromSent
Wenn diese Eigenschaft gesetzt wird, werden nur Kampagnen ausgelesen, welche nach dem angegeben Zeitpunkt versendet wurden. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig vom Versandzeitpunkt ausgelesen.
Typ der Eigenschaft: DATE

ToSent
Wenn diese Eigenschaft gesetzt wird, werden nur Kampagnen ausgelesen, welche vor dem angegeben Zeitpunkt versendet wurden. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig vom Versandzeitpunkt ausgelesen.
Typ der Eigenschaft: DATE

FromCreated
Wenn diese Eigenschaft gesetzt wird, werden nur Kampagnen ausgelesen, welche seit dem angegeben Zeitpunkt erstellt wurden. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig vom Erstellungszeitpunkt ausgelesen.
Typ der Eigenschaft: DATE

ToCreated
Wenn dies Eigenschaft gesetzt wird, werden nur Kampagnen auslesen, welche vor dem angegeben Zeitpunkt erstellt wurden. Wenn sie nicht gesetzt wird, werden alle Kampagnen unabhängig vom Erstellungszeitpunkt ausgelesen.
Typ der Eigenschaft: DATE

Beispiel Request "Kampagnen auslesen"

Der folgende Request liefert alle Kampagnen die in Arbeit sind und alle anderen Bedingungen ebenfalls erfüllt.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/GetCampaigns
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "******",
      "Source": "application name"
    },
    "LastChanged": "\/Date(1483225200000+0100)\/",
    "CampaignType": 0,
    "ResponseDetail": 1,
    "FromSent": "\/Date(1483225200000+0100)\/",
    "FromCreated": "\/Date(1483225200000+0100)\/"
  }
}

XML

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:ser="http://www.mailworx.at/interfaces/serviceagent/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header/>
  <soap:Body>
    <ser:GetCampaigns>
      <ser:request>
        <ser:Language>DE</ser:Language>
        <ser:SecurityContext>
          <ser:Account>account</ser:Account>
          <ser:Username>username</ser:Username>
          <ser:Password>*******</ser:Password>
          <ser:Source>application name</ser:Source>
        </ser:SecurityContext>
        <ser:LastChanged>2019-02-15T00:00:00</ser:LastChanged>
        <ser:Type>InWork</ser:Type>
        <ser:ResponseDetail>BasicInformation</ser:ResponseDetail>
        <ser:FromSent>2018-07-13T00:00:00</ser:FromSent>
        <ser:ToCreated>2017-03-14T00:00:00</ser:ToCreated>
      </ser:request>
    </ser:GetCampaigns>
  </soap:Body>
</soap:Envelope>

Response Objekt

Campaigns
Gibt eine Liste aller Campaigns im angegebenen Detailgrad aus, auf die die angegebenen Kriterien zutreffen.
Typ der Eigenschaft: Liste von Campaign

Newsletter Anmeldung

Tipps, Tricks und viele weitere nützliche Informationen direkt in Ihre Mailbox. Jetzt mailworx Newsletter abonnieren!