Einführung

Verbinden Sie Userlike mit Ihrem Backend, CRM oder einer anderen Drittanbieter-App. Lassen Sie sich über Ereignisse bei Interaktionen mit Ihren Kontakten, Statusänderungen Ihrer Operatoren und mehr benachrichtigen. Wählen Sie die Ereignisse aus, für die Sie eine HTTP-POST-Anfrage an Ihren Endpunkt erhalten wollen.

Schritt 1

Gehen Sie zum Abschnitt Add-ons und wählen Sie API aus.

Schritt 2

Geben Sie in den Add-on-Einstellungen die Callback-URL Ihres API-Endpunkts ein. HTTP und HTTPS werden als Protokolle unterstützt. Wir senden die Daten per POST-Anfrage an Ihre URL als JSON-Dokument mit dem Inhaltstyp application/JSON. Die eingegebene Callback-URL muss erreichbar sein. Nach Erhalt der POST-Anfrage erhalten Sie einen HTTP 200-Code zurück.
Sie können Ihrem API-Endpunkt zusätzliche Header hinzufügen (optional).
Image without caption
Wenn Sie die Website Messenger API verwenden, um benutzerdefinierte Daten (Custom Data) an den Website Messenger (Widget) zu übergeben, werden diese als Objekt im Feld custom in die Anfrage aufgenommen, die wir an Ihren Endpunkt senden.

API Callbacks

Die Aufrufe sind in fünf verschiedene Formate gruppiert, die durch das Feld _type unterschieden werden.
Die Datenformate werden hier ausführlicher erläutert:
Type
Description
chat_session
Bezeichnet eine Unterhaltungssitzung.
conversation
Bezeichnet eine Unterhaltung
um_widget
Bezeichnet ein Widget
operator
Bezeichnet einen Statuswechsel eines Operators
Sie können Ihr Add-on konfigurieren und eine Reihe von Ereignissen abonnieren, für die Sie einen Callback erhalten möchten.
Type
Event
Description
chat_session
start
Eine neue Unterhaltungssitzung wurde gestartet.
chat_session
message_received
Ein Kontakt sendet eine Nachricht an eine Unterhaltung.
chat_session
message_sent
Ein Operator sendet eine Nachricht an eine Unterhaltung.
chat_session
unread
Eine Unterhaltungssitzung endet, während Nachrichten noch nicht vom Operator gelesen wurden.
chat_session
end
Eine Unterhaltungssitzung wurde beendet.
conversation
ended
Der Status einer Unterhaltung wurde auf beendet gesetzt.
chat_session
forward
Eine Unterhaltung wurde einem anderen Operator oder einer anderen Operatorengruppe zugewiesen.
chat_session
rating
Ein Kontakt hat eine Bewertung in einer Unterhaltung hinterlassen.
chat_session
feedback
Ein Kontakt hat ein Feedback in einer Unterhaltung hinterlassen.
chat_session
survey
Ein Kontakt hat die Umfrage beantwortet, nachdem die Unterhaltung beendet wurde.
chat_session
goal
Ein Ziel wurde erreicht.
operator
online
Ein Operator geht online.
operator
offline
Ein Operator geht offline.
operator
away
Ein Operator stellt sich auf Abwesend.
operator
back
Ein Operator wechselt von Abwesend auf Online.
contact
created
Ein neuer Kontakt wurde erstellt.
contact
updated
Ein Kontakt wurde aktualisiert.
um_widget
config
Eine Widget-Konfiguration wurde bearbeitet.

Code Beispiele

Nachfolgend finden Sie Codebeispiele für jeden Callback.
chat_session_start
Eine neue Unterhaltungssitzung wurde gestartet.
Beispiel
chat_session_message_received
Ein Kontakt sendet eine Nachricht an eine Unterhaltung.
Beispiel
chat_session_message_sent
Ein Operator sendet eine Nachricht an eine Unterhaltung.
Beispiel
chat_session_end
Eine Unterhaltungssitzung wurde beendet.
Beispiel
chat_session_unread
Eine Unterhaltungssitzung endet, während Nachrichten noch nicht vom Operator gelesen wurden.
Beispiel
conversation_ended
Der Status einer Unterhaltung wurde auf beendet gesetzt.
Beispiel
chat_session_forward
Eine Unterhaltung wurde einem anderen Operator oder einer anderen Operatorengruppe zugewiesen.
Beispiel
chat_session_rating
Ein Kontakt hat eine Bewertung in einer Unterhaltung hinterlassen.
Beispiel
chat_session_feedback
Ein Kontakt hat ein Feedback in einer Unterhaltung hinterlassen.
Beispiel
chat_session_survey
Ein Kontakt hat die Umfrage beantwortet, nachdem die Unterhaltung beendet wurde.
Beispiel
chat_session_goal
Ein Ziel wurde erreicht.
Beispiel
operator_online
Ein Operator geht online.
Beispiel
operator_offline
Ein Operator geht offline.
Beispiel
operator_away
Ein Operator stellt sich auf Abwesend.
Beispiel
operator_back
Ein Operator wechselt von Abwesend auf Online.
Beispiel
contact_created
Ein neuer Kontakt wurde erstellt.
Beispiel
contact_updated
Ein Kontakt wurde aktualisiert.
Beispiel
um_widget_config
Eine Widget-Konfiguration wurde bearbeitet.
Beispiel

Senden von Konversationen an die API

Nachdem Sie das API Add-on konfiguriert haben, können Sie über das $api command oder über die Aktionsleiste Unterhaltungen dorthin senden.
Image without caption
Um mehrere Konversationen an die API zu senden, verwenden Sie das Menü für Massenaktionen unter Alle Konversationen im Message Center.
Image without caption
Nachdem Sie das API Add-on konfiguriert haben, können Sie über das $api command oder über die Aktionsleiste Unterhaltungen dorthin senden. Das Senden wird nun vorgemerkt und ausgeführt, sobald sich der Status der Unterhaltung ändert.