Versenden von individualisierten Trigger Mails

Die Methode SendTriggerMails ermöglicht das Versenden von ereignisabhängigen Kampagnen mit Inhalten, die für jeden Empfänger individuell sind – den sogenannten individualisierten Trigger Mails (z.B. Buchungs- oder Bestellbestätigungen).

Um SendTriggerMails benutzen zu können, wird eine E-Mail Kampagne mit allen Basisinformationen (z.B. Einleitung und Abschluss) benötigt. Im SendTriggerMailsRequest werden dann die übrigen Inhalte, welche für jeden Empfänger individuell sind, übergeben und die fertig zusammengestellte E-Mail an den jeweiligen Empfänger versendet.

Request Properties

CampaignId
Die Id der zu versendenden E-Mail Kampagne. Diese Kampagne muss ereignisabhängig sein und den Typ „Individualisierte Inhalte“ aufweisen.
Typ der Eigenschaft: GUID

TriggerMails
Die Liste der zu versendenden Trigger Mails.
Typ der Eigenschaft: Liste von TriggerMail

TriggerMailIds
Die Liste der IDs der zu versendenden Trigger-Mails. Die IDs werden beim Generieren von Triggermails erstellt.
Typ der Eigenschaft: LONG

UseIRated
Gibt an, ob die Abschnitte der E-Mail Kampagne mit iRated® sortiert werden sollen.
Typ der Eigenschaft: BOOL

IgnoreCulture
Gibt an, ob Empfänger mit anderer Sprache beschickt werden sollen. Ist diese Eigenschaft auf TRUE gesetzt, dann werden alle Empfänger beschickt, auch wenn sie nicht die gleiche Sprache wie die E-Mail Kampagne haben (zB wenn deutschsprachige Empfänger auch eine englische E-Mail Kampagne erhalten sollen). Wird die Eigenschaft auf FALSE gesetzt, dann werden nur Empfänger mit derselben Sprache wie die E-Mail Kampagne beschickt. Empfänger mit einer anderen Sprache werden ausgeschlossen und scheinen im SendTriggerMails-Response unter Errors auf. Wird kein Wert angegeben, so wird standardmäßig TRUE verwendet.
Typ der Eigenschaft: BOOL

UseRTR
Gibt an, ob Empfänger, die auf der österreichischen ECG Liste stehen, vom Versand ausgeschlossen werden sollen. Wenn diese Eigenschaft auf TRUE ist, dann werden die Empfänger der österreichischen ECG Liste vom Versand ausgeschlossen und scheinen im SendTriggerMailsResponse unter Errors auf. Wenn diese Eigenschaft auf FALSE ist, dann erfolgt kein Abgleich mit der österreichischen ECG Liste und es werden alle Empfänger beschickt. Wird kein Wert angegeben, so wird standardmäßig FALSE verwendet.
Typ der Eigenschaft: BOOL

ConsiderSubscriberExclusionCriterias
Gibt an, ob die Ausschlusskriterien beim Versand berücksichtigt werden sollen. Ist diese Eigenschaft auf TRUE, dann werden abgemeldete und deaktivierte Empfänger sowie Empfänger auf der Blacklist oder Robinsonliste vom Versand ausgeschlossen. Diese Empfänger scheinen dann im SendTriggerMailsResponse unter Errors auf. Ist die Eigenschaft auf FALSE, dann werden keinerlei Ausschlusskriterien geprüft und keine Empfänger vom Versand ausgeschlossen. Wird kein Wert angegeben, so wird standardmäßig FALSE verwendet.
Typ der Eigenschaft: BOOL

ConsiderDOIStatus
Gibt an, ob der Double-Opt-In Status beim Versand berücksichtigt werden soll. Ist diese Eigenschaft auf TRUE, dann werden nur Empfänger mit den Werten „Extern dokumentiert“ und „Double-Opt-In bestätigt“ beschickt. Alle anderen werden ausgeschlossen und scheinen im SendTriggerMailsResponse unter Errors auf. Ist die Eigenschaft FALSE, dann wird der Double-Opt-In Status nicht berücksichtigt und alle Empfänger beschickt. Wird kein Wert angegeben, so wird standardmäßig FALSE verwendet.
Typ der Eigenschaft: BOOL

TimeToSend
Gibt an, zu welchem Zeitpunkt die Triggermails versendet werden sollen. Ist diese Eigenschaft nicht gesetzt, werden die Triggermails sofort versendet.
Typ der Eigenschaft: DATETIME

UseSendtimeOptimization
Gibt an, ob die Triggermails mit der Versandzeitpunktoptimierung versendet werden sollen. Ist diese Eigenschaft auf TRUE, dann werden alle übermittelten Trigger Mails im Zeitraum von SendtimeOptimizationRangeStart und SendtimeOptimizationRangeEnd versendet. Ist die Eigenschaft FALSE, dann wird das Trigger-Mail ohne Versandzeitpunktoptimierung versendet. Wird kein Wert angegeben, so wird standardmäßig FALSE verwendet.
Typ der Eigenschaft: BOOL

SendtimeOptimizationRangeStart
Gibt den Startzeitpunkt des versandzeitpunktoptimierten Versandes an. Wurde die Eigenschaft UseSendtimeOptimization auf TRUE gesetzt, dann muss dieser Wert angegeben werden. SendtimeOptimizationRangeStart und SendtimeOptimizationRangeEnd müssen mindestens eine Stunde oder maximal 24 Stunden auseinanderliegen. Der Startzeipunkt kann im ISO-8601 Format angegeben werden ("YYYY‑MM‑DDTHH:MM:SS").
Typ der Eigenschaft: STRING

SendtimeOptimizationRangeEnd
Gibt den Endzeitpunkt des versandzeitpunktoptimierten Versandes an. Wurde die Eigenschaft UseSendtimeOptimization auf TRUE gesetzt, dann muss dieser Wert angegeben werden. SendtimeOptimizationRangeStart und SendtimeOptimizationRangeEnd müssen mindestens eine Stunde oder maximal 24 Stunden auseinanderliegen. Der Endzeitpunkt kann im ISO-8601 Format angegeben werden ("YYYY‑MM‑DDTHH:MM:SS").
Typ der Eigenschaft: STRING

SendtimeOptimizationFallback
Gibt einen alternativen Zeitpunkt für den Versand mit der Versandzeitpunktoptimierung an für den Fall, dass kein optimaler Versandzeitpunkt für den Empfänger ermittelt werden konnte. Wurde die Eigenschaft UseSendtimeOptimization auf TRUE gesetzt, dann kann dieser Wert angegeben werden. Wird kein Wert angegeben, so wird das Triggermail sofort versendet, sofern kein optimaler Versandzeitpunkt ermittelt werden konnte. Der alternative Zeipunkt kann im ISO-8601 Format angegeben werden ("YYYY‑MM‑DDTHH:MM:SS").
Typ der Eigenschaft: STRING

Beispiel Request „Trigger-Mail versenden“

Der folgende Request versendet ein Trigger-Mail mit einem individuellen Abschnitt, in dem die Bestellnummer sowie die bestellten Produkte angezeigt werden.

//https://mailworx.marketingsuite.info/Services/JSON/ServiceAgent.svc/SendTriggerMails
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "CampaignId": "5289f2e1-ea6b-4a9a-954d-fe3d7789dfe9",
    "UseIRated": "true",
    "TriggerMails": [
	  {
        "SubscriberId": "d9a585bc-1234-4c76-b6be-4ada4dcaa26c",
        "Sections": [
		  {
            "SectionDefinitionName": "Artikel klein",
            "StatisticName": "Bestellübersicht",
            "Fields": [
              {
                "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
                "InternalName": "as_hl",
                "UntypedValue": "Ihre Bestellung [%mwtm:TriggerMailBestellNr%]"
              },
              {
                "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
                "InternalName": "as_text",
                "UntypedValue": "The following products were ordered: - Lenovo IdeaPad 300 - HP Officejet 7612 e"
              }
            ]
          }
		],
        "Data": [
          {
            "Key": "TriggerMailBestellNr",
            "Value": "954311567"
          }
        ]
      }
    ]
  }
}

<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:SendTriggerMail>
      <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:CampaignId>5289f2e1-ea6b-4a9a-954d-fe3d7789dfe9</ser:CampaignId>
        <ser:UseIRated>true</ser:UseIRated>
        <ser:TriggerMails>
          <ser:TriggerMail>
            <ser:SubscriberId>d9a585bc-1234-4c76-b6be-4ada4dcaa26c</ser:SubscriberId>
            <ser:Sections>
              <ser:Section>
                <ser:SectionDefinitionName>Artikel klein</ser:SectionDefinitionName>
                <ser:StatisticName>Bestellübersicht</ser:StatisticName>
                <ser:Fields>
                  <ser:Field xsi:type="ser:TextField">
                    <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                    <ser:InternalName>as_hl</ser:InternalName>
                    <ser:UntypedValue>Ihre Bestellung [%mwtm:TriggerMailBestellNr%]</ser:UntypedValue>
                  </ser:Field>
                  <ser:Field xsi:type="ser:TextField">
                    <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                    <ser:InternalName>as_text</ser:InternalName>
                    <ser:UntypedValue>The following products were ordered: - Lenovo IdeaPad 300 - HP Officejet 7612 e</ser:UntypedValue>
                  </ser:Field>
                </ser:Fields>
              </ser:Section>
            </ser:Sections>
            <ser:Data>
              <ser:TriggerMailData>
                <ser:Key>TriggerMailBestellNr</ser:Key>
                <ser:Value>954311567</ser:Value>
              </ser:TriggerMailData>
            </ser:Data>
          </ser:TriggerMail>  
        </ser:TriggerMails>
      </ser:request>
    </ser:SendTriggerMail>
  </soap:Body>
</soap:Envelope>

Response Objekt

Errors [Deprecated]
Eine Liste der Fehler, die während des Versands der Trigger-Mails aufgetreten sind.
Typ der Eigenschaft: Liste von SendTriggerMailError

SendResults
Eine Liste der behandelten Trigger-Mails.
Typ der Eigenschaft: Liste von SendTriggerMailResult