Benutzerdefinierter Support-Endpunkt

Überblick

Dieser Artikel erläutert, wie Sie einen benutzerdefinierten Support-Endpunkt mit Ferndesk verbinden. Diese Funktion ermöglicht es Ihnen, Ihr eigenes Ticket- oder Supportsystem zu integrieren, selbst wenn es von Ferndesk nicht nativ unterstützt wird.

Voraussetzungen

• Sie müssen über eine öffentlich zugängliche URL verfügen, die eine JSON-Antwort zurückgibt.

• Sie müssen über Berechtigungen zur Verwaltung von Integrationen in Ferndesk verfügen.

Schritte

1. Navigieren Sie in Ihren Fern-Einstellungen zur Seite Integrationen.

2. Klicken Sie auf die Schaltfläche "Integration hinzufügen". Dies führt Sie zur Seite Integration verbinden.

3. Wählen Sie "Support-Endpunkt" aus der Liste der verfügbaren Integrationen aus.

4. Im Konfigurationsdialog sehen Sie ein Feld mit der Bezeichnung "Quell-URL".

5. Geben Sie die URL Ihres benutzerdefinierten Support-Endpunkts ein. Der Platzhaltertext für dieses Feld lautet https://company.com/support-endpoint.json?startDate=2025-01-01.

6. Klicken Sie auf die Schaltfläche "Speichern", um den Endpunkt zu verbinden.

Einrichtung überprüfen

Sobald Sie Ihren benutzerdefinierten Support-Endpunkt verbunden haben, können Sie die korrekte Funktion überprüfen, indem Sie ein Audit erstellen. Wenn die Verbindung erfolgreich ist, sollten Konversationen aus Ihrem benutzerdefinierten Supportsystem im Audit enthalten sein.

JSON-Format

Der benutzerdefinierte Support-Endpunkt muss eine JSON-Antwort in einem spezifischen Format zurückgeben. Das Root-Objekt sollte einen Schlüssel namens conversations enthalten, der ein Array von Konversationsobjekten hält. Jedes Konversationsobjekt muss eine id, einen lastMessageAt-Zeitstempel und ein Array von messages enthalten. Jedes Nachrichtenobjekt innerhalb des Arrays sollte eine id, eine role (entweder user oder agent), einen content und einen createdAt-Zeitstempel enthalten.

Hier ist ein Beispiel für das erwartete JSON-Format:

{
  "conversations": [
    {
      "id": "conv_12345",
      "url": "https://support.mycompany.com/conversations/12345",
      "lastMessageAt": "2023-10-27T14:30:00Z",
      "messages": [
        {
          "id": "msg_67890",
          "role": "user",
          "content": "Hello, I'm having trouble with...",
          "createdAt": "2023-10-27T14:25:00Z"
        },
        {
          "id": "msg_67891",
          "role": "support_agent",
          "content": "Hi there, I can help with that. Could you please provide...",
          "createdAt": "2023-10-27T14:30:00Z"
        }
      ]
    }
  ]
}

Fehlerbehebung

• Falsches JSON-Format: Stellen Sie sicher, dass die JSON-Antwort Ihres Endpunkts dem in diesem Artikel beschriebenen Format entspricht.

• Ungültige URL: Stellen Sie sicher, dass die von Ihnen angegebene URL ein öffentlich zugänglicher Endpunkt ist.

• Authentifizierung: Diese Funktion unterstützt derzeit keine authentifizierten Endpunkte.