WebChat V2のJavascript API仕様

概要

WebChat V2のJSファイルがロードされると、 ObotAIChatBot オブジェクトにJavaScriptでアクセスできるようになります。 ObotAIChatBot の trigger メソッドを使うことで、外部からチャットボットを操作できます。

API

基本的には ObotAIChatBot.trigger("{API名}", {引数})　のフォーマットでAPIを利用します。戻り値は Promise になり、 .then() を用いたチェイン処理も可能です。

チャットボットウインドウの操作

トグル版ボットでのみ動作可能

window-open

チャットボットのウインドウを開く

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("window-open")

window-close

チャットボットのウインドウを閉じる

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("window-close")

チャットボットトグルボタンの操作

トグル版ボットかつトグルボタンが設定で自動生成された場合のみ動作する

popover-update

トグルボタンのポップオーバーの内容を変更

• 引数：Object(null不可)

  • パラメーターは以下からのいずれ

  • [string]text: 表示される文章

  • [array]texts: 表示される文章（複数行）

• resolve値：なし

ObotAIChatBot.trigger("popover-update", { text: "test content" })

ObotAIChatBot.trigger("popover-update", { texts: ["test", "content"] })

popover-update-default

トグルボタンのポップオーバーの内容を初期値に戻す

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("popover-update-default")

チャットボットタイトルの操作

title-update

チャットボットタイトルの内容を変更

• 引数：Object(null不可)

  • パラメーターは以下からのいずれ

  • [string]text: 表示される文章

  • [array]texts: 表示される文章（複数行）

• resolve値：なし

ObotAIChatBot.trigger("title-update", { text: "test content" })

ObotAIChatBot.trigger("title-update", { texts: ["test", "content"] })

title-update-default

チャットボットタイトルの内容を初期値に戻す

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("title-update-default")

チャットボットメニューの操作

menu-open

メニューボックスを開く

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("menu-open")

menu-close

メニューボックスを閉じる

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("menu-close")

menu-update

チャットボットメニューの内容を変更

• 引数：Object（null可）

  • フォーマット： { "{言語コード}": [{メニュー項目}], ... }

  • 言語コード：　ja, en, zh-cn, zh-tw, ko, th, ru から任意、未設定の言語は空になる

  • メニュー項目: Object

    • パラメーターは以下両方必須

    • [string]sendingText: サーバーに送信されるテキスト

    • [string]btnText: ボタン表示されるテキスト

• resolve値：なし

ObotAIChatBot.trigger("menu-update", {
  ja: [{ sendingText: "テスト", btnText: "テキスト" }],
  "zh-cn": [{ sendingText: "测试", btnText: "测试" }]
})

menu-update-default

チャットボットメニューの内容を初期値に戻す

• 引数：なし

• resolve値：なし

ObotAIChatBot.trigger("menu-update-default")

送信

message-send

• 引数：Object(null不可)

  • パラメーターは以下からのいずれ

  • [string]text: 送信するメッセージ

  • [object]event: 送信するイベント

    • [string]name: イベント名。必須

    • [object]data: イベントに付属するデータ。データは任意に設定可能。設定しないことも可

• resolve値：なし

ObotAIChatBot.trigger("message-send", { text: "テスト" })
ObotAIChatBot.trigger("message-send", { event: { name: "SAMPLE_EVENT" } })