Guide pour le SDK Web headless

Le SDK Web headless vous permet d'étendre et de personnaliser l'expérience d'assistance de votre entreprise selon vos besoins. Il contient toutes les fonctionnalités habituelles de nos SDK Web et vous permet de créer l'UI et l'expérience utilisateur associées.

L'installation et l'utilisation du SDK Web headless nécessitent l'assistance de l'équipe de développement Web de votre organisation. Pour réussir l'intégration et obtenir des performances optimales, Google vous recommande de faire appel à votre personnel qualifié.

Dans le contexte du développement logiciel, le terme "headless" désigne une architecture découplée où la couche de présentation de l'interface (la "tête") est séparée de la logique et des fonctionnalités du backend. Dans une architecture headless, le backend, aussi appelé partie "headless", fournit des API qui vous permettent d'utiliser ses fonctionnalités et ses services.

L'automatisation des workflows personnalisés en est un exemple. Lorsqu'un utilisateur final lance un chat, l'événement on("chat.message") est déclenché. Vous pouvez définir des déclencheurs d'automatisation personnalisés en fonction de messages de chat spécifiques que vous avez reçus. Par exemple, si un utilisateur final saisit "Escalader" dans le chat, le gestionnaire d'événements peut automatiquement escalader la session de chat vers une équipe d'assistance de niveau supérieur, ce qui permet de traiter rapidement les problèmes critiques.

Ce guide vous explique comment installer, intégrer et utiliser le SDK. Pour en savoir plus sur l'utilisation de l'API, consultez la documentation de l'API du SDK Web headless. La liste des événements disponibles est disponible sur la page Événements.

Installer le SDK Web headless

Pour installer le client SDK Web sans interface graphique, utilisez l'extrait de code suivant dans votre projet.

Vous pouvez installer le package avec npm :

npm install @ujet/websdk-headless --save

Vous pouvez également utiliser le script hébergé par UJET :

<script src="https://websdk.ujet.co/v3/headless.js"></script>

<script>
  // The hosted script exposes the client as the global `UJETClient`.
  // const client = new UJETClient(...)
</script>

Utiliser le SDK Web headless

Pour utiliser le SDK Web headless, vous pouvez suivre l'exemple de code fourni :

import { Client } from "@ujet/websdk-headless"

async function authenticate() {
  const resp = await fetch("/your-auth-endpoint")
  const data = await resp.json()
  return { token: data.token }
}

const client = new Client({
  companyId: "YOUR-COMPANY-ID",
  tenant: "YOUR-TENANT-NAME",
  authenticate: authenticate,
})

// const company = await client.getCompany()
// const menus = await client.getMenus()

La classe Client accepte plusieurs options (que vous pouvez personnaliser en fonction de vos besoins) :

interface ClientOption {
  companyId: string;
  authenticate: () => Promise<TokenResponse>;
  tenant?: string;
  host?: string;
  lang?: string;
  bridge?: string;
  version?: string;
  cobrowse?: {
    enabled?: boolean;
    messages?: CobrowseMessages;
    api?: string;
    license?: string;
    trustedOrigins?: string[];
    capabilities?: string[];
    registration?: boolean;
    redactedViews?: string[];
    unredactedViews?: string[];
    template?: string;
  };
}

Activer la journalisation

Lors de l'implémentation et des tests, il peut être nécessaire de collecter des informations supplémentaires dans le journal de la console. Pour activer la journalisation pour le SDK headless, importez Logger et consoleLoggerHandler en ajoutant le code suivant à votre application Web :

import {Logger, consoleLoggerHandler } from '@ujet/websdk-headless'
Logger.addHandler(consoleLoggerHandler)

Configurer le partage d'écran

Vous pouvez activer et configurer le partage d'écran à l'aide du SDK Web headless.

L'exemple de code suivant vous montre comment activer le partage d'écran :

new Client({
  // ...
  cobrowse: {
    enabled: true,
    license: 'YOUR_SCREEN_SHARE_LICENSE'
  }
})

L'exemple de code suivant montre les options de partage d'écran :

interface CobrowseOption {
  enabled?: boolean
  // Widget-only - the following template + root options have no effect in the Headless SDK:
  template?: string
  confirmSessionTemplate?: string
  confirmRemoteControlTemplate?: string
  confirmFullDeviceTemplate?: string
  sessionControlsTemplate?: string
  root?: Element
  messages?: {
    confirmSessionTitle: string;
    confirmSessionContent: string;
    confirmRemoteControlTitle: string;
    confirmRemoteControlContent: string;
    confirmFullDeviceTitle: string;
    confirmFullDeviceContent: string;
    allowText: string;
    denyText: string;
    endSessionText: string;
  }
  api?: string
  license?: string
  trustedOrigins?: string[]
  capabilities?: string[]
  registration?: boolean
  redactedViews?: string[]
  unredactedViews?: string[]
  // Headless consent callbacks
  confirmSession?: () => Promise<boolean>
  confirmRemoteControl?: () => Promise<boolean>
  confirmFullDevice?: () => Promise<boolean>

  // Headless session-control callbacks
  showSessionControls?: () => void
  hideSessionControls?: () => void

  // Existing CobrowseIO instance
  instance?: any
}

Modèle personnalisé

Vous pouvez personnaliser le modèle de boîte de dialogue de partage d'écran à l'aide de l'option template de l'exemple de code précédent.

L'exemple suivant montre le modèle par défaut :

<dialog open class="cobrowse-dialog">
  <h1>$title</h1>
  <div class="cobrowse-dialog_content">$content</div>
  <div class="cobrowse-dialog_footer">
    <button class="cobrowse-dialog_allow js-cobrowse-allow">$allow</button>
    <button class="cobrowse-dialog_deny js-cobrowse-deny">$deny</button>
  </div>
</dialog>

Vous pouvez utiliser ce modèle pour configurer une boîte de dialogue qui demande l'approbation de l'utilisateur final pour les éléments suivants :

  • Démarrer une session de partage d'écran

  • Démarrer une session de partage d'écran avec contrôle à distance

  • Démarrer une session de partage d'écran de l'intégralité de l'appareil

Voici les options de modèle :

  • confirmSessionTemplate : pour confirmer une session de partage d'écran.

  • confirmRemoteControlTemplate : pour confirmer une session de partage d'écran avec contrôle à distance.

  • confirmFullDeviceTemplate. Pour confirmer une session de partage d'écran complet de l'appareil.

  • sessionControlsTemplate : pour le bouton des commandes de session. Voici le modèle par défaut : <button class="cobrowse-end js-cobrowse-end">$end</button>

Messages

Les variables de message suivantes sont utilisées dans les modèles personnalisés :

  • $title

  • $content

  • $allow

  • $deny

L'exemple suivant montre comment ces variables sont appliquées :

{
  confirmSessionTitle: string;  // $title
  confirmSessionContent: string;  // $content
  confirmRemoteControlTitle: string;  // $title
  confirmRemoteControlContent: string;  // $content
  confirmFullDeviceTitle: string;  // $title
  confirmFullDeviceContent: string;  // $content
  allowText: string;  // $allow
  denyText: string;  // $deny
  endSessionText: string;  // $end
}

L'exemple suivant montre les valeurs par défaut des variables en anglais :

{
  "confirmSessionTitle": "Screen Share Session Request",
  "confirmSessionContent": "Do you want to share your current screen with the agent?",
  "endSessionText": "End Screen Share Session",
  "confirmRemoteControlTitle": "Remote Access Request",
  "confirmRemoteControlContent": "The agent would like to have access to your currently shared screen to further assist you. Do you want to allow this?",
  "confirmFullDeviceTitle": "Screen Share Request",
  "confirmFullDeviceContent": "Do you want to share your full screen with the agent? The agent will not be able to control anything on the screen.",
  "allowText": "Allow",
  "denyText": "Deny"
}

API client headless

import { Client } from "@ujet/websdk-headless"

Événements

Pour obtenir la liste de tous les événements émis, consultez la page Événements.

Propriétés

Nom Description
deviceId ID de l'appareil, déterminé par le SDK sans interface graphique lors de l'initialisation.
lang Configuration linguistique actuelle du client. Si "lang" est transmis dans la configuration, il devient en lecture seule.
chat N'a de valeur que lorsqu'un chat est en cours.
cobrowse Le client CobrowseIO sous-jacent, disponible après l'initialisation de la co-navigation

Événements

Pour obtenir la liste de tous les événements émis, consultez la page Tous les événements disponibles.

Nom Description
destroy Détruit le communicateur et tous les écouteurs d'événements.
on Ajoute un gestionnaire d'événements pour l'événement fourni.
off Supprime le gestionnaire d'événements pour l'événement fourni.

Utilisez la méthode .destroy pour supprimer l'iframe et tous les écouteurs d'événements :

client.destroy()

Utilisez la méthode .on pour suivre les événements :

client.on('chat.updated', someFunc)

Supprimez le gestionnaire d'événements avec .off :

client.off('chat.updated', someFunc)

Implémentation de référence

Pour obtenir une implémentation de référence du SDK Web, consultez ccaas-web-headless-sdk-sample sur GitHub.

Ce dépôt contient une démonstration d'une application de chat créée à l'aide d'un SDK Web sans interface graphique de la plate-forme CCAI. Il présente une architecture client-serveur de base dans laquelle le backend Node.js gère l'authentification sécurisée et la diffusion de la configuration, tandis que l'interface JavaScript pure fournit l'interface utilisateur du chat.