How To

JavaScript でチャットの起動と閉じるを制御する

こちらでは Javascriptで制御できるチャットの起動及び閉じる動作のオプションについて解説します。

open(options)

チャットを開きます。オプションを指定することで、シナリオの選択やフォームの事前入力などが可能です。

オプション

オプション説明
scenario_keystring開始するシナリオを指定
formsobjectフォームの初期値を{ フォームキー: 値 }の形式で指定
profile_uuidstring別プロファイルのスキーマを動的に読み込む
settingsobject設定値を一時的に上書きする
build_versionstringスキーマのバージョンを指定する
resetbooleanチャットの状態を初期化してから開く

利用例

// お客様情報を事前入力してチャットを開く
window.chat.open({
  forms: {
    name1: '山田',
    name2: '太郎',
    kana1: 'ヤマダ',
    kana2: 'タロウ',
    email: 'yamada@example.com',
    tel01: '09012345678',
    zip01: '1500001',
    prefecture_id: '13',
    addr01: '渋谷区神宮前',
    addr02: 'サンプルマンション101'
  }
})
// 特定のシナリオ(商品選択画面)から開始する
window.chat.open({
  scenario_key: 'product_select',
  forms: { product_quantity: '2' }
})
// 別プロファイルのスキーマを読み込んで開く
window.chat.open({
  profile_uuid: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
})
// チャットの状態をリセットしてから開く
window.chat.open({ reset: true })

close(options)

チャットを閉じます。オプション指定することでチャット閉じた後でも CV カウントなどが可能になります。

オプション

オプションデフォルト説明
confirmbooleanfalsetrueにすると確認ダイアログを表示してから閉じる
embed_cv_codesbooleanfalsetrueにすると閉じる前にCVコードを埋め込む

利用例

// チャットを閉じる(確認ダイアログなし)
window.chat.close()
// 確認ダイアログを表示して閉じる
window.chat.close({ confirm: true })
// CVコードを埋め込んでから閉じる
window.chat.close({ embed_cv_codes: true })

この記事の目次

このセクションの記事

How To