sendMessages

Navigation:  WebService Calls > Options for Growth >

sendMessages

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Mit dieser Funktion ist es möglich sowohl E-Mails als auch plattformspezifische Nachrichten zu versenden.

Beispiel Request

Code

<request method="sendMessages" version="1.0.0">

   <email reference_id="1">

      <mandator_id>1</mandator_id>

      <email_account_id>366913</email_account_id>

      <recipients>

         <recipient>info@speed4trade.com</recipient>

      </recipients>

      <cc_recipients>

         <cc_recipient>…</cc_recipient>

      </cc_recipients>

      <bcc_recipients>

         <bcc_recipient>…</bcc_recipient>

      </bcc_recipients>

      <subject>subject</subject>

      <plain_text_message>plain text</plain_text_message>

      <html_text_message>&lt;html&gt;

         &lt;body&gt;

         &lt;h1&gt;ueberschrift&lt;/h1&gt;

         &lt;/body&gt;

         &lt;/html&gt; </html_text_message>

      <attachments>

         <attachment>

            <file_name>test.jpg</file_name>

            <base_64_data>/9j/4AAQSk ... 2Q==</base_64_data>

         </attachment>

      </attachments>

   </email>

<!-- [platform_specific_messages] --><!-- Plattformspezifische Daten --> 

</request>

Feldliste Request

Name

Beschreibung        

Anz.

Typ

sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„sendMessages“

version

Attribut von request. Legt die Version der Anfrage fest.

1

string

Fester Wert: „1.0.0“

email

Wrapper-Element, das zum Senden einer E-Mail verwendet wird.

0..n

Element

reference_id

Optionales Attribut des Elements "email". In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint.

0..1

string

Hinweise

mandator_id

ID des Mandanten.

1

integer

email_account_id

ID des E-Mail-Accounts.

1

integer

recipients

Wrapper-Element, das die Empfänger der E-Mail zusammenfasst.

1

Element

recipient

Element von recipients. E-Mail-Adresse des Empfängers.

1..n

string

cc_recipients

Wrapper-Element, das die CC-Empfänger der E-Mail zusammenfasst.

0..1

Element

cc_recipient

Element von cc_recipients. E-Mail-Adresse des CC-Empfängers.

1..n

string

bcc_recipients

Wrapper-Element, das die BCC-Empfänger der E-Mail zusammenfasst.

0..1

Element

bcc_recipient

Element von bcc_recipients. E-Mail-Adresse des BCC-Empfängers.

1..n

string

subject

Betreff der E-Mail.


plain_text_message

Nachrichteninhalt in Plain-Text.

0..1

string

html_text_message

Nachrichteninhalt in HTML.

0..1

string

attachments

Wrapper-Element, das die Anhänge der E-Mail zusammenfasst.

0..1

Element

attachment

Wrapper-Element, das einen einzelnen Anhang zusammenfasst.

1..n

file_name

Element von attachment. Name der Datei oder Pfad und Dateiname.

1

string

Hinweise

base_64_data

Element von attachment. Daten im Base64-Format. Element nur angeben wenn tatsächlich eine Datei via base64 übergeben werden soll.

0..1

string

Hinweise

[platform_specific_messages]

Platzhalter für die verschiedenen Daten der Verkaufsplattformen. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls sendMessages beschrieben.

0..N

Element

Beispiel Response

Code

<response method="sendMessages" version="1.0.0">

   <report return_code="0" reference_id="1">

      <email>

         <email_id>718900</email_id>

         <mandator_id>1</mandator_id>

         <email_account_id>366913</email_account_id>

         <recipients>info@speed4trade.com</recipients>

         <subject>ws mail test subject</subject>

      </email>

      <!-- [platform_specific_message] --><!-- Plattformspezifische Daten --> 

   </report>

</response>

Feldliste Response

Name

Beschreibung        

Anz.

Typ

sonstiges

response

Root-Element der Antwort

1

Element

method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„sendMessages“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation. Für jedes Nachrichten-Element aus dem Request wird ein Report zurückgegeben.

0..N

Element

return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

Feste Werte:

Siehe Return-Codes

reference_id

Optionales Attribut. In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint.

0..1

string

Hinweise

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert

0..1

string

email

Wrapper-Element, das die Daten einer E-Mail zusammenfasst. Erscheint nur, wenn im Request eine E-Mail versendet wurde

0..n

Element

email_id

ID der E-Mail

1

integer

mandator_id

ID des Mandanten.

1

integer

email_account_id

ID des E-Mail-Accounts

1

integer

recipients

Empfänger, einschließlich CC und BCC.

1

String

subject

Betreff

0..1

String

[platform_specific_message]

Platzhalter für die verschiedenen Daten der plattformspezifischen Nachrichten. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls sendMessages beschrieben.

1

Element

 

Hinweise

 

•Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an die betroffene Nachricht gebunden. Die gleiche ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports in den Response-Daten zu einem Block aus den Request-Daten. Dies ist insbesondere dann nützlich wenn es bei der Verarbeitung eines oder mehrerer der übergebenen Nachrichten zu Fehlern kommt. So kann die resultierende Fehlermeldung schnell zu einem Request-Bestandteil zugeordnet werden.

•Sie haben zwei Optionen via sendMessages Mailanhänge zu übergeben. Wird das base64-Format verwendet, dann ist unter dem Feld file_name nur der Dateiname zu übergeben (z.B. Anhang-001.jpg). Die Datei selbst ist im base_64_data Feld im Format base64 zu hinterlegen. Als weitere Möglichkeit kann der Anhang ohne Base64 übergeben werden. Dabei muss dann unter file_name der Dateiname samt dem vollen Pfad zur Datei auf dem Server angegeben werden (z.B. C:/daten/bilder/Anhang-001.jpg). Dateien im Netzwerk können via UNC-Pfad übergeben werden (z.B. \\srv-server\daten\bilder\Anhang-001.jpg). Das Feld base_64_data ist in diesem Fall wegzulassen.

Return-Codes

Für den Webservice-Call "sendMessages" sind folgende Return-Codes möglich:

Code

Beschreibung

0

Die Nachricht wurde erfolgreich gesendet.

-1

Die Nachricht konnte auf Grund eines unspezifizierten Fehlers nicht gesendet werden. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung.

Weitere Return-Codes gibt es unter den plattformspezifischen Daten

Änderungsübersicht

Version

Änderungsbeschreibung

3.4.9.1

Integration des Calls zum Anlegen von Nachrichten

4.6.40

Mailanhänge sind nun auch direkt ohne das Format Base64 möglich.