Über die Bot-API kann ein Fremdsystem automatisch in alle Unterhaltungen eines Unternehmens mit eingebunden werden. Hierbei wird der Bot über Befehle angesprochen, die mit einem Doppelpunkt beginnen. Beispiel:
:auftraege
Die Anbindung erfolgt durch Angabe einer über das Internet erreichbaren URL. Zur Authentifizierung wird der Geheimschlüssel des Unternehmens als Header authorization übertragen. Dieser gewährleistet, dass die API nicht von Unbefugten verwendet werden kann.
Damit dieses Verfahren sicher ist, sollte die Anbindung über SSL (HTTPS) erfolgen.
Damit der Bot entsprechend reagieren kann, werden die folgenden Parameter mitgegeben:
| Parameter | Beschreibung |
|---|---|
| command | Enthält den Befehl, der direkt hinter dem Dopplepunkt eingegeben wurde. |
| params | Enthält weitere Parameter die mit einem Leerzeichen von dem Befehl abgetrennt sind. |
| topic | Enthält das Thema der Unterhaltung. |
| silent | Gibt an, ob der Befehl unsichtbar (true) aufgerufen wurde - oder ob der Befehl in der Unterhaltung angezeigt wird (false) |
| references | Enthält die Referenz(en) der Unterhaltung (falls vorhanden). Sind mehrere Werte vorhanden, werden diese kommagetrennt übergeben |
| tags | Enthält die Tags der Unterhaltung (falls vorhanden). Sind mehrere Werte vorhanden, werden diese kommagetrennt übergeben |
| caller | Enthält die E-Mail-Adresse des Aufrufers des Befehls. (Diese muss bereits verifiziert sein). |
| internalUser | Enthält die E-Mail-Adresse des ersten Unterhaltungsteilnehmers der zu dem Unternehmen gehört, zu dem auch der Bot gehört. (Diese muss bereits verifiziert sein). |
| externalUser | Enthält die E-Mail-Adresse des ersten Unterhaltungsteilnehmers der nicht zu dem Unternehmen des Bots gehört. (Diese muss bereits verifiziert sein). |
Die Antwort des Bots wird direkt in die Unterhaltung eingefügt. Hierbei kann kein HTML, aber die von MEMOIO unterstützte Auszeichnungssprache verwendet werden.
Weiterhin kann über den Header X-References eine oder mehrere Referenzen (kommagetrennt) übertragen werden, die bei der Unterhaltung hinterlegt wird. Zusätzlich kann über X-Tags ein oder mehrere Tags (kommagetrennt) hinzugefügt werden.
Über den Header X-Visibility kann durch Angabe von message-only gesteuert werden, dass die
Bot-Antwort nur dem Aufrufer als Hinweis angezeigt, aber nicht in die Unterhaltung aufgenommen wird.
Wird sticky-message-only verwendet, so wird die Nachricht wieder nur dem Aufrufer angezeigt,
jedoch als dauerhafter Dialog.
Enthält eine Unterhaltung mehrere Bots (zwei Teilnehmer aus unterschiedlichen Unternehmen die jeweils einen Bot haben), so wird bevorzugt der Bot des "angesprochenen" Teilnehmers, also nicht der, der die Konversation gestartet hat, verwendet.