Versenden einer Kampagne
Die Methode SendCampaign ermöglicht es, bestehende mailworx E-Mail Kampagnen in der ewor Marketing Suite zu versenden.
Request Properties
CampaignId
Die ID der zu versendenden Kampagne.
Typ der Eigenschaft: GUID
SendType
Geben Sie hier an, ob die Versandart der Kampagne ein manueller Versand oder ein A/B-Split-Versand sein soll.
Typ der Eigenschaft: CampaignSendType
Settings
Je nach gewähltem SendType werden entweder über ManualSendSettings oder über ABSplitTestSendSettings die Eigenschaften des Versands festgelegt.
Typ der Eigenschaft: SendSettings
UseIRated
Setzen Sie den Wert auf „True“ wenn die Abschnitte durch iRated® sortiert werden sollen.
Typ der Eigenschaft: BOOLEAN
IgnoreCulture
Setzen Sie den Wert auf „True“ wenn alle Empfänger, welche eine andere Sprache als die zu versendende Kampagne haben, trotzdem besendet werden sollen.
Typ der Eigenschaft: BOOLEAN
IgnoreRules
Setzen Sie den Wert auf „True“ wenn die Richtlinien des Mandanten ignoriert werden sollen.
Typ der Eigenschaft: BOOLEAN
UseRTR
Setzen Sie den Wert auf „True“, wenn alle Empfänger, welche sich in der österreichischen Robinsonliste befinden, ausgeschlossen werden sollen.
Typ der Eigenschaft: BOOLEAN
StopSendToDuplicates
Setzen Sie den Wert auf „True“, wenn von mehreren Empfängern, die dieselbe E-Mail Adresse aufweisen, nur ein einziger Empfänger die Kampagne erhalten soll. Damit vermeiden Sie Doppelbesendungen.
Typ der Eigenschaft: BOOLEAN
ExcludeSubscribersWithoutConsent
Hier kann festgelegt werden, welche Empfänger aufgrund Ihres Double-Opt-In Status vom Versand ausgeschlossen werden sollen.
Wird die Eigenschaft nicht gesetzt, dann werden standardmäßig keine Empfänger wegen ihres Double-Opt-In Status ausgeschlossen.
Typ der Eigenschaft: ExcludeSubscribersWithoutConsent
SendUserId
Die Id des Benutzers der als Absender bei der E-Mail Kampagne vermerkt werden soll. Wird dieser Wert nicht gesetzt wird der aktuelle Benutzer verwendet.
Typ der Eigenschaft: GUID
Beispiel Request „Kampagne versenden“
Der folgende Request versendet die mailworx Kampagne mit der definierten Kampagnen-ID. Die österreichische Robinsonliste wird berücksichtigt und iRated® wird nicht verwendet. Außerdem wird auf die Sprache der Kampagne und auf die Versandrichtlinien des Mandanten geprüft. Wenn sich in der Zielgruppe mehrere Empfänger mit der gleichen E-Mail-Adresse befinden werden diese trotzdem durch die Einstellung „StopSendToDuplicates“ nur einmal beschickt.
Als Versandzeitpunkt wird der 25.5.2018 um 9:00 Uhr definiert und alle Empfänger die den Double-Opt-In Status „Widerrufen“ haben werden vom Versand ausgeschlossen.
JSON
//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/SendCampaign
{
"request": {
"Language": "DE",
"SecurityContext": {
"Account": "account",
"Username": "username",
"Password": "*****",
"Source": "application name"
},
"CampaignId": "0c9b75ed-257e-4c49-9407-da73a0968c8d",
"SendType": 0,
"Settings": {
"__type": "ManualSendSettings:#Eworx.Mailworx.ServiceInterfaces.Campaigns",
"SendTime": "\/Date(1527231600)\/"
},
"UseIRated": "false",
"IgnoreCulture": "false",
"IgnoreRules": "false",
"UseRTR": "true",
"StopSendToDuplicates": "true",
"ExcludeSubscribersWithoutConsent": 2
}
}
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:SendCampaign>
<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>0c9b75ed-257e-4c49-9407-da73a0968c8d</ser:CampaignId>
<ser:SendType>Manual</ser:SendType>
<ser:Settings>
<ser:ManualSendSettings>
<ser:SendTime>2018-05-25T09:00:00</ser:SendTime>
</ser:ManualSendSettings>
</ser:Settings>
<ser:UseIRated>false</ser:UseIRated>
<ser:IgnoreCulture>false</ser:IgnoreCulture>
<ser:IgnoreRules>false</ser:IgnoreRules>
<ser:UseRTR>true</ser:UseRTR>
<ser:StopSendToDuplicates>true</ser:StopSendToDuplicates>
<ser:ExcludeSubscribersWithoutConsent>ExcludeRevokedSubscribers</ser:ExcludeSubscribersWithoutConsent>
</ser:request>
</ser:SendCampaign>
</soap:Body>
</soap:Envelope>
Response Objekt
RecipientsEffective
Die Anzahl der effektiven Empfänger der Kampagne.
Typ der Eigenschaft: INT