API Javascript - Méthodes

L'API Assistant JS expose les méthodes suivantes à l'objet global : Assistant. Vous pouvez les utiliser pour contrôler votre Assistant de manière programmatique.

Assistant('init', assistantId)

Appelez cette méthode pour charger l'Assistant

Assistant('init', 'YOUR_ASSISTANT_ID_HERE');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('init', 'YOUR_ASSISTANT_ID_HERE')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('trigger-less-init', assistantId)

Si vous souhaitez initialiser l'assistant sans lanceur ou bouton de déclenchement, utilisez ceci.

Assistant('trigger-less-init', 'YOUR_ASSISTANT_ID_HERE');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('trigger-less-init', 'YOUR_ASSISTANT_ID_HERE')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('triggerLess')

Appelez cette méthode pour masquer/désactiver le bouton de déclenchement/lanceur pour l'Assistant. Vous voudrez peut-être utiliser cette fonctionnalité si vous essayez de déclencher l'assistant de manière programmatique et que vous ne souhaitez pas afficher le bouton de lancement en bas.

Assistant('triggerLess');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('triggerLess')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('open')

Utilisez cette méthode pour ouvrir manuellement l'Assistant

Assistant('open');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('open')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('close')

Utilisez cette méthode pour fermer manuellement l'Assistant

Assistant('close');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('close')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('toggle')

Utilisez cette méthode pour basculer manuellement l'Assistant

Assistant('toggle');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('toggle')"></a>

N.B Vous pouvez utiliser cela de la manière que vous souhaitez avec votre propre logique et tout.

Assistant('chat')

Utilisez cette méthode pour ouvrir manuellement le chat. Vous devez avoir l'option Chat activée dans votre panneau de paramètres. Sinon, cette commande ne fonctionnera pas.

Assistant('chat');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('chat')"></a>

N.B Vous pouvez utiliser cela de la manière que vous voulez avec votre propre logique et tout.

Assistant('contact')

Utilisez ces méthodes pour ouvrir manuellement le contact. Vous pouvez passer n'importe quel sujet et corps qui rempliront automatiquement le formulaire, qui pourra donc être modifié. Vous devez avoir l'option Contact activée dans votre panneau de paramètres. Sinon, cette commande ne fonctionnera pas.

Assistant('contact', {
    subject: 'Titre du problème',
    body: 'Détails du problème',
});

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('contact', {
    subject: 'Titre du problème',
    body: 'Détails du problème',
})"></a>

N.B Vous pouvez utiliser cela de la manière que vous voulez avec votre propre logique et tout.

Assistant('order-status')

Utilisez ces méthodes pour ouvrir manuellement le contact. Vous devez avoir l'option OrderStatus activée dans votre panneau de paramètres. Sinon, cette commande ne fonctionnera pas.

Assistant('order-status');

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('order-status')"></a>

N.B Vous pouvez utiliser cela de la manière que vous voulez avec votre propre logique et tout.

Assistant('identify', userObject)

Il dit à l'Assistant que nous connaissons le nom et l'adresse e-mail du visiteur. Nous utilisons leur nom et leur adresse e-mail pour pré-remplir et cacher les champs sur l'écran du Formulaire de Contact. Nous utilisons également leur nom et leur adresse e-mail pour éviter de poser certaines questions au début d'une conversation avec l'Assistant.

Assistant('identify', {
  name: 'Parvez Akhter',
  email: 'demo@email.com',
});

Exemple de cas d'utilisation :

<a href="#" onclick="Assistant('identify', {
  name: 'Parvez Akhter',
  email: 'demo@email.com',
})"></a>

N.B Vous pouvez utiliser cela de la manière que vous voulez avec votre propre logique et tout.

Assistant('article')

Il existe deux façons d'ouvrir un article de la base de connaissances en utilisant la méthode Assistant('article') sur votre site. Cette méthode vous permet d'afficher un article soit dans l'Assistant lui-même, soit dans une barre latérale, selon vos besoins.

Tout ce dont vous aurez besoin est l'ID de l'article, qui peut être trouvé dans Thrivedesk en naviguant vers la documentation, en ouvrant l'article dans l'éditeur et en copiant l'ID à partir de là.

Cette méthode article est utile lorsque :

• Le déclencheur n'est pas une interaction directe de l'utilisateur avec l'Assistant.

• Vous souhaitez afficher un article automatiquement en utilisant votre logique personnalisée.

Exemples

Ouvrir un article dans l'Assistant :

Assistant('article', 'ARTICLE_ID');

ou

<a href="javascript:void(0)" onclick="Assistant('article', 'ARTICLE_ID')"></a>

Ouvrir un article dans la barre latérale :

Assistant('article', {
  articleId: 'ARTICLE_ID',
  mode: 'sidebar'
});

ou

<a href="javascript:void(0)" onclick="Assistant('article', {
    articleId: 'ARTICLE_ID',
    mode: 'sidebar'
    })" ></a>

Utilisation de la démo

• Utilisez Assistant('article') pour afficher un article directement dans l'Assistant.

• Ajoutez l'option mode: 'sidebar' pour afficher l'article dans une barre latérale à la place.

Assistant.clearSession()

Efface la session de l'Assistant et réinitialise l'assistant à un état frais. Cette méthode supprime tout l'historique des discussions, les messages et le contexte de conversation de la session actuelle.

Assistant.clearSession()

Utiliser

Si vous avez besoin d'un état frais de l'assistant à chaque déconnexion ou pour tout besoin personnalisé, vous pouvez appeler cette méthode en même temps que votre appel de déconnexion, et cela effacera l'état, offrant une expérience de chat en direct fraîche.

Exemple

function handleLogout() {
  // Effacer l'état de l'assistant
  Assistant.clearSession();
  
  // Poursuivre avec votre logique de déconnexion
  logoutUser();
}

Assistant('ready')

Enregistre une fonction de rappel à exécuter lorsque le widget Assistant est complètement initialisé et prêt à être utilisé.

Assistant('ready', callback: () => void)

Paramètres :

• callback (fonction) — Une fonction à exécuter lorsque l'Assistant est prêt

Utiliser

Utilisez cette méthode lorsque vous devez effectuer des actions uniquement après que l'Assistant a complètement chargé. Cela garantit que l'Assistant est disponible avant d'essayer d'interagir avec lui (par exemple, ouvrir le widget de chat, identifier les utilisateurs, etc.).

// Attendre que l'Assistant soit prêt, puis ouvrir le chat
Assistant('ready', () => {
  console.log(' L'Assistant est prêt, ouvrez le chat');
  Assistant('open');
});