Nachrichten-API

Über die Nachrichten-API kann ein Fremdsystem automatisiert Unterhaltungen über MEMOIO starten.

Zur Authentifizierung wird der Geheimschlüssel des Unternehmens als Header authorization übertragen. Dieser gewährleistet, dass der Aufruf tatsächlich von dem Fremdsystem stammt. Sollte dies nicht möglich sein, so kann er auch als Parameter key übertragen werden.

Push-Nachricht senden

Sendet die Nachricht im Namen der Firma an einen Benutzer. Sollte dieser antworten, so wird er mit dem angegebenen Channel verbunden.

Der Aufruf erfolgt über: https://memoio.com/api/start-conversation

Es müssen die folgenden Parameter gefüllt sein (entweder als GET oder als POST). Fett gedruckte Parameter sind Pflicht-Parameter.

Parameter	Beschreibung
receiver	Enthält die E-Mail-Adresse des Empfängers der Nachricht
receiverName	Enthält den Namen des Empfängers - dies wird benötigt, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
receiverCompany	Enthält den Firmennamen des Empfängers - dies wird verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
message	Enthält die eigentliche Nachricht (vgl. description unten).
channel	Enthält den Channel, über den ein Ansprechpartner ermittelt wird, falls der Empfänger auf die Nachricht antwortet.
references	Enthält die Referenzen der Unterhaltung (falls vorhanden). Trennen Sie mehrere Werte mit einem Komma.
tags	Enthält Tags, die für die Unterhaltung verwendet werden sollen (falls vorhanden). Trennen Sie mehrere Werte mit einem Komma.
description	Enthält eine optionale zweite Nachricht. Wenn die zu sendende Nachricht sehr umfangreich ist, sollte in message eher eine Art Überschrift und in diesem Feld die volle Nachricht mit ggf. weiteren Inhalten übertragen werden.
groupBy	Gibt an ob die Unterhaltung mit vorherigen Unterhaltungen kombiniert werden soll. Dies ermöglicht es mehrere Nachrichten (zu verschiedenen Zeitpunkten) in eine Unterhaltung einzubringen. Mögliche Werte (Mehrere Gruppierungen können mit einem Komma getrennt werden): reference: Nur mit einer Unterhaltung mit der selben Referenz gruppieren. tags: Nur mit einer Unterhaltung mit den selben Tags gruppieren. Die Unterhaltung kann neben diesen Tags noch weitere Tags haben. message: Nur mit einer Unterhaltung mit dem selben Betreff gruppieren. sameDay: Nur mit einer Unterhaltung gruppieren, die am selben Tag erstellt wurde. sameWeek: Nur mit einer Unterhaltung gruppieren, die in der selben Woche erstellt wurde. sameMonth: Nur mit einer Unterhaltung gruppieren, die im selben Monat erstellt wurde.

Direkte Unterhaltung starten

Verbindet die beiden angegebenen Benutzer in einer Unterhaltung im Auftrag der Firma. Einer der beiden Teilnehmer muss zu der Firma gehören.

Der Aufruf erfolgt über: https://memoio.com/api/start-direct-conversation

Es müssen die folgenden Parameter gefüllt sein (entweder als GET oder als POST). Fett gedruckte Parameter sind Pflicht-Parameter.

Parameter	Beschreibung
sender	Enthält die E-Mail-Adresse des Senders (erster Teilnehmer der Unterhaltung).
senderName	Enthält den Namen des Senders - dies wird benötigt, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
senderCompany	Enthält den Firmennamen des Senders - dies wird verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
receiver	Enthält die E-Mail-Adresse des Empfängers (zweiter Teilnehmer der Unterhaltung).
receiverName	Enthält den Namen des Empfängers - dies wird benötigt, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
receiverCompany	Enthält den Firmennamen des Empfängers - dies wird verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt.
message	Enthält die eigentliche Nachricht (vgl. description unten).
references	Enthält die Referenzen der Unterhaltung (falls vorhanden). Trennen Sie mehrere Werte mit einem Komma.
tags	Enthält Tags, die für die Unterhaltung verwendet werden sollen (falls vorhanden). Trennen Sie mehrere Werte mit einem Komma.
description	Enthält eine optionale zweite Nachricht. Wenn die zu sendende Nachricht sehr umfangreich ist, sollte in message eher eine Art Überschrift und in diesem Feld die volle Nachricht mit ggf. weiteren Inhalten übertragen werden.

Zurück zur Übersicht