Technische Dokumentation
Wird abgelöst
Über die Nachrichten-API kann ein Fremdsystem automatisiert Unterhaltungen über MEMOIO starten und Nachrichten senden. Voraussetzung ist, dass die Nachrichten-API für Ihr Unternehmen freigeschaltet ist.
Jeder Aufruf enthält den Parameter companyId mit der ID Ihres Unternehmens sowie einen
Access-Token, der aus dem API-Key Ihres Unternehmens berechnet wird.
Der Access-Token wird im Header Authorization übertragen.
Sollte dies nicht möglich sein, so kann er auch als Parameter key übertragen werden.
Der API-Key selbst wird niemals übertragen.
Die Parameter werden entweder via GET oder via POST übergeben.
Fett gedruckte Parameter sind Pflicht-Parameter.
Als Antwort liefert MEMOIO ein JSON-Objekt, das im Erfolgsfall die ID der Unterhaltung im Feld conversationId enthält.
Diese ID kann für weitere Nachrichten verwendet werden.
Sendet die Nachricht im Namen des Unternehmens an einen oder mehrere Empfänger. Sobald ein Empfänger antwortet, wird er mit dem angegebenen Channel verbunden. Der Aufruf erfolgt über:
https://memoio.test.scireum.com/api/start-conversation
| Parameter | Beschreibung |
|---|---|
| companyId | Enthält die ID Ihres Unternehmens. |
| channel | Enthält die ID eines Channels Ihres Unternehmens, über den ein Ansprechpartner ermittelt wird, falls ein Empfänger auf die Nachricht antwortet. |
| receiver | Enthält die E-Mail-Adresse des Empfängers. Für mehrere Empfänger wird der Parameter mehrfach angegeben. |
| receiverName | Enthält den Namen des Empfängers. Er wird nur verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt. Bei mehreren Empfängern wird der Parameter genauso oft wie receiver angegeben oder ganz weggelassen. |
| receiverCompany | Enthält den Firmennamen des Empfängers. Er wird nur verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt. Bei mehreren Empfängern wird der Parameter genauso oft wie receiver angegeben oder ganz weggelassen. |
| message | Enthält die eigentliche Nachricht. Sie dient zugleich als Thema der Unterhaltung. (Vgl. description unten.) |
| 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. |
| references | Enthält die Referenzen der Unterhaltung. Trennen Sie mehrere Werte mit einem Komma oder geben Sie den Parameter mehrfach an. |
| tags | Enthält Tags, die für die Unterhaltung verwendet werden sollen. Trennen Sie mehrere Werte mit einem Komma oder geben Sie den Parameter mehrfach an. |
| groupBy | Gibt an, ob die Nachricht in eine frühere Unterhaltung eingefügt werden soll, siehe Gruppierung. |
| flags | Legt Eigenschaften einer neuen Unterhaltung fest: confidential macht sie vertraulich, chat wandelt sie in einen Chatraum um. Trennen Sie mehrere Werte mit einem Komma oder geben Sie den Parameter mehrfach an. |
Verbindet einen Mitarbeiter Ihres Unternehmens mit einem oder mehreren Empfängern in einer Unterhaltung im Auftrag des Unternehmens. Der Aufruf erfolgt über:
https://memoio.test.scireum.com/api/start-direct-conversation
| Parameter | Beschreibung |
|---|---|
| companyId | Enthält die ID Ihres Unternehmens. |
| sender | Enthält die E-Mail-Adresse des Senders (erster Teilnehmer der Unterhaltung). Der Sender muss zu Ihrem Unternehmen gehören; er darf nicht zugleich Empfänger sein. |
| senderName | Enthält den Namen des Senders. Er wird nur verwendet, falls für den Sender noch kein MEMOIO-Zugang vorliegt. |
| senderCompany | Enthält den Firmennamen des Senders. Er wird nur verwendet, falls für den Sender noch kein MEMOIO-Zugang vorliegt. |
| receiver | Enthält die E-Mail-Adresse des Empfängers. Für mehrere Empfänger wird der Parameter mehrfach angegeben. |
| receiverName | Enthält den Namen des Empfängers. Er wird nur verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt. Bei mehreren Empfängern wird der Parameter genauso oft wie receiver angegeben oder ganz weggelassen. |
| receiverCompany | Enthält den Firmennamen des Empfängers. Er wird nur verwendet, falls für den Empfänger noch kein MEMOIO-Zugang vorliegt. Bei mehreren Empfängern wird der Parameter genauso oft wie receiver angegeben oder ganz weggelassen. |
| message | Enthält die eigentliche Nachricht. Sie dient zugleich als Thema der Unterhaltung. (Vgl. description unten.) |
| 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. |
| references | Enthält die Referenzen der Unterhaltung. Trennen Sie mehrere Werte mit einem Komma oder geben Sie den Parameter mehrfach an. |
| tags | Enthält Tags, die für die Unterhaltung verwendet werden sollen. Trennen Sie mehrere Werte mit einem Komma oder geben Sie den Parameter mehrfach an. |
| groupBy | Gibt an, ob die Nachricht in eine frühere Unterhaltung eingefügt werden soll, siehe Gruppierung. |
| flags | Legt Eigenschaften einer neuen Unterhaltung fest, wie bei der Push-Nachricht. |
Startet eine Unterhaltung zwischen einem Mitarbeiter Ihres Unternehmens und einem Channel Ihres Unternehmens. Der Aufruf erfolgt über:
https://memoio.test.scireum.com/api/start-conversation-with-own-channel
| Parameter | Beschreibung |
|---|---|
| companyId | Enthält die ID Ihres Unternehmens. |
| receiverChannel | Enthält die ID eines Channels Ihres Unternehmens. |
| sender | Enthält die E-Mail-Adresse des Senders. Der Sender muss zu Ihrem Unternehmen gehören. |
| senderName | Enthält den Namen des Senders. Er wird nur verwendet, falls für den Sender noch kein MEMOIO-Zugang vorliegt. |
| message | Enthält die eigentliche Nachricht. Sie dient zugleich als Thema der Unterhaltung. |
| description | Enthält eine optionale zweite Nachricht, wie bei der Push-Nachricht. |
| flags | Legt Eigenschaften der Unterhaltung fest, wie bei der Push-Nachricht. |
Sendet eine Nachricht im Namen des Unternehmens in eine bestehende Unterhaltung. Ihr Unternehmen oder einer seiner Mitarbeiter muss an der Unterhaltung beteiligt sein. Für neue Anbindungen empfehlen wir stattdessen die neue REST-API; sie sendet im Namen der Person, der der Zugriffstoken gehört. Der Aufruf erfolgt über:
https://memoio.test.scireum.com/api/send-message
| Parameter | Beschreibung |
|---|---|
| companyId | Enthält die ID Ihres Unternehmens. |
| conversation | Enthält die ID der Unterhaltung, etwa aus der Antwort eines früheren Aufrufs. |
| message | Enthält die Nachricht. |
Mit dem Parameter groupBy fügt MEMOIO die Nachricht in eine frühere Unterhaltung ein, statt eine neue zu starten. Infrage kommen nur Unterhaltungen Ihres Unternehmens mit genau denselben Teilnehmern. Erfüllen mehrere Unterhaltungen die Kriterien, wird die zuletzt aktive gewählt. Mehrere Kriterien werden mit einem Komma getrennt oder durch mehrfache Angabe des Parameters kombiniert; es müssen dann alle erfüllt sein.
- reference: Die Unterhaltung hat alle angegebenen Referenzen.
- tags: Die Unterhaltung hat alle angegebenen Tags. Sie kann daneben noch weitere Tags haben.
- message: Das Thema der Unterhaltung entspricht der Nachricht in message.
- sameDay: Die Unterhaltung war heute aktiv.
- sameWeek: Die Unterhaltung war in der laufenden Woche (ab Montag) aktiv.
- sameMonth: Die Unterhaltung war im laufenden Monat aktiv.
Wird eine frühere Unterhaltung fortgesetzt, so sendet MEMOIO nur message und description. Ist description angegeben und entspricht message dem Thema der Unterhaltung, so entfällt message, damit die Überschrift nicht wiederholt wird. Referenzen, Tags und flags bleiben in diesem Fall unberücksichtigt.