Intégration d'un service desk personnalisé avec Orchestrate Chat

Prérequis

Avant de commencer l'intégration, vous devez créer un objet ou une classe qui respecte les normes du modèle de service desk Orchestrate Chat. Téléchargez l'interface requise ici.

Vue d'ensemble de l'intégration

Orchestrate Chat prend en charge l'intégration avec des centres de services ou de contacts personnalisés, ce qui permet aux utilisateurs d'interagir avec des agents humains. A intégrer :

1. Créer un objet ou une classe conforme basé sur le modèle du service desk Orchestrate Chat. Pour plus d'informations, voir les conditions préalables.

2. Mettez en œuvre une fonction d'usine dans votre configuration Orchestrate Chat qui renvoie une nouvelle instance de votre intégration lorsqu'elle est demandée.

Exigences pour l'intégration d'un service desk personnalisé

Pour fonctionner avec Orchestrate Chat, votre service d'assistance doit :

• Prendre en charge les communications basées sur un navigateur.

• Respecter les normes d'interface d'Orchestrate Chat.

• Fournir des points d'extrémité HTTP ou des interfaces WebSocket à :

  • Commencez à discuter.

  • Recevoir des messages d'utilisateurs.

  • Envoyer des messages d'agent aux utilisateurs.

Manipuler les secrets

Si votre service desk requiert des secrets (tels que des clés API) :

• Utiliser un logiciel intermédiaire côté serveur pour transmettre les demandes par proxy.

• L'intergiciel ajoute les secrets requis avant que la demande ne soit transmise.

Demandes d'origine croisée

Si votre service desk est hébergé sur un autre domaine :

• Assurez-vous qu'il prend en charge la fonction « CORS ».

• Si ce n'est pas le cas, faites passer les demandes par votre serveur.

Exemple d'intégration

L'exemple suivant montre comment enregistrer une intégration de service desk personnalisée qui utilise une fonction d'usine :

<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>

Présentation de l'API

Orchestrate Chat fournit une API publique pour l'intégration avec des bureaux de service personnalisés. Votre intégration doit être mise en œuvre :

• startChat: Notifier le service d'assistance lorsqu'un chat commence.

• sendMessageToAgent: Envoyer des messages d'utilisateur à l'agent.

Orchestrate Chat fournit également des fonctions de rappel pour que le service d'assistance puisse répondre :

• agentJoined: Notifier l'arrivée d'un agent.

• sendMessageToUser: Envoyer des messages de l'agent à l'utilisateur.

Flux d'interaction

Une interaction typique se déroule de la manière suivante :

1. Orchestrate Chat initialise une instance unique de votre service desk personnalisé qui utilise customFactory.

2. Un utilisateur envoie un message qui déclenche une réponse sur connect_to_agent .

3. S'il est mis en œuvre, Orchestrate Chat appelle areAnyAgentsOnline pour vérifier la disponibilité des agents.

4. L'utilisateur clique sur Demander un agent.

5. Orchestrer les appels de chat startChat, en lançant une session avec le service d'assistance.

6. Une bannière informe l'utilisateur qu'un agent est en train d'être connecté.

7. Lorsqu'un agent s'inscrit, votre intégration appelle callback.agentJoined.

8. Les messages des agents sont envoyés par l'intermédiaire de callback.sendMessageToUser.

9. Les messages des utilisateurs sont envoyés par l'intermédiaire de sendMessageToAgent.

10. Lorsque le chat se termine, Orchestrate Chat appelle endChat.

Détails relatifs aux API

Pour intégrer un service desk personnalisé à Orchestrate Chat, vous devez implémenter des méthodes spécifiques définies dans les interfaces TypeScript.

Types de réponses prises en charge

La méthode callback.sendMessageToUser est utilisée pour afficher des messages aux utilisateurs.