Systemstatus
English (US)

Standard API (SOAP)

Aktueller Beitrag:
Weitere Beiträge aus dieser Kategorie: Weitere anzeigen

SOAP Mailing

  • Aktualisiert
Folgen

Folgende SOAP-Methoden werden speziell für die Interaktion mit eMailings bereitgestellt. 

get

Liefert die Liste der Empfänger:

getRecipientsProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Öffner:

getImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Mehrfachöffner:

getMultipleImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Klicker:

getClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Mehrfachklicker:

getMultipleClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Soft- oder Hardbounce generiert haben:

getBounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Hardbounce generiert haben:

getHardbounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Softbounce generiert haben:

getSoftbounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche sich im Mailing abgemeldet haben:

getUnsubscriptionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche irgendeinen Artikel im Mailing geklickt haben:

getAllArticleImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche irgendeinen Link im Mailing geklickt haben:

getAllLinkClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Klicker für einen bestimmten Artikel:

getArticleImpressionProfiles (int mailing_id, int article_id, string[] attribute_names)

Liefert die Liste der Klicker für einen bestimmten Link:

getLinkClickProfiles (int mailing_id, int link_id, string[] attribute_names)
Details

Parameter

  • int mailing_id: Id des Mailings, für welche die Empfängerdaten angefordert werden sollen
  • int article_id: ( nur bei getArticleImpressionProfiles): Id des Artikels, für den die Klicker zurückgeliefert werden sollen
  • int link_id: ( nur bei (getLinkClickProfiles): Id des Links, für den die Klicker zurückgeliefert werden sollen
  • string[] attribute_names: Liste von Poolattribut Namen, welche im Ergebnis zurückgeliefert werden sollen

Rückgabewert

  • EvalancheJobResult: Informationen zum Hintergrundjob, analog zum Export aller Profile eines Pools bzw. unter Arbeiten mit Hintergrundjobs

Benötigte Rechte

eMailing anzeigen und Profile exportieren

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getRecipientsProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <attribute_names>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attribute_names>
 </mail:getRecipientsProfiles>
 </soapenv:Body>
</soapenv:Envelope></soapenv:Envelope>

Siehe auch: 

  • Hintergrund Job

getContentContainerData

ContentContainer eines eMailings auslesen

EvalancheHashMap getContentContainerData (int mailing_id)

Details

Parameter

  • int resource_id: ID des eMailings

Rückgabewert

  • EvalancheHashMap: EvalancheHashMap mit den Daten des eMailings

Benötigte Rechte

Container anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:getContentContainerData>
<resource_id>MAILING_ID</resource_id>
</mail:getContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

 

setContentContainerData

ContentContainer eines eMailings aktualisieren

EvalancheResourceInformation setContentContainerData (int mailing_id, EvalancheHashMap data)

Details

Parameter

  • int resource_id: ID des eMailings
  • EvalancheHashMap data: EvalancheHashMap mit den Daten des Containers

Rückgabewert

  • EvalancheResourceInformation: Objekt analog zur Methode getContentContainerData (Informationen über ein Objekt mittels Objekt ID abfragen)

Benötigte Rechte

Container verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:setContentContainerData>
<resource_id>MAILING_ID</resource_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>CONTAINER_FIELD_NAME</key>
<value>CONTAINER_FIELD_CONTENT</value>
</item>
</items>
</data>
</mail:setContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

 

getDetails

Details einer Versendung abfragen

EvalancheMailingInformation getDetails(int mailing_id)
Details

Parameter

  • int mailing_id: Id der Versendung

Rückgabewert

  • EvalancheMailingInformation: Objekt (SOAP) bzw. Array mit folgenden Attributen:
  • int timestamp: Zeitstempel des Mailings
  • int recipients: Anzahl der Empfänger
  • bool sent: true, wenn das Mailing vollständig versandt wurde
  • string preview_url: URL auf die Vorschau der Versendung
  • string report_url: URL auf die Statistikseite der Versendung
  • string admin_url: URL auf die Verwaltungsseite der Versendung
  • string subject: Standardbetreffzeile der Versendung
  • int targetgroup_id: Id der Zielgruppe, an welche das Mailing versandt wurde
  • int send_start_time: Unix Timestamp des Versandstarts
  • int send_end time: Unix Timestamp des Versandendes

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getDetails>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getDetails>
 </soapenv:Body>
</soapenv:Envelope>

 

getImpressions

Öffnungen/Impressions einer Versendung abfragen

EvalancheMailingImpression[] getImpressions(int mailing_id, int start_timestamp = 0, int end_timestamp = 0)
Details

Parameter

  • int mailing_id: Id der Versendung
  • int start_timestamp = 0: UTC Unix Timestamp, ab inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen
  • int end_timestamp = 0: UTC Unix Timestamp, bis inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen

Rückgabewert

  • EvalancheMailingImpression[]: Liste von Objekten mit folgenden Attributen:
    • int id: Eindeutige Id des Tracking Datensatzes
    • int profile_id: Id des Users, der die Aktion durchgeführt hat
    • int timestamp: UTC Unix Timestamp der Aktion

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getImpressions>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getImpressions>
 </soapenv:Body>
</soapenv:Envelope>

 

getClicks

Klicks einer Versendung abfragen

EvalancheMailingClick[] getClicks(int mailing_id, int start_timestamp = 0, int end_timestamp = 0)
Details

Parameter

  • int mailing_id: Id der Versendung
  • int start_timestamp = 0: UTC Unix Timestamp, ab inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen
  • int end_timestamp = 0: UTC Unix Timestamp, bis inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen

Rückgabewert

    • EvalancheMailingClick[]: Liste von Objekten mit folgenden Attributen:
        • int id: Eindeutige Id des Tracking Datensatzes
        • int profile_id: Id des Users, der die Aktion durchgeführt hat
        • int timestamp: UTC Unix Timestamp der Aktion
        • int link_id: Id des Links für welchen ein Klick aufgezeichnet wurde. Wird hier der Wert -1 zurückgeliefert, ist die parent_id zu betrachten
        • int link_type_id: Format der Resource, in welcher der User die Aktion durchgeführt hat.
          Folgende Werte sind möglich:
          0: Unbekannt
          1: Online Ansicht eines Newsletters
          2: PDF Ansicht eines Artikels bzw. Newsletters
          3: Text Ansicht des Newsletters
          4: Web/Mobile Ansicht des Newsletters
          5: Landingpage eines Artikels
          6: Klick auf Landingpage Link
          7: LeadPage Öffnung
          11: XSL-FO Ansicht eines Artikels bzw. Newsletters
          12: Anzeige des RSS Feeds eines Newsletters
          19: Newsletter Öffnung
          20: Externer Link
          21: Anzeige des ATOM Feeds eines Newsletters
          22: Aufruf Vorlesedienst für einen Artikel bzw. Einen Newsletter
          23: Abruf der Artikel bzw. Newsletter Daten durch den Vorlesedienst
          24: Aufruf Vorlesedienst für einen Newsletter Podcast
          25: Abruf der Podcast Daten durch den Vorlesedienst
          40: Artikel in Facebook geteilt
          41: Artikel in Google Bookmarks geteilt
          42: Artikel in MySpace geteilt
          43: Artikel in del.icio.us geteilt
          44: Artikel in Twitter geteilt
          45: Artikel in Xing geteilt
          46: Artikel in LinkedIn geteilt
          47: Artikel in Google+ geteilt
          50: Klick auf in Facebook geteilten Artikel
          51: Klick auf in Google Bookmarks geteilten Artikel
          52: Klick auf in MySpace geteilten Artikel
          53: Klick auf in del.icio.us geteilten Artikel
          54: Klick auf in Twitter geteilten Artikel
          55: Klick auf in Xing geteilten Artikel
          59: Klick auf in LinkedId geteilten Artikel
          60: Klick auf in Google+ geteilten Artikel
        • int parent_id: Id der Resource, in welcher der Link geklickt wurde, entweder die Mailing Id oder die oder die Id der Artikelreferenz.

 

Erklärung zu ``link_id`` und ``parent_id``:

Die link_id  hat nur dann einen Wert größer oder gleich 0, wenn es sich um einen “normalen” Link handelt. Klicks auf z. B. Landingpage-Links, PDF-Generierung, Voice, etc. haben immer eine link_id link_id gleich -1.

 In diesem Fall muss die parent_id zur genaueren Betrachtung herangezogen werden:

Ist die parent_id gleich der übergebenen mailing_id, fand der Klick im Mailing statt bzw. wurde das Mailing im Format von link_type_id dargestellt. Dies kann z. B. ein Klick auf Vorlesen oder die PDF-Generierung im Mailings selbst erfolgt sein.
Ist die parent_id ungleich der übergebenen mailing_id, bezog sich der Klick auf die Artikelreferenz mit der Id gleich der parent_id, z. B. durch einen Klick auf einen Sharing-Link des Artikels.

 

Benötigte Rechte

eMailing anzeigen
 

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClicks>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getClicks>
 </soapenv:Body>
</soapenv:Envelope>

 

getStatistics

Kumulierte Statistiken einer Versendung abfragen

EvalancheMailingStatistics getStatistics(int mailing_id)
Details

Parameter

  • int mailing_id: Id der Versendung

Rückgabewert

  • EvalancheMailingStatistics: Objekt (SOAP) bzw. Array mit folgenden Attributen:
  • int addressees: Anzahl der Adressaten
  • int recipients: Anzahl der Empfänger
  • int duplicates: Anzahl der durch den Dublettencheck ignorierten Profile
  • int blacklisted: Anzahl der durch Blacklisting ignorierten Profile
  • int robinsonlisted: Anzahl der durch die Robinsonliste ignorierten Profile
  • int hardbounces: Anzahl der Hardbounces
  • int softbounces: Anzahl der Softbounces
  • int unsubscribes: Anzahl der Abmeldungen
  • int impressions: Anzahl der Öffnungen
  • int unique_impressions: Anzahl der Öffner
  • int clicks: Anzahl der Klicks
  • int unique_clicks: Anzahl der eindeutigen Klicks
  • EvalancheMediaStatistics media: Objekt (SOAP) bzw. Array mit folgenden Attributen:
    • string name: Name des Mediums
    • int clicks: Anzahl der Klicks
    • int unique_clicks: Anzahl der Klicker
  • EvalancheArticleStatistics articles: Objekt (SOAP) bzw. Array mit folgenden Attributen:
    • int id: Id des Artikels
    • string name: Name des Artikels
    • int clicks: Anzahl der Klicks
    • int unique_clicks: Anzahl der Klicker
  • EvalancheLinkStatistics links: Objekt (SOAP) bzw. Array mit folgenden Attributen:
    • int id: Id des Links
    • string name: URL des Links
    • int clicks: Anzahl der Klicks
    • int unique_clicks: Anzahl der Klicker
    • string url: URL des Links

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getStatistics>
 </soapenv:Body>
</soapenv:Envelope>

 

getArticleStatistics

Detaillierte Artikelstatistiken einer Versendung abfragen

ArticleStats[] getArticleStatistics(int mailing_id)
Details

Parameter

  • int mailing_id: Id der Versendung

Rückgabewert

  • ArticleStats[]: Liste von Objekten mit folgenden Attributen:
    • int id: Id des Artikels
    • int reference_id: Id der Artikelreferenz (Bindeglied zwischen Artikel und Versendung)
    • string name: Name des Artikels
    • ArticleFormatStats overall: Statistiken des Artikel über alle Ausgabeformate
    • ArticleFormatStats landingpage: Statistik der Landinpage Klicks des Artikels
    • ArticleFormatStats print: Statistik der PDF/Print Klicks des Artikels
    • ArticleFormatStats voice: Statistik der Voice Klicks des Artikels
    • ArticleFormatStats social_sharing: Statistik der Share to Social Klicks des Artikels
    • Objekte vom Typ ArticleFormatStats besitzen folgende Attribute:
      • int clicks: Anzahl der Klicks auf das entsprechende Format des Artikels
      • int unique_clicks: Anzahl der eindeutigen Klicks auf das entsprechende Format des Artikels
      • float clickrate: Klickrate des entsprechenden Formats des Artikels
      • float clickrate_relative: Relative Klickrate des entsprechenden Formats des Artikels
      • float multiple_clickrate: Mehrfachklickrate des entsprechenden Formats des Artikels
      • float multiple_clickrate_relative: Relative Mehrfachklickrate des entsprechenden Formats des Artikels
    • ArticleLinkStats[] links: Liste von Objekten mit folgenden Attributen:
      • int id: Link Id
      • string url: Link Url
      • string name: Name des Links
      • int clicks: Anzahl der Klicks auf diesen Link
      • int unique_clicks: Anzahl der eindeutigen Klicks auf diesen Link

Benötigte Rechte

keine

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticleStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticleStatistics>
 </soapenv:Body>
</soapenv:Envelope>

 

getStatus

Status der Empfängerprofile auslesen

EvalancheProfileMailingStatus[] getStatus(int mailing_id, int timeframe, string[] profile_attributes)
Details

Parameter

  • int mailing_id: Id der Versendung
  • int timeframe: Sekunden ab jetzt in der Vergangenheit, ab welcher Statusänderungen abgefragt werden sollen.
  • string[] profile_attributes: Liste von Profilattributen, welche im Ergebnis zurückgeliefert werden sollen. Wird ein leeres Array übergeben, werden keine Profildaten zurückgeliefert

Rückgabewert

  • EvalancheProfileMailingStatus[]: Liste von Objekten (SOAP) bzw. Arrays mit folgenden Attributen:
    • int profile_id: Id des Profils
    • int newsletter_id: Id der Versendung
    • int last_status_change: Unix Timestamp des Zeitpunkts der letzten Statusänderung beim betreffenden Profil
    • int status: Versendungsstatus des betreffenden Profils
    • string preview_url: Personalisierte Mailingvorschau
    • string profile_data: Array mit den Attributnamen als Key und dem Attributwert als Value

Benötigte Rechte

eMailing anzeigen

Der Versendungsstatus bedeutet:

  • 0 = Warteschlange
  • 1 = Versand erfolgreich
  • 2 = Hardbounce
  • 3 = Softbounce

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatus>
 <mailing_id>MAILING_ID</mailing_id>
 <timeframe>TIMEFRAME_IN_SECONDS</timeframe>
 <profile_attributes>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ATTRIBUTE</item>
 </profile_attributes>
 </mail:getStatus>
 </soapenv:Body>
</soapenv:Envelope>

 

getSubjects

Betreffzeilen eines Mailings auslesen

EvalancheMailingSubject getSubjects(int mailing_id)
Details

Parameter

  • int mailing_id: Id des Mailings

Rückgabewert

  • EvalancheMailingSubject[]: Liste von Objekten mit folgenden Attributen:
    • int targetgroup_id: Id der Zielgruppe für die Betreffzeile. Die Id 0 repräsentiert die Standardbetreffzeile
    • Die Betreffzeile Zeitstempel des Mailings

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getSubjects>
 </soapenv:Body>
</soapenv:Envelope>

 

setSubjects

Betreffzeilen eines Mailings setzen

bool setSubjects (int mailing_id, EvalancheMailingSubject[] subjects)
Details

Parameter

  • int mailing_id: Id des Mailings
  • EvalancheMailingSubject[] subjects: Analog zum Rückgabewert unter Betreffzeilen eines Mailings auslesen. Zwingend erforderlich ist eine Konfiguration mit der Zielgruppen Id 0.

Rückgabewert

  • bool: true im Erfolgsfall

Benötigte Rechte

eMailing verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 <subjects>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <subjectline>SUBJECT_VALUE</subjectline>
 </item>
[...]
 </subjects>
 </mail:setSubjects>
 </soapenv:Body>
</soapenv:Envelope>

 

getClientStatistics

Client-Statistik eines Mailings auslesen

bool getClientStatistics (int mailing_id)
Details

Parameter

  • int mailing_id: Id des Mailings

Rückgabewert

  • ClientStatistics: Objekt (SOAP) bzw. Array mit folgenden Attributen:
    • mail_clients: Array mit folgenden Attributen:
      • item: Array mit folgenden Attributen:
        • string description: Beschreibung des eMail-Clients
        • int count: Anzahl der Profile, welche mit diesem eMail-Client getrackt wurden
    • browsers: Array mit folgenden Attributen:
      • item: Array mit folgenden Attributen:
        • string description: Beschreibung des Browsers
        • int count: Anzahl der Profile, welche mit diesem Browser getrackt wurden
    • devices: Array mit folgenden Attributen:
      • item: Array mit folgenden Attributen:
        • string description: Beschreibung des Endgerätes
        • int count: Anzahl der Profile, welche mit diesem Endgerät getrackt wurden

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClientStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getClientStatistics>
 </soapenv:Body>
</soapenv:Envelope>

 

getConfiguration

Konfiguration eines Mailings auslesen

EvalancheMailingConfiguration getConfiguration(int mailing_id)
Details

Parameter

  • int mailing_id: Id des Mailings

Rückgabewert

  • EvalancheMailingConfiguration Objekt mit folgenden Attributen:
    • string external_trackingcode: Wert des Feldes Externer Trackingcode
    • string campaign_id: Wert des Feldes Kampagnen Id
    • string externalxml_url: Wert des Feldes URL auf externes XML
    • string salutation_female: Wert des Feldes Individualisierte Anrede: Frau
    • string salutation_male: Wert des Feldes Individualisierte Anrede: Herr
    • string salutation_company: Wert des Feldes Individualisierte Anrede: Firma
    • string salutation_family: Wert des Feldes Individualisierte Anrede: Familie
    • string salutation_other: Wert des Feldes Individualisierte Anrede: Keine Angabe
    • string sender_email: Wert des Feldes Absenderadresse
    • string sender_name: Wert des Feldes Absender
    • string reply_email: Wert des Feldes Antwortadresse
    • string reply_name: Wert des Feldes Antwort an
    • string grant_url: Wert des Feldes Bestätigungs-URL bei Eintragungen
    • string revoke_url: Wert des Feldes Bestätigungs-URL bei Austragungen
    • string inputfield_0: Wert des Feldes INPUTFIELD 0
    • string inputfield_1: Wert des Feldes INPUTFIELD 1
    • string inputfield_2: Wert des Feldes INPUTFIELD 2
    • string inputfield_3: Wert des Feldes INPUTFIELD 3
    • string inputfield_4: Wert des Feldes INPUTFIELD 4
    • string inputfield_5: Wert des Feldes INPUTFIELD 5
    • string inputfield_6: Wert des Feldes INPUTFIELD 6
    • string inputfield_7: Wert des Feldes INPUTFIELD 7
    • string inputfield_8: Wert des Feldes INPUTFIELD 8
    • string inputfield_9: Wert des Feldes INPUTFIELD 9
    • string textarea_0: Wert des Feldes TEXTAREA 0
    • string textarea_1: Wert des Feldes TEXTAREA 1
    • string textarea_2: Wert des Feldes TEXTAREA 2
    • string textarea_3: Wert des Feldes TEXTAREA 3
    • string textarea_4: Wert des Feldes TEXTAREA 4
    • string textarea_5: Wert des Feldes TEXTAREA 5
    • string textarea_6: Wert des Feldes TEXTAREA 6
    • string textarea_7: Wert des Feldes TEXTAREA 7
    • string textarea_8: Wert des Feldes TEXTAREA 8
    • string textarea_9: Wert des Feldes TEXTAREA 9
    • string htmlarea_0: Wert des Feldes HTMLAREA 0 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_1: Wert des Feldes HTMLAREA 1 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_2: Wert des Feldes HTMLAREA 2 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_3: Wert des Feldes HTMLAREA 3 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_4: Wert des Feldes HTMLAREA 4 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_5: Wert des Feldes HTMLAREA 5 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_6: Wert des Feldes HTMLAREA 6 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_7: Wert des Feldes HTMLAREA 7 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_8: Wert des Feldes HTMLAREA 8 - Valides XHTML ist zwingend erforderlich!
    • string htmlarea_9: Wert des Feldes HTMLAREA 9 - Valides XHTML ist zwingend erforderlich!

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getConfiguration>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getConfiguration>
 </soapenv:Body>
</soapenv:Envelope>

 

setConfiguration

Konfiguration eines Mailings setzen

bool setConfiguration(int mailing_id, EvalancheMailingConfiguration configuration)
Details

Parameter

  • int mailing_id: Id des Mailings
  • EvalancheMailingConfiguration: Objekt analog zum Rückgabewert unter Konfiguration eines Mailings auslesen

Rückgabewert

  • bool: true im Erfolgsfall

Benötigte Rechte

eMailing verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setConfiguration>
 <mailing_id>22852985</mailing_id>
 <configuration>
 <!--You may enter the following 44 items in any order-->
 <external_trackingcode>EXTERNAL_TRACKINGCODE</external_trackingcode>
 <campaign_id>CAMPAIGN_ID</campaign_id>
 <externalxml_url>EXTERNALXML_URL</externalxml_url>
 <salutation_female>SALUTATION_FEMALE</salutation_female>
 <salutation_male>SALUTATION_MALE</salutation_male>
 <salutation_company>SALUTATION_COMPANY</salutation_company>
 <salutation_family>SALUTATION_FAMILY</salutation_family>
 <salutation_other>SALUTATION_OTHER</salutation_other>
 <sender_email>SENDER_EMAIL</sender_email>
 <sender_name>SENDER_NAME</sender_name>
 <reply_name>REPLY_NAME</reply_name>
 <reply_email>REPLY_EMAIL</reply_email>
 <grant_url>GRANT_REDIRECT_URL</grant_url>
 <revoke_url>REVOKE_REDIRECT_URL</revoke_url>
 <inputfield_0>?</inputfield_0>
 <inputfield_1>?</inputfield_1>
 <inputfield_2>?</inputfield_2>
 <inputfield_3>?</inputfield_3>
 <inputfield_4>?</inputfield_4>
 <inputfield_5>?</inputfield_5>
 <inputfield_6>?</inputfield_6>
 <inputfield_7>?</inputfield_7>
 <inputfield_8>?</inputfield_8>
 <inputfield_9>?</inputfield_9>
 <textarea_0>?</textarea_0>
 <textarea_1>?</textarea_1>
 <textarea_2>?</textarea_2>
 <textarea_3>?</textarea_3>
 <textarea_4>?</textarea_4>
 <textarea_5>?</textarea_5>
 <textarea_6>?</textarea_6>
 <textarea_7>?</textarea_7>
 <textarea_8>?</textarea_8>
 <textarea_9>?</textarea_9>
 <htmlarea_0>?</htmlarea_0>
 <htmlarea_1>?</htmlarea_1>
 <htmlarea_2>?</htmlarea_2>
 <htmlarea_3>?</htmlarea_3>
 <htmlarea_4>?</htmlarea_4>
 <htmlarea_5>?</htmlarea_5>
 <htmlarea_6>?</htmlarea_6>
 <htmlarea_7>?</htmlarea_7>
 <htmlarea_8>?</htmlarea_8>
 <htmlarea_9>?</htmlarea_9>
 </configuration>
 <overwrite>?</overwrite>
 </mail:setConfiguration>
 </soapenv:Body>
</soapenv:Envelope>

 

getSendableDrafts

Versandfertige Mailingentwürfe auslesen

EvalancheResourceInformation[] getSendableDrafts(bool unsent)
Details

Parameter

  • bool unsent: Wenn true übergeben wird, werden nur Entwürfe zurückgeliefert, die noch nicht versendet wurden

Rückgabewert

  • EvalancheResourceInformation[]: Liste von Objekten analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

keine

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDrafts>
 <unsent>0/1</unsent>
 </mail:getSendableDrafts>
 </soapenv:Body>
</soapenv:Envelope>

 

getSendableDraftsByMandatorId

Versandfertige Mailingentwürfe aus einem Mandanten auslesen

EvalancheResourceInformation[] getSendableDraftsByMandatorId(int mandator_id, bool unsent)
Details

Parameter

  • int mandator_id: Die Id des Mandanten aus dem Entwürfe gesucht werden sollen bool unsent: Wenn true übergeben wird, werden nur Entwürfe zurückgeliefert, die noch nicht versendet wurden

Rückgabewert

  • EvalancheResourceInformation[]: Liste von Objekten analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

keine

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDraftsByMandatorId>
 <mandator_id>MANDATOR_ID</mandator_id>
 <unsent>0/1</unsent>
 </mail:getSendableDraftsByMandatorId>
 </soapenv:Body>
</soapenv:Envelope>

 

createDraft

Ein Mailing aus einer Vorlage erstellen

EvalancheResourceInformation createDraft(string name, int template_id, int category_id, int type_id)
Details

Parameter

  • string name: Name des anzulegenden Mailings
  • int template_id: Id der zu verwendenden Vorlage
  • int category_id: Id des Ordners, in welchem das Mailing angelegt werden soll
  • int type_id (optional): Id des eMailing-Types
    • 66 - reguläres eMailing - Default
    • 69 - Event eMailing
    • 76 - Trigger eMailing

Rückgabewert

  • EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

eMailing erzeugen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:createDraft>
 <name>MAILING_NAME</name>
 <template_id>TEMPLATE_ID</template_id>
 <category_id>CATEGORY_ID</category_id>
<!-- optional parameter type_id -->
<type_id>TYPE_ID</type_id>
 </mail:createDraft>
 </soapenv:Body>
</soapenv:Envelope>

 

getArticles

Artikel eines Mailings auslesen

MailingArticle[] getArticles(int mailing_id)
Details

Parameter

  • int mailing_id: Id des Mailings, aus welchem die Artikel ausgelesen werden sollen

Rückgabewert

  • MailingArticle[]: Liste von Objekten mit folgenden Attributen:
    • int id: Id der Artikelreferenz (Verbindung zwischen eigentlichem Artikel und Mailing)
    • int article_id: Id des Artikelobjektes
    • int targetgroup_id: Id der Zielgruppe, für ausschließlich welche der Artikel angezeigt werden soll
    • int sortpos: Position des Artikels innerhalb seines Slots beginnend bei 0
    • int slot: Numer des Slots, in dem sich der Artikel befindet beginnend bei 0
    • int html_preset_id: Id der zugewiesenen Artikelvorlage für die eMail (HTML) Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
    • int landingpage_preset_id: Id der zugewiesenen Artikelvorlage für die Landingpage Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
    • int text_preset_id: Id der zugewiesenen Artikelvorlage für die Text Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
    • int pdf_preset_id: Id der zugewiesenen Artikelvorlage für die PDF Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
    • int mobile_preset_id: Id der zugewiesenen Artikelvorlage für die mobile bzw. Web Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird

Benötigte Rechte

eMailing anzeigen

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticles>
 </soapenv:Body>
</soapenv:Envelope>

 

removeAllArticles

Alle Artikel eines Mailings entfernen

bool removeAllArticles(int mailing_id)
Details

Parameter

  • int mailing_id: Id des Mailings, aus welchem die Artikel entfernt werden sollen. Die Artikelobjekte als solche werden nicht verändert

Rückgabewert

  • bool: Im Erfolgsfall true

Benötigte Rechte

eMailing verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeAllArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:removeAllArticles>
 </soapenv:Body>
</soapenv:Envelope>

 

removeArticles

Bestimmte Artikel eines Mailings entfernen

MailingArticle[] removeArticles(int mailing_id, int[] reference_ids)
Details

Parameter

  • int mailing_id: Id des Mailings, aus welchem die Artikel entfernt werden sollen. Die Artikelobjekte als solche werden nicht verändert
  • int[] reference_ids: Liste von Artikelreferenz-Ids der zu entfernenden Artikel. Die Ids können durch die Methode getArticles ermittelt werden ( MailingArticle:id)

Rückgabewert

  • MailingArticle[] Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen - nach dem Entfernen der angegebenen Artikel. true

Benötigte Rechte

eMailing verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <reference_ids>
 <!--Zero or more repetitions:-->
 <item>UNIQUE_ARTICLE_ID</item>
 </reference_ids>
 </mail:removeArticles>
 </soapenv:Body>
</soapenv:Envelope>

 

addArticles

Artikel zu einem Mailing hinzufügen und bestehende Artikel aktualisieren

MailingArticle[] addArticles(int mailing_id, MailingArticle[] articles)
Details

Parameter

  • int mailing_id: Id des Mailings, in welchem die Artikel aktualisiert bzw. eingefügt werden sollen
  • MailingArticle[] articles: Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen. Ob eine Aktualisierung oder Neuanlage durchgeführt wird, wird über das Attribut MailingArticle:id eines Artikels gesteuert. Wird hier eine gültige Artikelreferenz Id übergeben, wird der entsprechende Artikel aktualisiert. Wird 0 übergeben wird der Artikel eingefügt.

Rückgabewert

  • Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen - nach dem Einfügen bzw. Aktualisieren der Artikel

Benötigte Rechte

eMailing verändern

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:addArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <articles>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 10 items in any order-->
 <id>0</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </articles>
 </mail:addArticles>
 </soapenv:Body>
</soapenv:Envelope>

 

sendToTargetgroup

Ein Mailing an eine Zielgruppe versenden

EvalancheMailingInformation sendToTargetgroup(int mailing_id, int targetgroup_id, int send_time, int speed)
Details

Parameter

  • int mailing_id: Id des zu versendenden Mailingentwurfes
  • int targetgroup_id: Id der Zielgruppe
  • int send_time: Unix Timestamp des Versandzeitpunktes (UTC). Liegt dieser in der Vergangenheit, startet der Versand sofort
  • int speed: Versandgeschwindigkeit in Mails/Stunde. Ist dieser Wert 0, wird keine Drosselung vorgenommen

Rückgabewert

  • EvalancheMailingInformation: Objekt analog zur Methode getDetails (Details einer Versendung abfragen)

Benötigte Rechte

eMailing verwalten

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:sendToTargetgroup>
 <mailing_id>MAILING_ID</mailing_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_time>TIMESTAMP_SEND_TIME</send_time>
 <speed>SENDSPEED</speed>
 </mail:sendToTargetgroup>
 </soapenv:Body>
</soapenv:Envelope>

 

sendToProfiles

Ein Mailing an einzelne Profile senden

int[] sendToProfiles(int mailing_id, int[] profile_ids)
Details

Parameter

  • int mailing_id: Id des Mailings int[] profile_ids: Liste von Profil Ids

Rückgabewert

  • int[]: Liste mit den Ids der Profile, an die der Versand erfolgreich war

Benötigte Rechte

eMailing verwalten

Verwendung

Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:sendToProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <profile_ids>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ID</item>
 </profile_ids>
 </mail:sendToProfiles>
 </soapenv:Body>
</soapenv:Envelope>

 

Verwandte Beiträge