Javascript API - メソッド

注意：あなたはこれを自分のロジックやすべての方法で使用できます。

アシスタント('contact')

この方法を使用して手動で連絡先を開きます。フォームを自動的に入力する任意の件名と本文を渡すことができ、編集可能です。設定パネルからContactオプションを有効にする必要があります。そうしないと、このコマンドは機能しません。

Assistant('contact', {
    subject: '問題のタイトル',
    body: '問題の詳細',
});

使用例：

<a href="#" onclick="Assistant('contact', {
    subject: '問題のタイトル',
    body: '問題の詳細',
})"></a>

注意：あなたはこれを自分のロジックやすべての方法で使用できます。

アシスタント('order-status')

この方法を使用して手動で連絡先を開きます。設定パネルからOrderStatusオプションを有効にする必要があります。そうしないと、このコマンドは機能しません。

Assistant('order-status');

使用例：

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

注意：あなたはこれを自分のロジックやすべての方法で使用できます。

アシスタント('identify', userObject)

訪問者の名前とメールアドレスを知っていることをアシスタントに伝えます。私たちは彼らの名前とメールアドレスを使用してContact Form画面のフィールドを事前に入力し、隠します。また、アシスタントチャットの開始時にいくつかの質問をスキップするために彼らの名前とメールアドレスを使用します。

Assistant('identify', {
  name: 'パルヴェズ・アクター',
  email: 'demo@email.com',
});

使用例：

<a href="#" onclick="Assistant('identify', {
  name: 'パルヴェズ・アクター',
  email: 'demo@email.com',
})"></a>

注意：あなたはこれを自分のロジックやすべての方法で使用できます。

アシスタント('article')

あなたのサイトでAssistant('article')メソッドを使用してナレッジベースの記事を開く方法は2つあります。このメソッドを使用すると、ニーズに応じてアシスタント自体内またはサイドバーに記事を表示できます。

必要なのは、記事のIDだけで、これはThrivedeskでドキュメントに移動し、エディタで記事を開き、そこからIDをコピーすることで見つけることができます。

このarticleメソッドは、次の場合に便利です：

• トリガーがアシスタントとの直接的なユーザーインタラクションではない場合。

• カスタムロジックを使用して記事を自動的に表示したい場合。

例

アシスタントで記事を開く：

Assistant('article', 'ARTICLE_ID');

または

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

サイドバーで記事を開く：

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

または

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

デモ使用法

• Assistant('article')を使用して、アシスタント内に直接記事を表示します。

• mode: 'sidebar'オプションを追加して、代わりにサイドバーに記事を表示します。

Assistant.clearSession()

アシスタントセッションをクリアし、アシスタントを新しい状態にリセットします。このメソッドは、現在のセッションからすべてのチャット履歴、メッセージ、および会話のコンテキストを削除します。

Assistant.clearSession()

使用法

毎回ログアウト時やカスタムニーズに応じてアシスタントの新しい状態が必要な場合は、このメソッドをログアウト呼び出しと一緒に呼び出すことができ、状態をクリアし、新しいライブチャット体験を提供します。

例

function handleLogout() {
  // アシスタントの状態をクリア
  Assistant.clearSession();
  
  // ログアウトロジックを続行
  logoutUser();
}

Assistant('ready')

アシスタントウィジェットが完全に初期化され、使用可能になったときに実行されるコールバック関数を登録します。

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

パラメータ:

• callback (function) — アシスタントが準備完了のときに実行する関数

使用法

アシスタントが完全に読み込まれた後にのみアクションを実行する必要がある場合は、このメソッドを使用します。これにより、チャットウィジェットを開いたり、ユーザーを特定したりする前にアシスタントが利用可能であることが保証されます。

// アシスタントが準備完了になるのを待ってからチャットを開く
Assistant('ready', () => {
  console.log(' アシスタントが準備完了、チャットを開く');
  Assistant('open');
});