Module: bot-express

bot-express module. This module should be mounted on webhook URI and requires configuration as options parameter.
Parameters:
Name Type Description
options Object Configuration of bot-express.
Properties
Name Type Attributes Default Description
language Object <optional>
"ja" ISO-639-1 based language code which is the mother language of this chatbot.
messenger Object Messenger configuration. line, facebook and google are supported.
Properties
Name Type Attributes Description
line Object | Array.<Object> <optional>
Messenger configuration for LINE. You can support multiple channel by providing array of this object.
Properties
Name Type Attributes Default Description
channel_id String <optional>
Channel ID of Messaging API. Required when you use LINE as messenger.
channel_secret String <optional>
Channel Secret of Messaging API. Required when you use LINE as messenger.
switcher_secret String <optional>
Switcher Secret of Messaging API. Required when you use Switcher API.
endpoint String <optional>
"api.line.me" Test purpose onlyl. Change Messaging API endpoint hostname.
facebook Object <optional>
Messenger configuration of facebook.
Properties
Name Type Attributes Default Description
app_secret String <optional>
Facebook App Secret. Required when you use Facebook Messenger.
page_access_token Array.<Object> <optional>
Array of a pair of Facebook Page Id and Page Access Token. Required when you use Facebook Messenger.
Properties
Name Type Attributes Description
page_id String <optional>
Facebook Page Id.
page_access_token String <optional>
Facebook Page Access Token.
verify_token String <optional>
options.facebook_app_secret Facebook token to verify webook url. This is only used in initial webhook registration.
google Object <optional>
Messenger configuration for Google Assistant.
Properties
Name Type Attributes Description
project_id String <optional>
Project ID of Google Platform. Required when you use Google Assistant as messenger.
nlu String Option object for NLU Service.
Properties
Name Type Attributes Default Description
type String <optional>
"dialogflow" NLU service. Supported service is dialogflow.
options Object NLU Configuration depending on the specific NLU service. As for Dialogflow, key_filename or (project_id, client_email and private key) is required.
parser Array.<Object> <optional>
Array of option object for Parser Service.
Properties
Name Type Attributes Description
type String <optional>
Name of the builtin parser. Supported value is "dialogflow".
options Object <optional>
Option object for the builtin parser.
memory Object <optional>
Option object for memory to store context.
Properties
Name Type Attributes Default Description
type String <optional>
"memory-cache" Store type of context. Supported store type is memory-cache and redis.
retention Number <optional>
"600" Lifetime of the context in seconds.
options Object <optional>
Options depending on the specific store type.
logger Object <optional>
Option object for logger.
Properties
Name Type Attributes Description
type String <optional>
Logger type. Supported logger is located under logger directory.
exclude Array.<String> <optional>
List to disable logging. Supported values are "skill-status" and "chat".
options String <optional>
Options depending on the specific logger.
skill Object <optional>
Options to set skill corresponding to certain event.
Properties
Name Type Attributes Description
default String <optional>
Skill name to be used when we cannot identify the intent. Default is builtin echo-back skill which simply reply text response from NLP.
beacon Object <optional>
Skill to be used when bot receives beacon event.
Properties
Name Type Attributes Description
enter String <optional>
Skill to be used when bot receives beacon enter event.
leave String <optional>
Skill to be used when bot receives beacon leave event.
follow String <optional>
Skill to be used when bot receives follow event.
unfollow String <optional>
Skill to be used when bot receives unfollow event.
join String <optional>
Skill to be used when bot receives join event.
leave String <optional>
Skill to be used when bot receives leave event.
default_intent String <optional>
"input.unknown" Intent name to be returned by NLP when it cannot identify the intent.
modify_previous_parameter_intent String <optional>
Intent name to modify the previously collected parameter.
skill_path String <optional>
"./skill/" Path to the directory which contains skill scripts.
message_path String <optional>
"./message/" Path to the directory which contains message scripts.
parallel_event String <optional>
"ignore" Flag to decide the behavior in receiving parallel event. If set to "ignore", bot ignores the event during processing the event from same user. Supported value are "ignore" and "allow".
translator Object <optional>
Option object for translator.
Properties
Name Type Attributes Default Description
label_path String <optional>
"./translation/label.js" Path to prepared translation label file.
type String <optional>
"google" Type of external translator.
enable_lang_detection Boolean <optional>
true Flag to enable language detection using external translator.
enable_translation Boolean <optional>
false Flag to enable translation using external translator. The translation is used to detect intent.
options Object <optional>
Option for the specified translator.
Source: