Integration eines benutzerdefinierten Service Desks mit Orchestrate Chat

Voraussetzungen

Bevor Sie mit der Integration beginnen, müssen Sie ein Objekt oder eine Klasse erstellen, die den Standards des Orchestrate Chat Service Desk-Modells entspricht. Laden Sie die erforderliche Schnittstelle hier herunter.

Überblick über die Integration

Orchestrate Chat unterstützt die Integration mit benutzerdefinierten Service Desks oder Contact Centern, die es den Benutzern ermöglichen, mit menschlichen Agenten zu interagieren. Zu integrieren:

1. Erstellen Sie ein konformes Objekt oder eine konforme Klasse auf der Grundlage des Orchestrate Chat Service Desk-Modells. Weitere Informationen finden Sie unter Voraussetzungen.

2. Implementieren Sie eine Factory-Funktion in Ihrer Orchestrate-Chat-Konfiguration, die bei Anforderung eine neue Instanz Ihrer Integration zurückgibt.

Anforderungen für die benutzerdefinierte Service Desk-Integration

Um mit Orchestrate Chat zu arbeiten, muss Ihr Service Desk:

• Unterstützung der browserbasierten Kommunikation.

• Halten Sie die Schnittstellenstandards von Orchestrate Chat ein.

• Stellen Sie HTTP Endpunkte oder WebSocket Schnittstellen zur Verfügung:

  • Chats starten.

  • Empfangen von Benutzernachrichten.

  • Senden Sie Agentennachrichten an Benutzer.

Umgang mit Geheimnissen

Wenn Ihr Service Desk Geheimnisse (wie API-Schlüssel) benötigt:

• Verwenden Sie serverseitige Middleware für Proxy-Anfragen.

• Die Middleware fügt die erforderlichen Geheimnisse hinzu, bevor die Anfrage weitergeleitet wird.

Herkunftsübergreifende Anfragen

Wenn Ihr Service Desk auf einer anderen Domäne gehostet wird:

• Stellen Sie sicher, dass es „ CORS “ unterstützt.

• Falls nicht, leiten Sie die Anfragen über Ihren Server weiter.

Beispiel Integration

Das folgende einfache Beispiel zeigt, wie eine benutzerdefinierte Service Desk-Integration registriert wird, die eine Fabrikfunktion verwendet:

<script>
// Define your custom service desk class
class MyServiceDesk {
    constructor(parameters) {
        this.callback = parameters.callback;
        console.log("Service Desk started", parameters);
    }

    getName() {
        return 'MyServiceDesk';
    }

    startChat() {
        // Start chat logic
        // Call callback.agentJoined when an agent joins
        // Call callback.sendMessageToUser when agent sends a message
    }

    endChat() {
        // End chat logic
    }

    sendMessageToAgent() {
        // Send user message to agent
    }
}

// Register the integration with Orchestrate Chat
window.wxOConfiguration = {
    orchestrationID: '...',
    serviceDesk: {
        customFactory: (parameters) => new MyServiceDesk(parameters),
    },
};
</script>

API-Übersicht

Orchestrate Chat bietet eine öffentliche API für die Integration mit kundenspezifischen Service Desks. Ihre Integration muss umgesetzt werden:

• startChat: Benachrichtigen Sie den Service Desk, wenn ein Chat beginnt.

• sendMessageToAgent: Senden Sie Benutzernachrichten an den Agenten.

Orchestrate Chat bietet auch Callback-Funktionen für den Service Desk, um zu antworten:

• agentJoined: Benachrichtigung, wenn ein Agent beitritt.

• sendMessageToUser: Senden von Nachrichten vom Agenten an den Benutzer.

Interaktionsfluss

Eine typische Interaktion läuft folgendermaßen ab:

1. Orchestrate Chat initialisiert eine einzelne Instanz Ihres benutzerdefinierten Service Desks, die customFactory verwendet.

2. Ein Benutzer sendet eine Nachricht, die eine Antwort von connect_to_agent auslöst.

3. Falls implementiert, ruft Orchestrate Chat areAnyAgentsOnline an, um die Verfügbarkeit von Agenten zu prüfen.

4. Benutzer klickt auf Request Agent.

5. Orchestrieren Sie Chat-Anrufe startChat, indem Sie eine Sitzung mit dem Service Desk einleiten.

6. Ein Banner informiert den Benutzer darüber, dass ein Agent verbunden wird.

7. Wenn ein Agent beitritt, ruft Ihre Integration callback.agentJoined auf.

8. Agentennachrichten werden über callback.sendMessageToUser gesendet.

9. Benutzernachrichten werden über sendMessageToAgent gesendet.

10. Wenn der Chat endet, ruft Orchestrate Chat endChat auf.

API-Details

Um einen benutzerdefinierten Service Desk mit Orchestrate Chat zu integrieren, müssen Sie bestimmte Methoden implementieren, die in den Schnittstellen von TypeScript definiert sind.

Unterstützte Antworttypen

Die Methode callback.sendMessageToUser wird verwendet, um Nachrichten für die Benutzer anzuzeigen.