Cette page explique comment passer de la version 2 à la version 3 du SDK Web. Si vous installez le SDK Web pour la première fois, consultez le Guide du SDK Web v3.
Fonctionnalités du SDK Web v3
Voici quelques fonctionnalités du SDK Web v3 qui n'existent pas dans le SDK Web v2 :
Formulaires personnalisés : les agents peuvent envoyer des formulaires de collecte de données personnalisés directement dans l'interface de chat Web. Pour en savoir plus, consultez la section Formulaires de collecte de données.
Transcriptions téléchargeables : permettez aux utilisateurs finaux de télécharger leurs transcriptions de chat directement depuis le widget. Pour en savoir plus, consultez la section Télécharger les transcriptions de chat à l’aide du SDK Web et des SDK mobiles.
Déclencheurs de chat proactifs avancés : utilisez des déclencheurs de chat proactifs avancés, par exemple en spécifiant la langue de la file d'attente ou en utilisant une logique ET/OU complexe pour les mots clés d'URL. Pour en savoir plus, consultez la section Déclencheurs proactifs du SDK Web.
Passer au SDK Web v3
Tout d'abord, recherchez ce script dans votre code source :
<script type="module" src="https://websdk.ujet.co/v2/loader.js"></script>
Remplacez-le ensuite par le code suivant :
<script type="module" src="https://{your_ccaas_host}/web-sdk/v3/widget.js"></script>
Différences notables
Le SDK Web v3 est directement basé sur le client sans interface utilisateur UJET. Étant donné que l'interface utilisateur du widget utilise cette structure sans interface utilisateur, vous pouvez accéder à toutes les méthodes sous-jacentes et les appeler, et écouter les événements compatibles avec le SDK sans interface utilisateur en ciblant ccaas.client.
Cette section décrit les principales différences entre les versions 2 et 3 du SDK Web.
Initialiser
v2
const ccas = new UJET({
"companyId": "{companyId}",
"host": "https://{your_ccaas_host}",
"authenticate": getAuthToken
})
v3
var ccas = new UJET({
"companyId": "{companyId}",
"host": "https://{your_ccaas_host}",
"authenticate": getAuthToken
})
// v3 has a mount point
// ccaas.mount(HTMLElement | string)
ccaas.mount('#ccaas-widget')
Options
Lorsque vous lancez le SDK Web, vous spécifiez des options. Cette section décrit les différences entre les versions 2 et 3 du SDK Web.
v2
N/A pour la version 2.
v3
Dans la version 3, les options d'initialisation sont les mêmes que celles du SDK sans interface utilisateur.
interface ClientOption {
companyId: string;
authenticate: () => Promise<TokenResponse>;
tenant?: string;
host?: string;
lang?: string;
bridge?: string;
cobrowse?: {
enabled: boolean;
template?: string;
messages?: CobrowseMessages;
api?: string;
license?: string;
trustedOrigins?: string[];
capabilities?: string[];
registration?: boolean;
redactedViews?: string[];
unredactedViews?: string[];
};
}
Des options supplémentaires peuvent être configurées avec la méthode ccaas.config() :
ccaas.config({
disableAttachment: true
})
Options de configuration disponibles :
interface ConfigOptions {
accent?: AccentColor;
logo?: string;
menuKey?: string;
ticketId?: string;
preferredChannel?: string;
disableAttachment?: boolean;
customData?: string | Record<string, any>;
messages?: Record<string, unknown>;
reCaptchaSiteKey?: string;
}
Méthodes
Dans la version 2, le chargeur comporte quelques méthodes supplémentaires, telles que :
ccaas.createCobrowseCode()
ccaas.fetchWaitTimes({id: 123})
Dans la version 3, l'interface utilisateur du widget utilise un client sans interface utilisateur. Vous pouvez appeler toutes les méthodes compatibles avec le SDK sans interface utilisateur.
const client = ccaas.client
client.getCompany()
client.loadOngoingChat()
Pour en savoir plus, consultez le Guide du SDK Web sans interface utilisateur.
Événements
Dans la version 2, vous pouvez écouter des événements avec :
ccaas.on('chat:update', (chat) => {
console.log(chat)
})
Dans la version 3, vous pouvez écouter des événements avec le client sans interface utilisateur :
const client = ccaas.client
client.on('chat.updated', (chat) => {
console.log(chat)
})
Pour en savoir plus sur les événements, consultez le Guide du SDK Web sans interface utilisateur.
Personnalisation du thème
Le SDK Web v3 propose une approche mise à jour de la personnalisation du thème. Pour en savoir plus, consultez la section Personnalisation du thème.