API Tutorial

Einführung

You can connect Userlike to your custom back-end or legacy CRM. Get notified about interactions with your visitors and customers, monitor your operator states and resources using this callback API add-on. Subscribe to a set of events for which you will receive an HTTP POST callback to your endpoint.

Account registrieren

Schritt 1

Gehen Sie zur Add-on- Übersicht und wählen Sie die Option zur API-Konfiguration.

Schritt 2

Geben Sie die Callback-URL Ihres API-Endpoints ein. Die Protokolle HTTP und HTTPS werden unterstützt. Das "POST"-Callback sendet Ihre Daten an Ihre URL, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Die Callback-URL muss aus dem Internet erreichbar sein, damit dieses Add-on aufgesetzt werden kann. Es muss einen HTTP-200-Code zurückgeben, nachdem es die POST-Anfrage erhält.

Die Datei, die Sie per E-Mail erhalten werden, ist ein JSON-Objekt. Falls Sie die Javascript-API nutzen, um Ihre Webvisitor-Daten an den Chat-Client weiterzugeben, dann wird dies in Ihrem "custom"-Feld als Objekt angezeigt.

API Callbacks

Die Calls werden in fünf Formaten fest zugeordnet, die über das _type-Feld identifiziert werden.

TypBeschreibung
offline_messageBezeichnet eine Offline-Nachricht, weitere Information zum Datenformat erhalten Sie im nächsten Absatz.
chat_metaBezeichnet einen Chat, weitere Information zum Datenformat erhalten Sie im nächsten Absatz.
chat_widgetBezeichnet ein Widget, weitere Information zum Datenformat erhalten Sie im nächsten Absatz.
operatorBezeichnet die Statusänderung eines Operators, das Dateiformat wird in den nächsten Paragraphen im Detail erklärt.
miscMarkiert Events, die in keins der obengenannten Formate passen.

Konfigurieren Sie Ihr Add-on oder erhalten Sie Informationen über bestimmte Events für die Sie einen Callback erhalten wollen.

TypEventBeschreibung
offline_messagereceiveErhalten Sie einen Callback für jede neue Offline-Nachricht.
chat_metastartErhalten Sie einen Callback für jede neue Chat-Session.
chat_metaforwardErhalten Sie einen Callback, wenn eine Chat-Session weitergeleitet wurde.
chat_metaratingErhalten Sie einen Callback, wenn eine Chat-Session ein Rating erhalten hat.
chat_metafeedbackErhalten Sie einen Callback, wenn eine Chat-Session ein Feedback erhalten hat.
chat_metasurveyErhalten Sie einen Callback, wenn nach einem Chat eine Umfrage ausgefüllt wurde.
chat_metareceiveErhalten Sie einen Callback, wenn eine Chat-Session beendet wurde.
chat_metagoalErhalten Sie einen Callback, wenn eine Goal erreicht wurde.
chat_widgetconfigErhalten Sie einen Callback, wenn eine Widget-Konfiguration sich ändert.
operatoronlineErhalten Sie einen Callback, wenn ein Operator online geht.
operatorofflineErhalten Sie einen Callback, wenn ein Operator offline geht.
operatorawayErhalten Sie einen Callback, wenn ein Operator "abwesend" wird.
operatorbackErhalten Sie einen Callback, wenn ein Operator zurückkehrt.

Offline Message - Receive

Erhalten Sie einen Callback für jede neue Offline-Nachricht. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Meta - Start

Erhalten Sie einen Callback für jede neue Chat-Session. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Meta - Forward

Erhalten Sie einen Callback, wenn eine Chat-Session weitergeleitet wurde. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Meta - Rating

Erhalten Sie einen Callback, wenn eine Chat-Session ein Rating erhalten hat. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Meta - Feedback

Erhalten Sie einen Callback, wenn eine Chat-Session ein Feedback erhalten hat. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Chat Meta - Survey

Erhalten Sie einen Callback, wenn nach einem Chat eine Umfrage ausgefüllt wurde. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Meta - Receive

Erhalten Sie einen Callback, wenn eine Chat-Session beendet wurde. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten). Wenn Sie die Javascript API nutzen, um benutzerdefinierte Daten an Ihren Chat-Client zu senden, dann wird dies im "custom" Feld als Objekt dargestellt.

Chat Widget - Config

Erhalten Sie einen Callback, wenn ein Änderung am Widget vorgenommen wurde. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Operator - Online

Erhalten Sie einen Callback, wenn ein Operator online geht. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Operator - Offline

Erhalten Sie einen Callback, wenn ein Operator offline geht. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Operator - Away

Sie erhalten einen Callback, wenn ein Operator online geht. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Operator - Back

Erhalten Sie einen Callback, wenn ein Operator zurückkommt. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Misc - Chat Butler incoming

Erhalten Sie einen Callback, wenn eine neue Chat-Session wartet. Das "POST"-Callback zu Ihrem API Endpoint, die im Objekt enthaltenen Daten erhalten Sie im JSON-Format. Erfahren Sie mehr in unserem Beispiel (siehe unten).

Chat Butler ist ein simpler Chatbot, der automatisch auf Chat-Anfragen antwortet, wenn kein Operator sofort verfügbar ist und fortlaufend Ihr Service-Team benachrichtigt, dass ein Chat wartet. (komplettes Chat Butler-Tutorial).

Sie können diese Benachrichtigungen in jede Ihrer bestehenden Benachrichtigungs-Frameworks integrieren, indem Sie einen API-Endpunkt bereitstellen, der dieses Callback-Format verarbeitet:

Offline-Nachrichten senden

Nach dem Einrichtungsprozess können Sie Ihre Offline-Nachrichten von Ihrem Dashboard an Ihre API senden.

Chats senden

Die gleiche Funktion können Sie nutzen, um Chat-Transskripte an Ihre API zu senden. Sie können diese Aktion auch während des Chats mit einem Chat-Befehl auslösen.

  • $api - Aktuellen Chat an Ihre API senden.