ボットイベントは、ボットの会話中に特定のアクションが発生したとき、またはボットチャネルで特定のイベントが発生したときにトリガーされます。例えば、ユーザーが開始ボタンをクリックして、FB Messenger ボットとのチャットを開始すると、Facebookウェルカムイベントがトリガーされます。このイベントを使用して、ユーザーの名字および名前でのパーソナライズ、ユーザーからの追加情報の取得、バックエンドシステムの更新など、ウェルカムグリーティングのカスタマイズを行うことができます。

ボットの動作

開発者は、以下のオプションを使用して、イベントがトリガーされた際のボットの動作を定義することができます。

タスクを実行する

イベントが発生した際に呼び出されるダイアログタスク（標準または非表示）を選択します。イベントがトリガーされると、ダイアログの実行が開始されます。他のインテント検出によって一時停止された場合は、一時停止と再開の設定が有効になります。実行中に、選択済みのダイアログがボットで公開されていない場合、イベントは破棄されます。場合によっては、タスクが未公開、一時停止されている、あるいは単にユーザーに割り当てられていないなどの様々な理由により、会話中にユーザーがダイアログを利用できない場合があります。このような場合、ボットは、そのタスクが現在実行できないというエラーメッセージを表示します。開発者は、デバッグモードでボットをテストすることにより、こうした事態を未然に防ぐことができます。デバッグコンソールは、タスクが利用できない理由など、エラーの詳細を示します。

スクリプトを実行する

イベントが発生した際に実行するJavaScriptを定義します。スクリプトは、セッション、コンテキストオブジェクト、ボット変数、ボット関数など、該当するすべてのコンポーネントを利用することができます。デバッグモードを使用してコードを修正することもできます。

メッセージを表示する

イベントが発生した際にユーザーに表示するシンプルなメッセージまたは詳細なメッセージを定義します。ボットプラットフォームで利用可能なすべてのメッセージフォーマット機能をサポートしており、チャネルの上書きオプションを使用した複数のメッセージにも対応しています。多言語ボットの動作：

• 言語固有のメッセージを定義することができます。
• 特定の言語のイベントからメッセージが削除された場合、ボットの他のすべての言語からも削除されます。
• ある言語でメッセージが追加されると、他のすべての言語で同じ内容のメッセージが追加されます。
• ある言語でメッセージの内容が変更された場合、その変更内容はその言語のみに適用されます。

メッセージのフォーマットやテンプレートについてはこちらをご確認ください。

イベントタイプ

以下のイベントが応答のトリガーとなるように設定することができます。

設定

ボットのイベントを設定するには、以下の手順に従います。

1. ボットのメインメニューで、自然言語 > デフォルトの会話からイベントハンドラを選択します。
2. イベントページで、イベントを1つ選択します。イベント設定ウィンドウがスライドして開きます。
3. これらのオプションのいずれかを選択して、選択したイベントが検出されたときの処理方法を定義します。
   • タスクを開始,
   • スクリプトを実行,
   • メッセージを表示.

   

設定

設定オプションでは、以下のことができます。

• 変数の名前空間の管理（バージョン8.0で導入）で、イベントハンドラで使用する変数の名前空間を関連付けます。このオプションは、ボットで変数の名前空間が有効になっている場合にのみ表示されます。詳細は、名前空間の管理をご確認ください。

その他の注意事項

タスク実行の失敗イベント

• このイベントは、v6.40リリース以降利用可能です。
• デフォルトでは、このイベントはメッセージを表示オプションで常に有効になっています。このイベントを無効にすることはできません
• このボットレベルの動作は、ダイアログタスクの設定からタスク固有の失敗イベントを定義することで、特定のタスクに対して上書きすることができます。方法はこちらを参照してください。

ウェルカムイベント

ユーザーは、簡単な挨拶から、直接的な意思表示やFAQの質問まで、様々な方法でボットとの会話を始めることができます。ユーザーの選択に応じて開発者がボットの応答をカスタマイズできるように、イベント設定としてタスクを開始またはメッセージを表示を選択した場合、ウェルカムイベントには追加のオプションが出現します。例えば、最初のユーザーの発話がボットのタスクにマッピングされている場合、ボットはイベントベースのタスクまたはユーザーインテントを最初に実行する必要がありますか？開発者は、ユーザーが挨拶、タスク、FAQなどでボットとの会話を始めたときのボットの優先順位を、以下のオプションから定義することができます。

会話の終了

注意：バージョン7.1で導入された会話の終了は、ボットがユーザにメッセージを送信したり、ユーザからメッセージを受信したりすることを想定されなくなった場合にトリガーされます。タスクの終了イベントに追加された、タスクを終了する理由を示す新しいフラグは、会話の終了の動作を決定するのに役立ちます。ボットKits、RTM、Webhookチャネルのクライアント側の実装では、このタスク完了フラグの理由をコンテキストで使用して、適切な動作を決定することができます。このイベントがトリガーされると、以下の詳細とともにコンテキストが更新されます。

• イベント発生の理由（下表参照）
• 終了したばかりのタスクの名前FAQの場合、タスク名に「FAQ」が設定されます。

IVR Impact このイベントを使用して、音声ベースのチャネルのコールをいつどのように終了させるかを定義することもできます。IVRの導入が強化され、「会話の終了」が完了したときにのみセッション/コールを閉じることができるようになりました。方法はこちらをご確認ください。

テレフォニーウェルカムイベント

注意：バージョン8.0で導入されたTwilio音声ウェルカムイベントに代わるものです。このイベントは、任意の音声チャネルからプラットフォームへの音声通話を受信した際にトリガーされます。このイベントは、初回だけでなく、ユーザーの通話がプラットフォームで受信されるたびに発生します。これには「ダイアログの実行」と「音声通話のプロパティ」の2つのオプションがあります。

• ダイアログの実行 – 与えられたドロップダウンリストからトリガーされるタスクを選択します。
• 音声通話のプロパティは以下のように設定することができます。
  • 「初期プロンプト」を少なくとも1つ定義します。
  • タイムアウトや一致なしのプロンプトを定義することができます。
  • 高度なコントロールで、タイムアウト、試行回数、バージインなどの設定を定義することができます。詳細はこちらをご確認ください。

Bot Events are triggered when specific actions occur during bot conversation or when specific events are triggered on bot channels.

For example, when a user clicks the Get Started button to initiate a chat with your FB Messenger bot, it triggers the Facebook Welcome event. You can use this event to customize the welcome greeting such as personalizing it with the user’s first and last names, capturing additional information from users, and updating back-end systems.

Bot Behavior

Developers can define bot behavior when an event is triggered using one of the following options:

Run a task

Select a Dialog task (Standard or Hidden ) to be invoked when the event triggers. Once the event is triggered, the dialog starts executing. If it is interrupted because of other intent detections, the Hold and Resume settings come into play. During execution, if the selected Dialog is not published in the bot, the event is discarded.

In some cases, the Dialog may not be available to the user during a conversation for various reasons such as the task is not yet published or suspended or simply not assigned to the user. In such cases, the bot throws an error message that the task is not currently available for execution. Developers can preempt such situations by testing the bot in Debug mode. Debug Console shows full details about the error, including the reason for the non-availability of the task.

Run a script

Define a JavaScript to run when the event triggers. The script can make use of all applicable components such as session, context objects, bot variables, and bot functions. You can also fix the code using the Debug mode.

Show a message

Define a simple or advanced message to the user when the event triggers. It supports all messaging formatting features available in the Bots Platform, including multiple messages with channel override options.

Multilingual bot behavior:

• You can define language-specific messages;
• If a message is deleted from an Event for a specific language then it will be removed from all other languages of the bot;
• If a message is added for a language then the message would be added in all other languages using the same content;
• If a message is modified in a language, then the modifications will be applied for that language alone.

Learn more about message formatting and templates.

Event Types

You can configure the following events to trigger responses:

Configuration

Follow these steps to configure a bot event:

1. On the bot Build tab of the top menu, select Intelligence > Event Handlers.
2. On the Events page, select one of the events. The Event Configuration window slides open.
3. Select one of these options to define how to proceed when the selected event is detected:
   • Initiate Task,
   • Run Script,
   • Show Message.

Settings

The settings option allows you to:

• Manage Variable Namespaces to associate the Variable Namespaces to be used with the Event Handler. This option will be visible only when the Variable Namespace is enabled for the bot. For more information, see Managing Namespace.

Additional Notes

Task Execution Failure Event

• This event is available from the v6.40 release.
• By default, this event is always enabled with the Show Message option. This event cannot be disabled.
• This bot-level behavior can be overridden for specific tasks by defining task-specific failure event from the dialog task settings. Refer here for how.

Welcome/onConnect Event

Users can initiate bot conversations in varied ways, from a simple greeting to directly expressing an intent or asking an FAQ. To facilitate a scope for the developer to customize the bot response based on the user choice, the Welcome event comes with additional options when you choose Initiate Task or Show Message as the event configurations. For example, if the first user utterance maps to a bot task, should the bot execute the event-based task or the user intent first?

Post ver9.0, you can use the isReturningUser parameter in the BotUserSession context object to identify returning users and sending an appropriate welcome message (refer here for context object).

As a developer, you can define the bot priority when the user starts the bot conversation with a greeting, task, or FAQ from the options listed below:

End of Conversation

End of Conversation is triggered when the bot is not expected to send any message to the user or receive any message from the user.

A new flag indicating the reason for ending the task, added to the end of task event, will help in deciding the end of the conversation behavior. Client-side implementations of BotKits, RTM, and Webhook channels can use this reason for task completion flag in the context, to determine an appropriate course of action.

On triggering this event, the context will be updated with the following details:

• Reason for triggering event (see the table below)
• Name of the task that has just ended. If its a FAQ then the task name will be given set to ‘FAQ’

IVR Impact

You may also use this event to define how and when the calls should be terminated for voice-based channels. The IVR implementation has been enhanced to enable the closure of the session/call only when the ‘end of conversation’ is completed. See here for how.

Telephony Welcome Event

This event is triggered upon receiving the voice call to the platform from any voice channel. This event will be triggered every time a user’s call reaches the platform, and not just for the first time.

It has two options – ‘Run a Dialog’ and ‘Voice Call Properties’.

• Run a Dialog – Select a task to be triggered from the drop-down list provided
• Voice Call Properties can be set as follows:
  • Define at least one ‘Initial Prompts’
  • Prompts for Timeout, and No Match can be defined
  • Under Advanced Controls, settings for Timeout, No. of Retries, and Barge-in can be defined.
    See here for details.