GenerateTriggerMail

Generieren von individualisierten Trigger Mails

Die Methode GenerateTriggerMail ermöglicht es, einzelne Trigger Mails zu generieren, ohne sie zu versenden. Als Ergebnis erhalten Sie den Link zur Webversion, mit der Sie sich das generierte E-Mail in einer Vorschau ansehen können.

Ein Praxisbeispiel für den Einsatz der Methode GenerateTriggerMail finden Sie hier.

Beachten Sie, dass generierte Trigger Mails, die nicht verschickt wurden, von mailworx einen Monat nach der Erstellung automatisch gelöscht werden!

Request Properties

TriggerMail
Gibt die Daten des einzelnen TriggerMails (Id des Abonnenten, Abschnitte, Trigger-Mail-Platzhalter) an.
Typ der Eigenschaft: TriggerMail

CampaignId
Gibt die Id jener Kampagne an, für die das Trigger-Mail generiert werden soll.
Typ der Eigenschaft: GUID

TriggerMailId
Gibt die Id jenes Trigger-Mails an, welches durch die Generierung überschrieben werden soll.
Um hier die Id eines bereits zuvor generierten Trigger-Mails angeben zu können, müssen Sie die TriggerMailId aus dem Response Objekt eines vorherigen GenerateTriggerMail Requests entnehmen und abspeichern.
Typ der Eigenschaft: Ganzzahl mit 64 Bit

Beispiel Request „bestehendes Trigger-Mail überschreiben“

Der folgende Request generiert ein Trigger-Mail, welches einen Abschnitt und zwei Trigger-Mail-Platzhalter enthält. Zusätzlich wird in diesem Beispiel das bereits zuvor generierte Trigger-Mail mit der Id 65 überschrieben.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/GenerateTriggerMail
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "*****",
      "Source": "application name"
    },
    "TriggerMail": [
      {
        "SubscriberId": "3e35be08-cc39-469e-8f19-3994d6aee40d",
        "Data": [
          {
            "Key": "OrderDate",
            "Value": "6/28/2016"
          },
          {
            "Key": "OrderNumber",
            "Value": "12345"
          }
        ],
        "Sections": [
          {
            "SectionDefinitionName": "order",
            "Fields": [
              {
                "Field": {
                  "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
                  "InternalName": "headline",
                  "UntypedValue": "Thanks for your order!"
                }
              },
              {
                "Field": {
                  "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
                  "InternalName": "text",
                  "UntypedValue": "The following products were ordered: - Lenovo IdeaPad 300 - HP Officejet 7612 e"
                }
              }
            ],
            "StatisticName": "Order"
          }
        ]
      }
    ],
    "CampaignId": "666107ec-abc0-45bc-8eb3-a76f55d875f7",
    "TriggerMailId": "65"
  }
}

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:GenerateTriggerMail>
      <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:TriggerMail>
          <ser:SubscriberId>3e35be08-cc39-469e-8f19-3994d6aee40d</ser:SubscriberId>
          <ser:Sections>
            <ser:SectionDefinitionName>order</ser:SectionDefinitionName>
            <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:Sections>
          <ser:Data>
            <ser:Key>TriggerMailBestellNr</ser:Key>
            <ser:Value>954311567</ser:Value>
          </ser:Data>
        </ser:TriggerMail>
        <ser:CampaignId>666107ec-abc0-45bc-8eb3-a76f55d875f7</ser:CampaignId>
        <ser:TriggerMailId>65</ser:TriggerMailId>
      </ser:request>
    </ser:GenerateTriggerMail>
  </soap:Body>
</soap:Envelope>

Response Objekt

GeneratedTriggerMail
Enthält mehrere Eigenschaften für das generierte Trigger-Mail:

  • Id
    Die Id des generierten Trigger-Mails, welche anschließend auch zum Versenden des Trigger-Mails oder zum Überschreiben bei der nächsten Trigger-Mail Generierung verwendet werden kann.
  • WebversionUrl
    Der Link zur Webversion des Trigger-Mails, der für die Vorschau des generierten E-Mails verwendet werden kann.

Error
Enthält eine detaillierte Fehlerbeschreibung, sofern bei der Generierung des Trigger-Mails Fehler aufgetreten sind.
Enthält außerdem die Id des betroffenen Abonnenten und die Id des betroffenen Trigger-Mails.

Was this article helpful?

Related Articles